On This Page

Payouts Developer Guide

This section describes how to use this guide and where to find further information.

Audience and Purpose

This document is written for developers who want to use the
Cybersource
 APIs to integrate
Cybersource
Payouts
 services into their transaction management system.

Conventions

This statement is used in this document:
IMPORTANT
An
Important
 statement contains information essential to successfully completing a task or learning a concept.

Related Documentation

Visit the
Cybersource
 documentation hub on the Cybersource Developer Center for links to further documentation resources.

Customer Support

For support information about any service, visit the Support Center:

Recent Revisions to This Document

25.05.01

This revision contains only editorial changes and no technical updates.

24.01

Initial release.

AFT Transactions

The Account Funding Transaction (AFT) allows the transfer of funds between a payment card and another account, including other payment cards. When used independently, an AFT can only transfer funds between accounts owned by the same person or business entity. An AFT is not intended for paying goods and services, funding a merchant account, or repaying debts.
IMPORTANT
You must receive approval from before using the AFT services. Contact to register in the AFT program.

Account Funding Transactions (AFTs) with Visa

Payouts
 uses the authorization service to support AFTs. An AFT withdraws funds from a sender’s account.
First Data Merchant Solutions
 does not support zero amount for
orderInformation.amountDetails.totalAmount
 field.
IMPORTANT
You must receive prior approval from
First Data Merchant Solutions
 before using the AFT services. Contact
First Data Merchant Solutions
 to register in the AFT program.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/payments
Test:
POST
https://apitest.cybersource.com
/pts/v2/payments

Required Fields for an AFT Request with Visa

These fields are required to process an AFT request:
First Data Merchant Solutions
 does not support zero amount.
These are the values:
  • AA
    : Account to account.
  • BI
    : Money transfer (bank-initiated).
  • FD
    : Funds disbursement, e.g. insurance payout.
  • PD
    : Payroll disbursement
  • FT
    : Funds transfer.
  • PP
    : Person to person.
  • TU
    : Top Up: Prepaid load.
  • WT
    : Wallet transfer.
Required with Visa when the
recipientInformation.country
 field value is one of these countries:
  • Australia
  • Bangladesh
  • Chile
  • Colombia
  • Egypt
  • India
These are the values:
  • ISACCT
    : Account management.
  • ISAIRB
    : Air transport related business.
  • ISALLW
    : Transaction is the payment of allowance.
  • ISANNI
    : Settlement of annuity.
  • ISBENE
    : Unemployment disability benefit.
  • ISBEXP
    : Business expenses.
  • ISBONU
    : Bonus payment.
  • ISBUSB
    : Bus transport related business.
  • ISCASH
    : Cash management transfer.
  • ISCBTV
    : Payment of cable TV bill.
  • ISCCHD
    : Government institute issued related to cash compensation, helplessness, disability.
  • ISCCRD
    : Credit card payment.
  • ISCDBL
    : Payment of credit card bill.
  • ISCHAR
    : Payment for charity reasons.
  • ISCOLL
    : Collection payment.
  • ISCOMC
    : Commercial payment.
  • ISCOMM
    : Commission.
  • ISCOMP
    : Compensation relating to interest loss/value date adjustment and can include fees.
  • ISCPYR
    : Payment of copyright.
  • ISDCRD
    : Related to a debit card payment.
  • ISDEPT
    : Payment of a deposit.
  • ISDIVD
    : Payment of dividend.
  • ISEDUC
    : Payment of study/tuition fees.
  • ISELEC
    : Payment of electricity bill.
  • ISENRG
    : Energies.
  • ISFEES
    : General fees.
  • ISFERB
    : Payment for ferry related business.
  • ISFREX
    : Foreign exchange.
  • ISGASB
    : Payment of gas bill.
  • ISGFRP
    : Compensation to unemployed persons during insolvency procedures.
  • ISGOVT
    : Government payment.
  • ISHLTI
    : Health insurance.
  • ISICCP
    : Reimbursement of credit card payment.
  • ISIDCP
    : Reimbursement of debit card payment.
  • ISINPC
    : Payment of car insurance premium.
  • ISINSC
    : Transaction is related to the payment of an insurance claim.
  • ISINSMI
    : Installment.
  • ISINSU
    : Insurance premium.
  • ISINVS
    : Payment of mutual funds, investment products and shares.
  • ISINTC
    : Intra company payment.
  • ISINTE
    : Interest.
  • ISINTX
    : Investment.
  • ISLBRI
    : Labor insurance.
  • ISLICF
    : License fee.
  • ISUIFI
    : Life insurance.
  • ISLOAN
    : Loan.
  • ISMDCS
    : Medical services.
  • ISMP2B
    : Mobile P2B payment.
  • ISMP2P
    : Mobile P2P payment.
  • ISMTUP
    : Mobile top up.
  • ISNOWS
    : Not otherwise specified.
  • ISOTHR
    : Other.
  • ISOTLC
    : Transaction is related to a payment of other telecom related bill.
  • ISPAYR
    : Payroll.
  • ISPEFC
    : Contribution to pension fund.
  • ISPENS
    : Pension payment.
  • ISPHON
    : Payment of telephone bill.
  • ISPPTI
    : Property insurance.
  • ISRELG
    : Transaction is for general rental/lease.
  • ISRENT
    : The payment of rent.
  • ISRLWY
    : Payment for railway transport related business.
  • ISROYA
    : Royalties.
  • ISSALA
    : Salary payment.
  • ISSANG
    : Payment to savings/retirement account.
  • ISSECU
    : Securities.
  • ISSSBE
    : Social security benefit.
  • ISSTDY
    : Study.
  • ISSUBS
    : Subscription.
  • ISSUPP
    : Supplier payment.
  • ISTAXR
    : Refund of a tax payment or obligation.
  • ISTAXS
    : Tax payment.
  • ISTBIL
    : Transaction is related to a payment of telecommunications related bill.
  • ISTRAD
    : Trade services operation.
  • ISTREA
    : Treasury payment.
  • ISTRPT
    : Payment for travel.
  • ISUBIL
    : Utility bill payment.
  • ISVATX
    : Value added tax payment.
  • ISWHLD
    : With holding.
  • ISWTER
    : Payment of water.
