Sender data for payouts

Sender data must be provided for all Pay to Card transactions where you are sending transactions on behalf of another person or business.

The data you'll need to provide depends on the card scheme:

• Visa
• Mastercard

Visa

Visa definitions

Visa defines the sender as a customer of the merchant or service provider (consumer or business) with a need to push payments.

Sender data corresponds to the account number, reference number, full name, address, city, state/province, country, and source of funds. The data required varies according to the type of payment you're making:

• money transfer
• funds disbursement

Sender data for Visa money transfers

BAI = AA, BI, PP, WT

The following table outlines the fields which should be included in the processing.senderInformation object.

Sender data for Visa funds disbursements

BAI = BP, FD, GD, GP, LO, MD, OG, PD

The following table outlines the fields which should be included in the processing.senderInformation object.

BAI = CP, TU

The following table outlines the fields which should be included in the processing.senderInformation object.

🚧

Non-Visa products
Merchants are responsible for identifying the source of funds for non-Visa products and correctly populating the sourceOfFunds field.

Mastercard

Mastercard definitions

Mastercard defines the sender as a consumer, business, government entity, or non-profit that initiates a funds transfer by utilizing a MoneySend Payment Transaction. The sender always refers to the ultimate originator of the transaction.

The MoneySend Payment Transaction message must include accurate and meaningful sender-related data. It can include the following: unique transaction reference number, name, address, account number, source of funds, phone number, date of birth, and message. See the table below for full details on each field's name and whether or not it is required.

Sender data for Mastercard

The following table outlines the fields which should be included in the processing.senderInformation object.

Including sender data in a payout

Use the details below to set up your request.

Endpoints

Live

POSThttps://api.checkout.com/payments

Sandbox

POSThttps://api.sandbox.checkout.com/payments

Header parameters

Body parameters

Request example

{
  "destination": {
    "type": "token",
    "token": "tok_4gzeau5o2uqubbk6fufs3m7p54",
    "first_name": "John",
    "last_name": "Smith",
  },
  "processing": {
    "senderInformation": {
      "firstName": "Jack",
      "lastName": "Brown",
      "address": "75 York Road, Apartment 3",
      "city": "LDN",
      "postalCode": "OX15DJ",
      "country": "GB",
      "sourceOfFunds": "DEBIT",
      "accountNumber": "4242424242424242",
      "reference": "12345678",
    },
  },
  "amount": 10,
  "currency": "GBP",
  "fund_transfer_type": "AA"
}

The response

Use the approved field to check whether or not the payout was successful ("approved": true).

{
  "id": "pay_wugo7nun52aetgpgnyzyzvghnu",
  "action_id": "act_o62zaizczakuxeorbkmyuapszm",
  "amount": 100,
  "currency": "USD",
  "approved": true,
  "status": "Paid",
  "auth_code": "332171",
  "response_code": "10000",
  "response_summary": "Approved",
  "destination": {
    "id": "src_nxc36gtdwjtuxfeg2vsy722m4e",
    "type": "card",
    "expiry_month": 10,
    "expiry_year": 2025,
    "scheme": "Visa",
    "last4": "4242",
    "fingerprint": "D3E048C1E888DD2903D37A8EB3BFAC60674754BEE23A3B1C4CF3B8D6D7FFD146",
    "bin": "424242",
    "card_type": "Credit",
    "card_category": "Consumer",
    "issuer": "JPMORGAN CHASE BANK NA",
    "issuer_country": "US",
    "product_id": "A",
    "product_type": "Visa Traditional",
  },
  "customer": {
    "id": "cus_ae6mdlqwa3ye7hyn2n3jyrvhqe",
  },
  "processed_on": "2019-05-30T16:05:19Z",
  "reference": "ORD-5023-4E89",
  "_links": {
    "self": {
      "href": "https://api.sandbox.checkout.com/payments/pay_wugo7nun52aetgpgnyzyzvghnu"
    },
  }
}

Can we help?

Thanks for using Checkout.com. If you need any help or support, then message our support team at [email protected].