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 Account 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": 0
12      }
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 following in your request:

the sender object, which should contain the entity's details
the amount to be paid out, with the value formatted according to the currency you specify in the request

post

https://api.checkout.com/payments


1{
2  "source": {
3    "type": "currency_account",
4    "id": "ca_j3pndu5dzhcurnrs5x3vuyqr4q"
5  },
6  "destination": {
7    "type": "id",
8    "id": "",
9    "account_holder": {
10      "type": "individual",
11      "first_name": "John",
12      "last_name": "Smith"
13    }
14  },
15  "amount": 50,
16  "currency": "GBP",
17  "sender": {
18    "type": "individual",
19    "first_name": "Jane",
20    "last_name": "Smith",
21    "address": {
22      "address_line1": "123 High St.",
23      "city": "London",
24      "zip": "SW1A 1AA",
25      "country": "GB"
26    },
27    "reference": "012345",
28    "reference_type": "other",
29    "source_of_funds": "debit"
30  },
31  "reference": "Money Transfer UK",
32  "instruction": {
33    "funds_transfer_type": "PP"
34  },
35  "processing_channel_id": "pc_fdfkfkvxuufexozs5nbvptqr74"
36}


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}


1{
2  "source": {
3    "type": "currency_account",
4    "id": "ca_swkii7nbad4ubn6yrnx73brg4i"
5  },
6  "destination": {
7    "type": "card",
8    "number": "5336071921232174",
9    "expiry_month": 2,
10    "expiry_year": 2025,
11    "account_holder": {
12      "type": "individual",
13      "first_name": "John",
14      "last_name": "Smith"
15    }
16  },
17  "sender": {
18    "type": "individual",
19    "first_name": "Jane",
20    "last_name": "Smith",
21    "address": {
22      "address_line1": "123 Example St.",
23      "city": "Singapore",
24      "zip": "123456",
25      "country": "SG"
26    },
27    "reference": "1234567ABCDEFG",
28    "reference_type": "other",
29    "source_of_funds": "debit"
30  },
31  "amount": 100,
32  "currency": "SGD",
33  "reference": "Money Transfer Singapore",
34  "instruction": {
35    "funds_transfer_type": "C07"
36  },
37  "processing_channel_id": "pc_q2wz2hiuvsau5pd5vquccdjtw4"
38}


1{
2  "id": "pay_g7rpbnxfqyreraewiqvltp33ha",
3  "status": "Accepted",
4  "reference": "Money Transfer Singapore",
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. Format the 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  },
6  "destination": {
7    "type": "id",
8    "id": "src_324w2drfvlfutajjcfe4ofcbge",
9    "account_holder": {
10      "type": "individual",
11      "first_name": "John",
12      "last_name": "Smith"
13    }
14  },
15  "amount": 100,
16  "currency": "GBP",
17  "reference": "Direct Funds Disbursement UK",
18  "instruction": {
19    "funds_transfer_type": "FD"
20  },
21  "processing_channel_id": "pc_twbkelxnialexpqreoh5lmay2u"
22}


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}


1{
2  "source": {
3    "type": "currency_account",
4    "id": "ca_yf5lb6vzjcfevdbv4cd5kw3qwq"
5  },
6  "destination": {
7    "type": "card",
8    "number": "4695519217985838",
9    "expiry_month": 1,
10    "expiry_year": 2026,
11    "account_holder": {
12      "type": "individual",
13      "first_name": "John",
14      "last_name": "Smith",
15      "billing_address": {
16        "country": "SG"
17      }
18    }
19  },
20  "amount": 100,
21  "currency": "SGD",
22  "reference": "Direct Funds Disbursement Singapore",
23  "metadata": {
24    "test_level": "e2e - Singapore"
25  },
26  "sender": {
27    "type": "individual",
28    "first_name": "John",
29    "last_name": "Smith",
30    "address": {
31      "address_line1": "123 Example St.",
32      "city": "Singapore",
33      "zip": "123456",
34      "country": "SG"
35    },
36    "reference": "1234567ABCDEFG",
37    "reference_type": "other",
38    "source_of_funds": "debit"
39  },
40  "instruction": {
41    "funds_transfer_type": "FT"
42  },
43  "processing_channel_id": "pc_jwnib7klzsrehlxj3aulxu3cye"
44}


1{
2  "id": "pay_g7rpbnxfqyreraewiqvltp33ha",
3  "status": "Accepted",
4  "reference": "Direct Funds Disbursement Singapore",
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.

We've made some changes to our API

Request a card payout
Beta

Verify card eligibility

Check currency account balance

Response example

Perform a money transfer

Request example

Response example

Response example

Perform a direct funds disbursement

Request example

Response example

Response example

Check the status of a card payout