Documentation

Collect

Payments, refunds, payment reversals and chargebacks

Disburse

Payouts and payout reversals

Card Issuing

Issued card transactions

Issued Bank Account

Issued bank account deposits

Identity Verification

IDV requests

Wallet

Wallet to Wallet Transfer

Transaction Type

Will be set as one of the following for the corresponding transaction(s): payment refund Payment_reversal Chargeback Payouts payout reversals Issued card transactions Issued bank account deposits IDV requests Wallet to Wallet Transfer

string

Rapyd Transaction ID

ID of the transaction on the Rapyd platform. Use this as a reference when contacting our support team

string

Rapyd Reference ID

The unique token created when creating the transaction on the Rapyd platform.

Note: multiple transactions can share the same token in case payments are split between multiple wallets

string

Merchant Reference ID

The unique ID referencing the merchant used when creating the transaction on the Rapyd platform.

This is an optional field and is provided to assist in reconciliation efforts.

Note: multiple transactions can share the same reference ID in case payments are split between multiple wallets

string

Transaction Method Type

Name of the payment or payout method type used when creating the transaction

Issued Card: The type of hardware type used for deducting funds, i.e. 'vPOS', 'PPOS' or 'ATM'

Empty for virtual accounts or bank accounts

string

Country

The country where the funds of the transaction were collected from.

Payout and payout reversal: The country of the beneficiary (where the funds of the payout are sent to).

Issued bank account deposits: The country of the issued accounts.

Issued card transactions: The country where the transaction was processed (location of the POS/ATM)

IDV requests: Country of the IDV contact.

Empty for Wallet to Wallet Transfer.

2-Letter ISO 3166-2 country code

Presentment Currency

The currency of the transaction collected from debtor

Three-letter ISO 4217 code

Presentment Amount

The amount collected from the debtor, in presentment currency

Payouts: The currency of the funds being sent to the beneficiary

Virtual Accounts: The currency of the funds deposited into the issued bank account.

decimal

Note: amount rounded based on the minor unit defined in ISO 4217

Wallet Account Currency

The currency of the payment collected as credited to the wallet.

For payments created using the Payment with FX API call, this currency will be different from the Presentment Currency Currency

Three-letter ISO 4217 code

Wallet Amount

The amount collected from the debtor, credited to the wallet.

For payments created using the Payment with FX API call, this currency will be different from the Presentment Amount

decimal

Note: amount rounded based on the minor unit defined in ISO 4217

Destination Wallet Transaction Token

Transaction token on the of the transaction processed on the destination wallet (wt_xxxxx).

string

Destination Wallet

The wallet settlement funds are deducted from.

string

Transaction Exchange Rate with Markup

The exchange rate used when using the Payment with FX API call. The rate includes the markup charged by Rapyd (if applicable)

For payments collected without FX, the value will be set to 1. without FX, the value will be set to 1.

decimal

Transaction Exchange Rate without Markup

The base exchange rate used when using the Payment with FX API call. The rate does not include the markup charged by Rapyd (if applicable).

For payments collected without FX, the value will be set to 1.

For Issuing, the value is set to null.

decimal

Transaction Exchange Fee

The exchange fee charged when using the Payment with FX API call, in denominated in the Wallet Account Currency.

For payments collected without FX, the value will be set to 0.

decimal

Wallet Debit/Credit

Defines whether the transaction record resulted in a debit or credit action to the wallet account.

All 'payment' type transactions will perform a 'credit' action.

string

Fee Currency

The currency of the fees applied to the transaction, not including the transaction exchange fees charged for the Payment with FX.

Three-letter ISO 4217 code

Fee Exchange Rate

The rate applied when the fee currency is different than the presentment currency.

Fees are calculated from the presentment amount and currency.

decimal

Transaction Fee

The fee amount for processing the transaction, denominated in Fee Currency.

decimal

Fee in Wallet Currency

The fee amount for processing the transaction, denominated in the Wallet Account Currency.

decimal

Settlement Currency

The currency of the net amount of the transaction, to be settled.

Three-letter ISO 4217 code

Settlement Exchange Rate

The rate applied when the settlement currency is different than the fee and/or presentment currency.

The rate is used to convert from the fee currency to the settlement currency.

The rate includes the markup applied by Rapyd (if applicable).

decimal

Settlement Amount

