Guides
API Reference

Our reference library for integrating with our API

FAQ

Find answers to our most frequently asked questions

Classic Docs

Documentation for our Classic API

Sender data for Card Payouts

If you're sending a card payout on behalf of another person (a money transfer), or a business/government entity (a third-party funds disbursement), you must include the details of that person or entity in the processing.senderInformation object in your payout request. You can see example payout requests with sender data on our Card Payouts page.

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

If you don't provide sender data when it's required, your transaction will be declined.

For more details about sender data requirements, please contact your implementation manager.

Visa 

Sender data for Visa money transfers 

Fund transfer type = AA, PP, FT

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

Field nameUK/EU domesticCross-borderNotes

reference

STRING

REQUIRED (if accountNumber not available)

REQUIRED (if accountNumber not available)

The merchant's unique customer ID.

Up to 16 alphanumeric characters.

accountNumber

STRING

REQUIRED (if available)

REQUIRED (if available)

Up to 19 characters.

firstName

STRING

REQUIRED

REQUIRED

The full name must be provided. This information will show on the cardholder's statement.

Up to 15 characters.

lastName

STRING

REQUIRED

REQUIRED

The full name must be provided. This information will show on the cardholder's statement.

Up to 15 characters.

address

STRING

REQUIRED

REQUIRED

Required under UK law.

Up to 35 characters.

city

STRING

REQUIRED

REQUIRED

Up to 25 characters.

state

STRING

n/a

REQUIRED

Up to 3 characters.

country

STRING

REQUIRED

REQUIRED (if applicable)

Up to 2 characters.

sourceOfFunds

STRING

RECOMMENDED

RECOMMENDED

Possible values:

  • Credit
  • Debit
  • Prepaid
  • DepositAccount
  • MobileMoneyAccount
  • Cash

Sender data for Visa third-party funds disbursements 

Fund transfer type = FD

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

Field nameUK/EU domesticCross-borderNotes

reference

STRING

REQUIRED

REQUIRED

The merchant's unique customer ID.

Up to 16 alphanumeric characters.

accountNumber

STRING

OPTIONAL

OPTIONAL

Up to 19 characters.

firstName

STRING

REQUIRED

REQUIRED

Merchant or government entity name. This information will show on the cardholder's statement.

Up to 15 characters.

lastName

STRING

REQUIRED

REQUIRED

Merchant or government entity name. This information will show on the cardholder's statement.

Up to 15 characters.

address

STRING

REQUIRED

REQUIRED

Required under UK law.

Up to 35 characters.

city

STRING

RECOMMENDED

REQUIRED

Up to 25 characters.

state

STRING

n/a

REQUIRED (if applicable)

Up to 3 characters.

country

STRING

REQUIRED

REQUIRED

Up to 2 characters.

sourceOfFunds

STRING

RECOMMENDED

RECOMMENDED

Possible values:

  • Credit
  • Debit
  • Prepaid
  • DepositAccount
  • MobileMoneyAccount
  • Cash



Non-Visa products

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

Mastercard 

Sender data for Mastercard money transfers

Fund transfer type = AA, PP, FT

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

Field nameUK/EU domesticCross-borderNotes

firstName

STRING

REQUIRED

REQUIRED

Legal first name of sender. Do not use processor or intermediary name. This information will show on the cardholder's statement.

Up to 15 characters. Alphanumeric characters only; no spaces.

lastName

STRING

REQUIRED

REQUIRED

Legal last name of sender. Do not use processor or intermediary name. This information will show on the cardholder's statement.

Up to 15 characters. Alphanumeric characters only; no spaces.

address

STRING

REQUIRED

REQUIRED

Up to 35 characters.

city

STRING

REQUIRED

REQUIRED

Up to 25 characters.

state

STRING

OPTIONAL

OPTIONAL

Up to 3 characters.

country

STRING

REQUIRED

REQUIRED

Two-letter ISO country code.

Up to 2 characters.

postalCode

STRING

REQUIRED

REQUIRED

Up to 10 characters.

accountNumber

STRING

REQUIRED (if reference not available)

REQUIRED (if reference not available)

Up to 19 characters.

reference

STRING

REQUIRED (if accountNumber not available)

REQUIRED (if accountNumber not available)

Up to 16 alphanumeric characters.

sourceOfFunds

STRING

REQUIRED

REQUIRED

Possible values:

  • Credit
  • Debit
  • Prepaid
  • DepositAccount
  • MobileMoneyAccount
  • Cash

Sender data for Mastercard third-party funds disbursements

Fund transfer type = FD

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

Field nameUK/EU domesticCross-borderNotes

firstName

STRING

REQUIRED

REQUIRED

Legal first name of sender. Do not use processor or intermediary name. This information will show on the cardholder's statement.

Up to 15 characters. Alphanumeric characters only; no spaces.

lastName

STRING

REQUIRED

REQUIRED

Legal last name of sender. Do not use processor or intermediary name. This information will show on the cardholder's statement.

Up to 15 characters. Alphanumeric characters only; no spaces.

address

STRING

REQUIRED

REQUIRED

Up to 35 characters.

city

STRING

REQUIRED

REQUIRED

Up to 25 characters.

state

STRING

OPTIONAL

OPTIONAL

Up to 3 characters.

country

STRING

REQUIRED

REQUIRED

Two-letter ISO country code.

Up to 2 characters.

postalCode

STRING

REQUIRED

REQUIRED

Up to 10 characters.

accountNumber

STRING

REQUIRED (if reference not available)

REQUIRED (if reference not available)

Up to 19 characters.

reference

STRING

REQUIRED (if accountNumber not available)

REQUIRED (if accountNumber not available)

Up to 16 alphanumeric characters.

sourceOfFunds

STRING

REQUIRED

REQUIRED

Possible values:

  • Credit
  • Debit
  • Prepaid
  • DepositAccount
  • MobileMoneyAccount
  • Cash