Required with Mastercard.
These are the values:
  • 00
    : Other
  • 01
    : Routing transit number (RTM) and bank account
  • 02
    : IBAN
  • 03
    : Card account
  • 04
    : Email
  • 05
    : Phone number
  • 06
    : Bank account number (BAN) and Bank identification number code (BIC)
  • 07
    : Wallet ID
  • 08
    : Social network ID
Required with Visa in Canada.
Required with Visa when the
recipientInformation.country
 field value is Canada.
Required with Visa when the
recipientInformation.country
 field value is Canada.
Required with Visa when the
senderInformation.country
 field value is Canada and the US.

Related Information

Optional Fields for Performing an AFT with Visa

You can include these optional fields in an authorization request for an AFT:
When you do not include this value in your request, Cybersource uses the merchant configuration fields from your account.
Required with Visa in Australia and Canada.
When you do not include this value in your request, Cybersource uses the merchant configuration fields from your account.
Required with Visa in Australia.
When you do not include this value in your request, Cybersource uses the merchant configuration fields from your account.
Required with Visa in Australia and Canada.
When you do not include this value in your request, Cybersource uses the merchant configuration fields from your account.
Required with Visa in Australia and Canada.
When you do not include this value in your request, Cybersource uses the merchant configuration fields from your account.
Required with Visa in Australia and Canada.

Related Information

REST Example: AFT with Visa