The net amount of the transaction to be settled, denominated in Settlement Currency.

in case withholding tax is applied, this column should present the net settlement amount after withholding tax deduction.

decimal

Expected Settlement Date

The expected settlement date of the transaction.

date YYYY-MM-DD

Action Created At

The timestamp issued when the transaction was first created via the Rapyd API.

timestamp YYYY-MM-DD HH:mm:ss

Action Closed At

The timestamp issued when the transaction was confirmed and closed by the Rapyd system.

Split Payments: Valid for transaction type ‘payment’ only.

timestamp YYYY-MM-DD HH:mm:ss

Reserve Amount

The amount transferred to Reserve. The Reserve Amount is calculated based on payments only.

The Reserve Amount will be deducted on the billing date.

decimal

Reserve Currency

The Reserve account currency to which funds are transferred as part of the reserve process (when applicable).

Three-letter ISO 4217 code

Rapyd Transaction Group ID

The transaction group ID when group payments are used.

Multiple transactions may share the same Transaction Group ID.

string

Settlement Wallet

The ewallet token credited with the transaction, and from which the settlement is performed (if applicable).

string

Billing Wallet

The ewallet token where fees will be deducted from.

string

Wallet actual fee currency deducted

The currency type deducted from the wallet for the transaction. The transaction is listed by Billing ID.

Three-letter ISO 4217 code

Wallet actual fee amount deducted

The fee amount deducted from the wallet for the transaction. The transaction is listed by Billing ID.

decimal

Transaction wallet

The wallet where the transaction was created, listed by Wallet ID

string

Invoice ID

A shared invoice ID for all transactions billed across multiple Merchant Reconciliation Reports.

string

Card Brand

The brand of the card used, in case the transaction was created using a card payment method.

In all other cases, the value will be empty for Payments.

string

Card Type

The type of the card used, in case the transaction was created using a card payment method.

In all other cases, the value will be empty for Payments.

string

Platform Type

Type of card platform (e.g. Commercial, Consumer)

string

Transaction Regionality

The identified location of the transaction based on the match between the merchant and the card holder’s countries.

string

Issuing Country

The country where the card or bank account was issued.

Empty for other transaction types.

2-Letter ISO 3166-2 country code

Issued Card Token

value is empty for Payments

empty

Card Holder Name

The name of the card holder, in case the transaction was created using a card payment method.

In all other cases, the value will be empty for Payments.

string

Issued Bank Account Number

The number of the issued bank account, which funds were deposited into.

Value empty for other transaction types.

empty

Tax Amount

The amount of the tax for any payment collection transaction.

decimal

Tax Currency

The currency of the tax for any payment collection transaction.

Three-letter ISO 4217 code

Tax Amount in Fee Currency

The currency of the payment as refunded to the original debtor

decimal

Interchange Fee Amount

If interchange fee is applied due to the prediction model, it is stated here in Fee currency.

decimal

Scheme Fee Amount

If scheme fee is applied due to the prediction model, it is stated here in Fee currency.

decimal

Invoice Currency

The Invoice Currency as set within the price list

Three-letter ISO 4217 code

Transaction Exchange Fee in Invoice Currency

The Transaction Exchange Fees denominated in Invoice Currency.

decimal

Transaction Fees in Invoice Currency

The Transaction Fees denominated in Invoice Currency.

decimal

Sender Name

Name of the sender related to the Virtual IBAN

string

Sender Account Name

Account Name/Number of the sender related to the Virtual IBAN

string

Sender Remitter Reference

Virtual IBAN related sender remitter reference

string

Description

The reason why the transaction fee was manually adjusted.

string

Sender Sort Code

Number identifying the bank of the Virtual IBAN

string

Beneficiary Name

The name of the beneficiary.

string

Withholding Tax Rate

The withholding tax rate, as configured by Rapyd.

decimal

Gateway Reference ID (beta)

ID of the gateway on the Rapyd platform.

string

Settlement ID

ID of the settlement of the transaction.

string

Static Reference ID

Unique ID field added by the merchant for each wallet and bank account configuration.

Should be Alphanumeric. Min 3 characters, max 45 characters.

Once populated and saved can’t be changed.

string

Platform Fee - Count of Items

Values presented (per relevant transaction):

number

Platform Fee - Fee Per Item

Values presented (per relevant transaction):

decimal