Perform an Account Funding Transaction
Last updated: July 26, 2023
An Account Funding Transaction (AFT) is a transaction in which funds are pulled from an account and used to fund a non-merchant account. For example, to load a prepaid card, top up a wallet, or fund a person-to-person (P2P) money transfer.
The Unified Payments API can be used to perform an AFT for Visa or Mastercard.
Information
To start using this feature, please contact your Account Manager.
Use the details below to set up your request.
For the full API specification, see the API reference.
post
https://api.checkout.com/payments
The processing.aft
field indicates whether the payment request is an AFT, and is required for both Visa and Mastercard AFTs.
Field name | Description |
---|---|
| The first line of the recipient’s address |
| The second line of the recipient’s address |
| The recipient's city |
| The recipient's country |
| The recipient's state (only applicable for US addresses) |
| The recipient's zip code |
|
The recipient's account number can be any identifier — for example, an IBAN, internal account number, phone number, or part of the PAN (the first six digits and the last four digits) |
| The recipient's date of birth |
| The recipient's first name (if the recipient is an organization, this should be the organization name) |
| The recipient's last name (if the recipient is an organization, this field is not required) |
In Europe and the UK, first_name
, last_name
, and account_number
are mandatory for domestic European AFTs and intra-EEA/UK AFTs. This means the issuer, acquirer, and merchant are all located in the European Economic Area (EEA) or the UK.
In the US, the first_name
, last_name
, and address
fields are mandatory for domestic AFTs.
For domestic AFTs in other jurisdictions, these fields are optional.
For cross-border AFTs, first_name
, last_name
, and account_number
are mandatory.
The first_name
, last_name
, account_number
, and address.country
fields are mandatory globally.
Field name | Description |
---|---|
| The first line of the sender's address |
| The second line of the sender's address |
| The sender's city |
| The sender's country |
| The sender's state (only applicable for US addresses) |
| The sender's zip code |
| The sender's date of birth |
| The sender's first name |
| The two-digit ISO 3166 country code of the country that issued the identification |
| The identification number |
| The type of identification used to identify the sender (for example, a passport or driving license) |
| The sender's last name |
| The merchant's unique customer ID |
| The type of sender (for example, an individual) |
In Europe and the UK, the first_name
, last_name
, and address
fields are mandatory for intra-EEA/UK AFTs. This means the issuer, acquirer, and merchant are all located in the European Economic Area (EEA) or the UK.
In the US, first_name
, last_name
, and address
are mandatory for domestic AFTs.
For domestic AFTs in other jurisdictions, these fields are optional.
For cross-border AFTs, first_name
, last_name
, and address
are mandatory.
All fields are optional in the supported jurisdictions.
1{2"source": {3"type": "token",4"token": "tok_4gzeau5o2uqubbk6fufs3m7p54"5},6"amount": 6500,7"currency": "GBP",8"processing": {9"aft": true10},11"recipient": {12"first_name": "John",13"last_name": "Smith",14"account_number": "5555554444",15"address": {16"country": "GB"17}18},19"sender": {20"type": "individual",21"reference": "87654321",22"first_name": "Jane",23"last_name": "Smith",24"address": {25"address_line1": "123 High St.",26"city": "London",27"country": "GB"28}29}30}
Use the approved
field to check whether or not the authorization was successful ("approved": true
). If your authorization was not successful, it's possible the payment used an invalid/expired card, or a valid card with an insufficient available balance.
If you received a 202
response, the payment requires a redirect. For example, if the payment is 3D Secure.
Information
The following pages can help you understand the response message:
- CVV codes and descriptions
- AVS codes
- API response codes (if the authorization was unsuccessful)
The possible values for the status field include Authorized
, Captured
, Card Verified
, Declined
, and Pending
. Note that Pending
only applies to 3D Secure payments.
1{2"id": "pay_mbabizu24mvu3mela5njyhpit4",3"action_id": "act_mbabizu24mvu3mela5njyhpit4",4"amount": 6500,5"currency": "GBP",6"approved": true,7"status": "Authorized",8"auth_code": "770687",9"eci": "05",10"scheme_id": "638284745624527",11"response_code": "10000",12"response_summary": "Approved",13"risk": {14"flagged": false15},16"source": {17"id": "src_nwd3m4in3hkuddfpjsaevunhdy",18"type": "card",19"expiry_month": 9,20"expiry_year": 2022,21"scheme": "Visa",22"last4": "4242",23"fingerprint": "F31828E2BDABAE63EB694903825CDD36041CC6ED461440B81415895855502832",24"bin": "424242",25"card_type": "CREDIT",26"card_category": "CONSUMER",27"issuer": "Test Bank",28"issuer_country": "GB",29"product_id": "A",30"product_type": "Visa Traditional",31"avs_check": "S",32"cvv_check": ""33},34"customer": {35"id": "cus_udst2tfldj6upmye2reztkmm4i"36},37"processing": {38"acquirer_transaction_id": "708183248720806995996",39"retrieval_reference_number": "471056794828",40"merchant_category_code": "0742",41"scheme_merchant_id": "502177",42"aft": true43},44"processed_on": "2019-01-25T11:03:36Z",45"reference": "ORD-5023-4E89",46"_links": {47"self": {48"href": "https://api.sandbox.checkout.com/payments/pay_mbabizu24mvu3mela5njyhpit4"49},50"actions": {51"href": "https://api.sandbox.checkout.com/payments/pay_mbabizu24mvu3mela5njyhpit4/actions"52},53"capture": {54"href": "https://api.sandbox.checkout.com/payments/pay_mbabizu24mvu3mela5njyhpit4/captures"55},56"void": {57"href": "https://api.sandbox.checkout.com/payments/pay_mbabizu24mvu3mela5njyhpit4/voids"58}59}60}
Information
Possibly fraudulent authorization requests return the message risk.flagged: true
to show that the payment has been flagged.