Request: Authorization Service for an AFT with Visa
Visa Example: Consumer funding an account-to account-transfer when the sender and recipient are the same person.
{
    "clientReferenceInformation": {
        "code": "TC50171_3"
    },
    "paymentInformation": {
        "card": {
            "number": "411111111111XXXX",
            "expirationMonth": "12",
            "expirationYear": "2031"
        }
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "100.00",
            "currency": "USD"
        },
        "billTo": {
            "firstName": "John",
            "lastName": "Doe",
            "address1": "1 Market St",
            "locality": "san francisco",
            "administrativeArea": "CA",
            "postalCode": "94105",
            "country": "US",
            "email": "test@cybs.com",
            "phoneNumber": "4158880000"
        }
    },
    "processingInformation": {
     "authorizationOptions": {
      "aftIndicator": "y"
     },
      "commerceIndicator": "internet",
      "businessApplicationId": "PP",
      "purposeOfPayment": "ISACCT"
    },
    "merchantInformation": {
     "merchantCategoryCode": "6540",
     "merchantDescriptor": {
      "locality": "Sydney",
      "postalCode": "123456",
      "name": "Cybersource",
      "address1": "1 Test Street",
      "administrativeArea": "SA"
     }
    },
    "senderInformation": {
     "referenceNumber": "1234567890123456",
     "firstName": "John",
     "middleName": "Joe",
     "lastName": "Smith",
     "address1": "1 Test Street",
     "locality": "Northampton",
     "countryCode": "CAN",
     "administrativeArea": "ON",
     "account": {
      "number": "411111111111XXXX"
     }
    },
    "recipientInformation": {
     "firstName": "Joe",
     "middleName": "Bob",
     "lastName": "Bloggs",
     "accountType": "03",
     "accountId": "545454545454XXXX",
     "country": "CAN",
     "address1": "1 Test Street",
     "administrativeArea": "ON",
     "locality": "Vancouver"
    }
}
Response
{
    "_links": {
        "authReversal": {
            "method": "POST",
            "href": "/pts/v2/payments/7345247988967174740121/reversals"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/payments/7345247988967174740121"
        },
        "capture": {
            "method": "POST",
            "href": "/pts/v2/payments/7345247988967174740121/captures"
        }
    },
    "clientReferenceInformation": {
        "code": "TC50171_3"
    },
    "id": "7345247988967174740121",
    "orderInformation": {
        "amountDetails": {
            "authorizedAmount": "100.00",
            "currency": "USD"
        }
    },
    "paymentAccountInformation": {
        "card": {
            "type": "001"
        }
    },
    "paymentInformation": {
        "tokenizedCard": {
            "type": "001"
        },
        "card": {
            "type": "001"
        }
    },
    "processorInformation": {
        "approvalCode": "831000",
        "networkTransactionId": "201506041511351",
        "transactionId": "201506041511351",
        "responseCode": "00",
        "avs": {
            "code": "1"
        }
    },
    "status": "AUTHORIZED",
    "submitTimeUtc": "2024-12-18T12:26:39Z"
}

Account Funding Transactions (AFTs) with Mastercard

Payouts
 uses the authorization service to support AFTs. An AFT withdraws funds from a sender’s account.
First Data Merchant Solutions
 does not support zero amount for
orderInformation.amountDetails.totalAmount
 field.
IMPORTANT
You must receive prior approval from
First Data Merchant Solutions
 before using the AFT services. Contact
First Data Merchant Solutions
 to register in the AFT program.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/payments
Test:
POST
https://apitest.cybersource.com
/pts/v2/payments

Required Fields for an AFT Request with Mastercard

These fields are required to process an AFT request:
First Data Merchant Solutions
 does not support zero amount.
These are the values:
  • AA
    : Account to account.
  • BI
    : Money transfer (bank-initiated).
  • FD
    : Funds disbursement, e.g. insurance payout.
  • PD
    : Payroll disbursement
  • FT
    : Funds transfer.
  • PP
    : Person to person.
  • TU
    : Top Up: Prepaid load.
  • WT
    : Wallet transfer.
These are the values:
  • 00
    : Other
  • 01
    : Routing transit number (RTM) and bank account
  • 02
    : IBAN
  • 03
    : Card account
  • 04
    : Email
  • 05
    : Phone number
  • 06
    : Bank account number (BAN) and Bank identification number code (BIC)
  • 07
    : Wallet ID
  • 08
    : Social network ID

Related Information

Optional Fields for Performing an AFT with Mastercard

You can include these optional fields in an authorization request for an AFT:

Related Information

REST Example: AFT with Mastercard

