Skip to main content
POST
Enrich a card transaction with an unparsed de43

Authorizations

X-Api-Key
string
header
required

Body

application/json
userId
string
required

Anonymous ID representing your user. This will be used for summary features, and recurrence flagging purposes.

Maximum string length: 512
Example:

"user_id_123456789"

amount
required

Value of the transaction in the given currency. Negative values indicate incoming money.

Example:

"25.23"

currencyCode
string
required
Maximum string length: 16
Example:

"USD"

occurredAt
string<date-time>
required

The time the transaction occurred. Formatted as an ISO 8601 date time.

Example:

"2022-06-15 18:27:51Z"

categoryCode
string
required

Category code for the given categoryType

Maximum string length: 32
Example:

"5812"

location
object
required
merchantName
string

The raw, unmodified merchant name (including asterisks, store numbers, etc...)

Maximum string length: 1024
Example:

"Amazon"

organizationId
string

An ID representing the organization associated with this transaction. Use this field if you are enriching transactions on behalf of other organizations. Used for billing purposes and for scoping products such as action triggers and category personalizations at the organization-level. For more info, see Supporting multiple data sources and clients

Maximum string length: 256
Example:

"organization_id_123"

programId
string

An identifier for the program associated with this transaction. Programs can be used to group transactions and scope action triggers at the program level.

Maximum string length: 512
Example:

"program_id_123"

cardId
string

Anonymous ID representing the card of the user.

Maximum string length: 512
Example:

"card_id_123456789"

cardFirstSix
string

The first six digits of the card number associated with the transaction.

Required string length: 6
Example:

"123456"

cardLastFour
string

The last four digits of the card number associated with the transaction.

Required string length: 4
Example:

"7890"

transactionId
string

Your ID representing this transaction

Maximum string length: 512
Example:

"transaction_id_123456789"

acquirerId
string

An alphanumeric code generally with a maximum length of 15. It is also known as "Network ID", "Card Acceptor ID", or "Merchant ID". (Found in field 42 of ISO 8583)

Maximum string length: 256
Example:

"000000000123456"

categoryType
enum<string>
default:MCC

The category system that categoryCode is a part of. Optional; if omitted it defaults to MCC. Do not send null or an empty string — when the field is present it must be a valid, non-empty value (MCC).

Available options:
MCC
Required string length: 1 - 32
Example:

"MCC"

billingProfile
enum<string>

An optional billing profile for this transaction. When set to "resell", the organizationId field is required. For more information, see Supporting multiple data sources and clients

Available options:
standard,
resell
Example:

"standard"

customAttributes
object

A dictionary containing custom attributes that you would like to be returned in the response. Please ensure this object does not contain any PII. Restrictions include: customAttributes must be an object, up 30 custom attributes are allowed, each key must be a string <= 40 characters in length, and each value must be a string <= 250 characters in length.

Example:
de43
string

A well formatted de43 message. If parsable the parsed data (merchantName, city, state) will take precedence over the corresponding fields in the request body. The parser expects an unedited de43, please do not remove special characters or spaces. Our parser currently only supports US transactions.

Maximum string length: 100
Example:

"WALMART.COM BENTONVILLE ARUS"

Response

Successful operation

transactionInfo
object
enrichmentId
string<uuid>

Our ID representing the enrichment, not to be confused with your provided transactionId.

counterparty
object[]

An array of counterparties matched to the transaction, ordered by descending match score.

mobileAppInfo
object | null

The mobile app information for the transaction. This object is only non-null if the transaction was matched to a mobile app.

customAttributes
object

A dictionary containing the custom attributes that were included in the enrichment request (if any).

Example:
actions
object[] | null

An array of triggered actions, or null if no triggers matched. This field is only present if your integration has the actions feature enabled.

When a transaction matches one or more registered triggers, this array contains the action details including your custom action data.

Example: