Transaction Management APIs

requestId

string

Required  

The GUID that enables the application to link request with response

amount

integer

Required  

The amount to be transferred, in cents. For example, 10001 = $100.01.

cardToken

string

Required  

A randomly generated string of characters that relates to the consumer's payment card (15-38 alphanumeric characters).

The response attribute this matches depends on the payment instrument:

Card. Matches the creditCardToken in the Add a card response.

Wallet. Matches the payAliasToken in the Add a payAlias response.

sourceSenderId

string

Required  

Money transfers must contain the sender's identifier. This ID identifies the sender of the funds.

For a funds disbursement, non-money transfers must contain either the name of the merchant or the entity sending the disbursement.

sourceSenderName

string

Required  

The name of the merchant. This attribute (alphanumeric) identifies the sender of the funds. Note: Money transfers must contain the sender's name.

sourceAddress

object

Optional 

Use this field to append online transaction data to the statement descriptor, for example to use a sub-merchant address instead of the merchant address

child attributes

sourceCity string Optional

sourceCountryCode string Optional

sourceState string Optional

correspondingEntity

object

Conditional 

The name and address details of the sender of a push transaction or receiver of a pull transaction.

child attributes

firstName string Required   The first name of the sender of a push transaction or receiver of a pull transaction. Maximum 35 characters.

lastName string Required   The last name of the sender of a push transaction or receiver of a pull transaction. Maximum 35 characters.