Request: Authorization Service for an AFT with Mastercard
Mastercard Example: Consumer funding an account-to-account transfer when the sender and recipient are the same person.
{
    "clientReferenceInformation": {
        "code": "TC50171_3"
    },
    "paymentInformation": {
        "card": {
            "number": "545454545454XXXX",
            "expirationMonth": "12",
            "expirationYear": "2031"
        }
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "100.00",
            "currency": "USD"
        },
        "billTo": {
            "firstName": "John",
            "lastName": "Doe",
            "address1": "1 Market St",
            "locality": "san francisco",
            "administrativeArea": "CA",
            "postalCode": "94105",
            "country": "US",
            "email": "test@cybs.com",
            "phoneNumber": "4158880000"
        }
    },
    "processingInformation": {
    	"authorizationOptions": {
    		"aftIndicator": "y"
    	},
    	 "commerceIndicator": "internet",
    	 "businessApplicationId": "PP"
    },
    "merchantInformation": {
    	"merchantCategoryCode": "6540"
    },
    "senderInformation": {
    	"referenceNumber": "1234567890123456789",
    	"firstName": "John",
    	"middleName": "Joe",
    	"lastName": "Smith",
    	"address1": "1 Test Street",
    	"locality": "Northampton",
    	"countryCode": "GBR",
    	"account": {
    		"number": "545454545454XXXX"
    	}
    },
    "recipientInformation": {
    	"firstName": "Joe",
    	"middleName": "Bob",
    	"lastName": "Bloggs",
    	"accountType": "03",
    	"accountId": "545454545454XXXX",
    	"country": "GBR"
    }
}
}
Response
{
    "_links": {
        "authReversal": {
            "method": "POST",
            "href": "/pts/v2/payments/7345188576147159940121/reversals"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/payments/7345188576147159940121"
        },
        "capture": {
            "method": "POST",
            "href": "/pts/v2/payments/7345188576147159940121/captures"
        }
    },
    "clientReferenceInformation": {
        "code": "TC50171_3"
    },
    "id": "7345188576147159940121",
    "orderInformation": {
        "amountDetails": {
            "authorizedAmount": "100.00",
            "currency": "USD"
        }
    },
    "paymentAccountInformation": {
        "card": {
            "type": "002"
        }
    },
    "paymentInformation": {
        "tokenizedCard": {
            "type": "002"
        },
        "card": {
            "type": "002"
        }
    },
    "processorInformation": {
        "approvalCode": "831000",
        "networkTransactionId": "MCC9999991231",
        "transactionId": "MCC9999991231",
        "responseCode": "00",
        "avs": {
            "code": "1"
        }
    },
    "status": "AUTHORIZED",
    "submitTimeUtc": "2024-12-18T10:47:37Z"}

Reference

This section provides helpful reference information for using Payouts services.

Business Application Identifier

The Business Application Identifier (BAI) identifies the category of the Account Funding Transaction (AFT).
All acquirers, service providers, and merchants must submit a valid BAI value when submitting an AFT.
Provide one of the values when you send field
processingInformation.businessApplicationId
.
IMPORTANT
Ensure that your acquirer has a Merchant Category Code (MCC) that corresponds with the BAI value you are using. For more information, contact your acquirer.
Business Application Identifier Values
BAI Value
Category
Requirements
AA
Account-to-Account Money transfer. This value is for funding the cardholder's own account at the same or a different financial institution. Both accounts must be owned by the same person or entity.
NOTE
If funding a prepaid account, do not use this value. Use
TU
 instead.
BI
Financial Institution offered Bank-Initiated P2P Money Transfer
P2P Money transfer is started from an online banking system, making it a bank-initiated transaction. This category is only used for specific scenarios and is only available in limited markets. For more information, contact your Visa representative.
FD
Funds Disbursement
FT
Funds Transfer
If the funds will be used for a high-brand risk transaction, the applicable high-brand risk MCC must be used. If a wallet is used to purchase Liquid and Cryptocurrency assets, the applicable special condition indicator must be used.
PD
Payroll Disbursement
PP
Person-to-Person (P2P) Money Transfer
P2P Money transfer is started from an online banking system, making it a bank-initiated transaction. This category is only used when both AFTs and OCTs are supported. When only AFT is supported, use the
FT
 category.
TU
Prepaid Card Load or Top-Up
WT
Staged Digital Wallet (SDW) Transfer
If the funds will be used for a high-brand risk transaction, the applicable high-brand risk MCC must be used. If the funds are used for a gambling transaction, the applicable gambling MCC must be used. If a wallet is used to purchase Liquid and Cryptocurrency assets, the applicable special condition indicator must be used. An AFT is not intended for debt repayment.

Recipient Account

The Sender Source field identifies the source of funds. Provide one of the values when you send field
recipientInformation.accountType
.
Recipient Account Values
Value
Definition
00
Other
01
RNT and Bank Account
02
IBAN
03
Card Account
04
Email
05
Phone Number
06
Bank account number (BAN) and Bank Identification Code (BIC)
07
Wallet ID
08
Social Network ID