Request a card payout
Beta
Last updated: April 29, 2022
You can use card payouts to perform different types of fund transfers in the United Kingdom (UK), European Economic Area (EEA), and Singapore:
You can request the card payout using a token or a payment instrument.
If you are PCI compliant (SAQ-D) you can also request a card payout using full card details. Contact your Customer Success Manager to enable this option.
Before you attempt a card payout, we recommend you verify the card's eligibility and check your currency account balance to ensure you have sufficient funds to perform the payout.
Only cards that have been enabled for Visa Direct or Mastercard MoneySend by the issuing bank are eligible to receive a card payout.
Requesting a payout to an ineligible card will result in a 422 Invalid data sent
error response.
You can retrieve a card's metadata to check whether it's eligible for Visa Direct or Mastercard MoneySend before you perform a card payout.
The API response will also inform you whether the issuing bank has enabled Fast Funds for the card. With Fast Funds, payouts are made available to the recipient within 30 minutes. If Fast Funds is not enabled, funds may take up to 48 hours to be made available.
To perform a card payout, you'll need to have sufficient funds in your balance to fund the transaction.
You can check your account balance with the API.
get
https://balances.checkout.com/balances/{id}?withCurrencyAccountId=true
1{2"data": [3{4"currency_account_id": "ca_ux6najg5mnqexjs2jezz6gwseu",5"descriptor": "Revenue Account 1",6"holding_currency": "EUR",7"balances": {8"pending": 10,9"available": 50,10"payable": 0,11"collateral": 012}13}14]15}
If you have sufficient funds, you can continue with the card payout.
If you're performing a card payout on behalf of a business or government entity, you must include the entity's details within the sender
object in your request.
You must also specify the amount to be paid out.
- To perform a payout in the recipient's currency, use the
amount
field - To perform a payout in the currency that you hold with Checkout.com, use the
source.amount
field instead
Format the amount
or source.amount
value according to the currency you use.
post
https://api.checkout.com/payments
1{2"source": {3"type": "currency_account",4"id": "ca_j3pndu5dzhcurnrs5x3vuyqr4q",5"amount": null6},7"destination": {8"type": "id",9"id": "",10"account_holder": {11"type": "individual",12"first_name": "John",13"last_name": "Smith"14}15},16"amount": 50,17"currency": "GBP",18"sender": {19"type": "individual",20"first_name": "Jane",21"last_name": "Doe",22"address": {23"address_line1": "123 High St.",24"city": "London",25"zip": "SW1A 1AA",26"country": "GB"27},28"reference": "012345",29"reference_type": "other",30"source_of_funds": "debit"31},32"reference": "Money Transfer UK",33"instruction": {34"funds_transfer_type": "PP"35},36"processing_channel_id": "pc_fdfkfkvxuufexozs5nbvptqr74"37}
1{2"id": "pay_g7rpbnxfqyreraewiqvltp33ha",3"status": "Accepted",4"reference": "Money Transfer UK",5"destination": {6"account_holder": {7"id": "src_nwd3m4in3hkuddfpjsaevunhdy"8}9},10"_links": {11"self": {12"href": "https://api.sandbox.checkout.com/payments/pay_g7rpbnxfqyreraewiqvltp33ha"13}14}15}
In your card payout request, you must specify the amount to be paid out.
- To perform a payout in the recipient's currency, use the
amount
field - To perform a payout in the currency that you hold with Checkout.com, use the
source.amount
field instead
Format the amount
or source.amount
value according to the currency you use.
post
https://api.checkout.com/payments
1{2"source": {3"type": "currency_account",4"id": "ca_y3aed6h4txweddznt2llxrprcu",5"amount": null6},7"destination": {8"type": "id",9"id": "src_324w2drfvlfutajjcfe4ofcbge",10"account_holder": {11"type": "individual",12"first_name": "John",13"last_name": "Smith"14}15},16"amount": 100,17"currency": "GBP",18"reference": "Direct Funds Disbursement UK",19"instruction": {20"funds_transfer_type": "FD"21},22"processing_channel_id": "pc_twbkelxnialexpqreoh5lmay2u"23}
1{2"id": "pay_g7rpbnxfqyreraewiqvltp33ha",3"status": "Accepted",4"reference": "Direct Funds Disbursement UK",5"destination": {6"account_holder": {7"id": "src_nwd3m4in3hkuddfpjsaevunhdy"8}9},10"_links": {11"self": {12"href": "https://api.sandbox.checkout.com/payments/pay_pay_g7rpbnxfqyreraewiqvltp33ha"13}14}15}
If you've enabled webhook notifications, you'll receive a webhook notifying you of the payout status after you perform the request.
If the card payout was successful, you'll receive a payment_approved
webhook, with "response_code": "10000"
and "response_summary": "Approved"
fields.
If the card payout was unsuccessful, you'll receive a payment_declined
webhook. The response_code
you receive depends on the reason for the unsuccessful payout, which is described in the response_summary
field.