Bank Payouts Report

Last updated: January 22, 2025

The Bank Payouts Report lists all pending, successful, rejected, and declined bank payouts during a selected period. It includes:

The names, identifiers, and countries of the payout sender (if not your entity) and recipient
The payout date, identifier, type, any identifying references, and the amount and currency
The payout recipient's account details
Information about any payout funds the recipient's bank returned to you

The report is provided as a CSV file. By default, the file name uses the following format:

{Start date:YYYYMMDD}-{End date:YYYYMMDD}-Bank Payouts Report-{Entity name}.csv

The report data is refreshed approximately every two hours.

See instructions on how to download the report on demand or on a schedule:

Download a sample report (CSV file).

Information

If using Safari, hold down the Option key when selecting the link to download the file.

The report includes all of the following fields in this order:

Field name	Description
Action ID string	The unique identifier for the bank payout. Example – `act_abcdef1ghijklmn23opq45r6st`
Action Date UTC datetime	The date and time when you performed the bank payout in UTC. Format – ISO 8601 Example – `2024-01-31T10:20:30.456`
Client Name string	Your name as a Checkout.com client.
Entity Name string	The name of your Checkout.com entity.
Entity ID string	The unique identifier for your Checkout.com entity. Example – `ent_abcdef1ghijklmn23opq45r6st`
Sub Entity ID string	The unique identifier for your Checkout.com sub-entity. Example – `ent_abcdef1ghijklmn23opq45r6st`
Sub Entity Name string	The name of your Checkout.com sub-entity.
Payout Date datetime	The date and time when you sent the payout, in UTC. Format – ISO 8601 Example – `2024-01-31T10:20:30.456`
Value Date datetime	The date and time when the funds were settled with the recipient, in UTC. Format – ISO 8601 Example – `2024-01-31T10:20:30.456`
Payment ID decimal	The unique identifier for the payout payment. Example – `pay_abcdef1ghijklmn23opq45r6st`
Action Type string	The payout status. This can be one of: `PayoutCreated` – You've created the payout. `PayoutConfirmed` – The payout is settled with the recipient. `PayoutRejected` – The payout was rejected. `PayoutReturned` – The recipient's bank returned the funds.
Recipient Reference string	The recipient's reference for the payout.
Sender Reference string	The sender's reference for the payout.
Destination Amount decimal	The amount of the payout in the recipient's account. Format – Fixed-point notation with up to eight decimal places Example – 500 USD is represented as `500.00` More information – Calculating the amount
Destination Currency string	The currency of the payout in the recipient's account. Format – ISO 4217 code
Source Amount decimal	The amount of the payout in the sender's account. Format – Fixed-point notation with up to eight decimal places Example – Write 500 USD as `500.00`. More information – Calculating the amount
Source Currency string	The currency of the payout in the sender's account. Format – ISO 4217 code
Originator Country string	The country the payout was sent from. Format – ISO alpha-2 country code
Destination Country string	The country the payout was sent to. Format – ISO alpha-2 country code
Recipient Name string	The name of the recipient.
Account Number / IBAN string	The recipient's account number or international bank account number (IBAN). For more information about the format in different countries, see Payout formatting.
Bank Code / SWIFT string	The unique identifier for the recipient's bank. For more information about the format in different countries, see Payout formatting.
Billing Descriptor string	The billing descriptor you provided with the payout, which is displayed on the recipient's bank statement if supported by their bank.
Return Amount decimal	The amount the recipient's bank returned to you due to an error, in the major currency unit. Format – Fixed-point notation with up to eight decimal places Example – Write 500 USD as `500.00`. More information – Calculating the amount
Return Currency string	The currency of the amount the recipient's bank returned to you. Format – ISO 4217 code
Return Reason string	The API response code for the payout return. Example – `50499`

Bank Payouts Report

Report format

Report availability

Sample report

Information

Report fields