accountNumber string Required   The account number of the sender or receiver in a transaction. From 13 to 19 alphanumeric characters. Note Contains the destination account number being funded by a cross-border AFT (for instance, IBAN, wallet, PAN, or acquirer's proprietary account).

address object Required   The address of the sender of a push transaction or receiver of a pull transaction child attributes addressLine1 string Required   Street address of transaction sender or receiver. Maximum 99 characters. city string Required   City of transaction sender or receiver. Maximum 25 characters. state string Conditional  2-letter code of the state of transaction sender or receiver Note This attribute is required if RecipientCountryCode is either 124 (CAN) or 840 (USA). Not applicable to domestic transactions in Columbia. countryCode string Required   2-letter code of the country of transaction sender or receiver zipCode string Required   5-digit US postal code ("ZIP Code") of transaction sender or receiver

sourceMcc

string

Optional 

Merchant Category Code (MCC). 4-digits that a credit card issuer uses to categorize consumer transactions for their card.

purposeOfPayment

string

Optional 

A 1-12 character code that indicates the reason for a transaction. This code is required for certain markets (countries).

transactionRequestId

string

Unique customer generated transaction request

amount

integer

The amount to be transferred, in cents. For example, 10001 = $100.01.

transactionRequestedAt

string

Date and time of the request (GMT)

transactionStatus

enum

Transaction status:

• Succeeded

• Pending

• Failed

• Rejected

errorDescription

string

A description of the error, if relevant

creditCardId

string

Card token of the signed-up debit card

railId

string

The payment processor used to perform the transaction:

• McSend

• TabaPay

• Visa Direct

network

string

Name of the payment card network:

1. MoneySend

2. NYCE

3. Pulse

4. STAR

5. Visa

retrievalReferenceId

string

The number Cross River creates that is passed to the rail to assist in tracing a transaction after it left our system

actualTransactionDoneAt

date-time

The date and time the transaction was sent to the payment processor

requestApproved

boolean

True if a request was approved, otherwise false

responseReceived

boolean

True if a response was received, otherwise false

responseCode

string

A 2-digit code signifying the transaction result (approved or decline). For example, 00 means successful.

responseDescription

string

A string describing the transaction result. For example, Approved.

traceNumber

string

A unique number assigned to a transaction from the time it leaves the merchant bank until it arrives at the cardholder bank

error

string

A description of the error, if relevant

sourceSenderName

string

Merchant name

requesterId

string

Required  

The merchant partner unique identifier. 32 hexadecimal characters.

requesterName

string

Required  

The name of the merchant

requesterMcc

string

Required  

Merchant Category Code (MCC). 4-digits that a credit card issuer uses to categorize consumer transactions for their card.

cvv

string

Optional 

Personal customer code on the card. Note: Add the CVV to a function call only when you add a card (POST /api/Card). The API never returns CVV when you perform a GET or PUT call.

threeDomainSecureEci

integer

Not yet in use.

threeDomainSecureUcaf

string

Not yet in use.

threeDomainSecureXid

string

Not yet in use.

requestId

string

Required  

The GUID that enables the application to link request with response

cardToken

string

Required  

A randomly generated string of characters that relates to the consumer's payment card (15-38 alphanumeric characters). Matches the creditCardToken in the response.

amount

integer

Required  

The amount to be transferred, in cents. For example, 10001 = $100.01.

sourceAddress

object

Optional 

Use this field to append online transaction data to the statement descriptor, for example to use a sub-merchant address instead of the merchant address

child attributes

sourceCity string Optional

sourceCountryCode string Optional

sourceState string Optional

correspondingEntity

object

Conditional 

The name and address details of the sender of a push transaction or receiver of a pull transaction.

child attributes

firstName string Required   The first name of the sender of a push transaction or receiver of a pull transaction. Maximum 35 characters.

lastName string Required   The last name of the sender of a push transaction or receiver of a pull transaction. Maximum 35 characters.

accountNumber string Required   The account number of the sender or receiver in a transaction. From 13 to 19 alphanumeric characters. Note Contains the destination account number being funded by a cross-border AFT (for instance, IBAN, wallet, PAN, or acquirer's proprietary account).

address object Optional  The address of the sender of a push transaction or receiver of a pull transaction child attributes addressLine1 string Required   Street address of transaction sender or receiver. Maximum 99 characters. city string Required   City of transaction sender or receiver. Maximum 25 characters. state string Conditional  2-letter code of the state of transaction sender or receiver Note This attribute is required if RecipientCountryCode is either 124 (CAN) or 840 (USA). Not applicable to domestic transactions in Columbia. countryCode string Required   2-letter code of the country of transaction sender or receiver zipCode string Required   5-digit US postal code ("ZIP Code") of transaction sender or receiver

programId

integer

Optional 

Populate this attribute when you want to connect a transaction to a given sub-merchant network program ID (Visa: MVV, Mastercard: MCID).

Otherwise, your merchant-level program ID is added automatically. You don't need to enter it.

transactionRequestId

string

Unique customer generated transaction request

amount

integer

The amount to be transferred, in cents. For example, 10001 = $100.01.

If the consumer is enabled for partial authorization, this field will present the actual amount approved by the card issuer (that was pulled from the cardholder account).

originalAmount

integer

This attribute appears in a partially authorized AFT transaction.

The original transaction amount (amount value in the AFT request), represented in the transaction currency (senderCurrencyCode value in AFT request).

If partial authorization is not enabled, the value be the requested and approved transaction amount.

transactionRequestedAt

string

Date and time of the request (GMT)

transactionStatus

enum

Transaction status:

• Succeeded

• Pending

• Failed

• Rejected

errorDescription

string

A description of the error, if relevant

creditCardId

string

Card token of the signed-up debit card

railId

string

The payment processor used to perform the transaction:

• McSend

• TabaPay

• Visa Direct

network

string

Name of the payment card network:

1. MoneySend

2. NYCE

3. Pulse

4. STAR

5. Visa

retrievalReferenceId

string

The number Cross River creates that is passed to the rail to assist in tracing a transaction after it left our system

actualTransactionDoneAt

date-time

The date and time the transaction was sent to the payment processor

requestApproved

boolean

True if a request was approved, otherwise false

responseReceived

boolean

True if a response was received, otherwise false

responseCode

string

A 2-digit code signifying the transaction result (approved or decline). For example, 00 means successful.

responseDescription

string

A string describing the transaction result. For example, Approved.

traceNumber

string

A unique number assigned to a transaction from the time it leaves the merchant bank until it arrives at the cardholder bank

error

string

A description of the error, if relevant

requesterName

string

Merchant name

cardToken

string

Optional 

A randomly generated string of characters that relates to the consumer's payment card (15-38 alphanumeric characters). Matches the creditCardToken in the response.

statusEnum

string

Optional 

Transaction status:

• Succeeded

• Pending

• Failed

• Rejected

sourceSenderId

string

Optional 

The GUID that identifies the merchant partner

fromDate

date-time

Optional 

Report start date.

cardToken

string

Optional 

A randomly generated string of characters that relates to the consumer's payment card (15-38 alphanumeric characters). Matches the creditCardToken in the response.

statusEnum

string

Optional 

Transaction status:

• Succeeded

• Pending

• Failed

• Rejected

fromDate

date-time

Optional 

Date from which transactions were added (for beginning of a date range query). Format: YYYY-MM-DDThh:mm:ss.<UTC offset>Z), for instance 2022-12-19T18:51:21.22Z

transactionId

string

Required  

A unique string (32 hexadecimal characters) that identifies the transaction in a definite way. The payment card network passes this identifier, without changing it, throughout the whole interbank chain.

cardToken

string

Required  

A randomly generated string of characters that relates to the consumer's payment card (15-38 alphanumeric characters). Matches the creditCardToken in the response.

transactionId

string

Required  

A unique string (32 hexadecimal characters) that identifies the transaction in a definite way. The payment card network passes this identifier, without changing it, throughout the whole interbank chain.