Skip to main content
POST
Enrich a transfer transaction

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, recurrence flagging, and category personalization purposes.

Maximum string length: 512
Example:

"user_id_123456789"

transactionType
string
required

The type of this transaction. By default, the accepted types include ACH_DEPOSIT, ACH_RETURN, ACH_WITHDRAWAL, ATM, CHECK_DEPOSIT, CHECK_PAYMENT, INTERNATIONAL_WIRE_INCOMING, INTERNATIONAL_WIRE_OUTGOING, RTP_DEPOSIT, RTP_WITHDRAWAL, US_WIRE_INCOMING, US_WIRE_OUTGOING, OTHER_INCOMING, and OTHER_OUTGOING; however, this endpoint also supports a variety of other transfer types, depending on your use case and the data you have available. Please contact your Spade representative if you would like further information about supported transaction types.

Maximum string length: 32
Examples:

"ACH_DEPOSIT"

"ACH_RETURN"

"ACH_WITHDRAWAL"

"ATM"

"CHECK_DEPOSIT"

"CHECK_PAYMENT"

"INTERNATIONAL_WIRE_INCOMING"

"INTERNATIONAL_WIRE_OUTGOING"

"RTP_DEPOSIT"

"RTP_WITHDRAWAL"

"US_WIRE_INCOMING"

"US_WIRE_OUTGOING"

"OTHER_INCOMING"

"OTHER_OUTGOING"

description
string
required

The full transaction description. Typically, this will be a string containing the name of the merchant or institution involved in the transaction plus information related to the type of transaction such as "ACCT VERIFY", "WEB PMT", "ETRANSFER", etc...

Maximum string length: 1024
Example:

"AMAZON CORP SYF PAYMNT"

amount
required

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

Example:

"283.78"

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"

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 information, see Supporting multiple data sources and clients

Maximum string length: 256
Example:

"organization_id_123"

accountId
string

Anonymous ID representing the account of the user (NOT the account number).

Maximum string length: 512
Example:

"account_id_123456789"

transactionId
string

Your ID representing this transaction

Maximum string length: 512
Example:

"transaction_id_123456789"

transactionTypeDescription
string

A description of the transactionType. This field is intended for systems in which the transactionType is a numeric code. In these cases, transactionTypeDescription should be the human-readable description of the transactionType.

Maximum string length: 64
Examples:

"ACH Withdrawal"

"ACH Deposit"

alternateDescription
string

An alternate transaction description, if available. This will often be a string containing the name of the merchant or institution involved in the transaction. Note that this field is optional and may or may not be available in your system. Please contact your Spade representative if you have any questions about field mappings.

Maximum string length: 1024
Example:

"AMAZON CORP"

memo
string

The transaction memo, if your system contains an additional field beyond the description and alternateDescription fields. Note that this field is optional and may or may not be available in your system. Please contact your Spade representative if you have any questions about field mappings.

Maximum string length: 1024
Example:

"100 PUBLIC SQUARE CLEVELAND OH"

direction
enum<string>

The direction of the transaction. Will take precedence over the direction inferred from the amount field.

Available options:
CREDIT,
DEBIT
Maximum string length: 8
Examples:

"CREDIT"

"DEBIT"

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:

Response

Successful operation

transactionInfo
object
counterparty
object[]

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

enrichmentId
string<uuid>

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

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: