You're viewing documentation for our latest API. This will not impact your integration, but you will need the documentation relevant to you. If you have an account with Checkout.com you have received an email confirming which version to use.
With a Full account, you have complete access to Checkout.com's payouts capabilities. For example, you can pay out to a sub-entity bank account. For us to support you with this, you need to securely store the card details information, using a payment instrument.
Before making scheduled payouts to a sub-entity, you need to connect bank details to their account, so we know where to send the funds. If the sub-entity holds funds in multiple currencies, you must provide corresponding bank details for each currency. These details are saved securely in our vault, and you are given a unique reference to use in payout requests instead of typing out the bank details every time. We call this a payment instrument.
When a sub-entity is created, a Checkout.com currency account is automatically associated with that sub-entity. In case multiple currencies are held by the sub-entity, separate accounts will be created for each currency. When you request a payment on behalf of your sub-entity, those funds are routed to the corresponding currency account based on the payment routing rules.
Using our payouts solution, those funds are then paid out to the external bank account of the sub-entity by using the secure payment instrument.
There are different requirements for the request, depending on the currency of the bank account. Currently, you can only send money from the UK, European Economic Area (EEA), or US. However, you can perform a payout to any UK, EEA, or US bank account.
The following table outlines the minimum required fields when creating a payment instrument. To get a detailed view of all required and optional fields, see our API reference.
You can create a payment instrument for each of the currencies your sub-entity holds funds in.
A short description of what the instrument is for.
This refers to the type of instrument. Set this to bank_account.
This is the three-letter ISO currency code of the account's currency. At the moment, this would be GBP or EUR.
The ID of the file representing the uploaded document.
Use the following table to review additional required fields, depending on the currency.
Where are you sending the money to?
The account holder's account number.
The account holder's sort code.
Internationally agreed standard for identifying bank account.
8- or 11-character code that identified the bank or bank branch.
The account holder's account number.
The account holder’s routing number or ABA routing number.
We need to verify any bank details you provide us. To verify bank details, include a document object with a file_id in your request. You receive a file_id when you upload a bank statement using our Files API.
To create a payment instrument, make a call to the following endpoints. To get a detailed view of all required and optional fields, see our API reference.
The response's instrument_id value is a unique reference to your instrument's details, which you can use to identify it when using our other APIs. The payment instrument's details are not returned in the response.
"label":"Bob's Bank Account",
You can associate an existing payment instrument with a payout schedule. This will make it the destination instrument when a scheduled payout is made.
The first payment instrument added for a specific currency will be automatically associated to the payouts schedule for that currency. Any subsequent payment instruments added will need to be associated explicitly, in order to be used as a destination when a payout is made.
To update the payment instrument for a schedule, use the following end point: