Skip to main content
POST
Extract merchant

Authorizations

x-api-key
string
header
required

Body

application/json

The bank transaction description as a string

description
string
required
Example:

"PAYPAL* AMZN Mktp 198748320"

Response

200 - application/json

The merchant key is not null when we find a positive match to our database. When we could not match a merchant, merchant is null and description_clean is set to a substring of the original description that our models identified as the relevant entity.

description_clean
string | null
Example:

"Amzn Mktp"

merchant
object | null
payment_processor
object | null