Working with the user_info object

When you call the POST /payments/accept operation to accept a quote, you must include the user_info object in the request body. Use this object to specify key information about the payment, such as information about the beneficiary and the purpose of the payment.

The following sections walk you through an example user_info object.

The user_info object

The user_info object accepts key-value pairs in JSON format. To successfully accept a quote, you must include the properties shown in the following code sample

Copy
Copied!
{
    "user_info": {
        "sender_token": "12345678-abcd-1234-abcd-123456789123",
        "beneficiary_token": "11111111-abcd-2222-efgh-333333333333",
        "SourceOfCash": "SVGS",
        "purpose": "OTHR"
    }
}

The following sections provide more details about each property.

sender_token

This property identifies the sender who is initiating this payment. The value of this property is identityId of an existing sender. To get an existing sender's identityId call the GET /identities operation with the query parameter identityType set to SENDER. You can get the sender's identityId from the response.

beneficiary_token

This property identifies the beneficiary of this payment. The value of this property is identityId of an existing benficiary. To get a beneficiary's identityId call the GET /identities operation with the query parameter identityType set to BENEFICIARY. You can get the beneficiary's identityId from the response.

SourceOfCash

This property indicates the source of funds for this payment. This value must be equal to one of the known values in the table below.

Expand to see the list of known values for SourceOfCash

Known values for SourceOfCash

Value Description
ALMY Alimony
CASH Cash Proceeds
COMP Compensation
EMIN Employee Income
GIFT Gift
INHE Inheritance
INLQ Insurance Premium Liquidation
PACA Paid Up Capital
REDM Redemption
REPY Retirement Policy
REST Real Estate Sale
RETA Retained Earnings
SALE Sale Of Goods
SEAQ Sale Aquisition Corporation
SELF Self Employment Income
SVGS Savings
WINS Winnings

purpose

This property indicates the purpose of the payment. The value of this property must be equal to one of the values in the table below.

Expand to see the list of known values for purpose

Known values for purpose

Value Description
ALLW Allowance
BONU Bonus payment
CISC Construction and installation services
COMM Commission
DEPT Deposit
DOFI Deposits with or from offshore financial institutions
EDSC Education services
EDUC Education
ENGS Architectural, engineering and other technical services
FAMI Family maintenance
FEES Payment of fees
GDDS Purchase sale of goods
GDSV Purchase sale of goods and services
GIFT Allowance (Gift)
GSPM Goods for processing and manufacturing services
GSST Goods and services by short-term workers
GSTR Goods and services by travelers
HLTC Home health care
INTC Intra company payment
INTE Interest
INVS Investment and securities
IVPT Invoice payment
MACH Payment for machinery, non-customized packaged software and transport equipment
MDCS Medical services
MFGD Payment for manufactured goods
MMFA Payment for miscellaneous manufactured articles
MP2P Mobile peer-to-peer (P2P) payment
MRSC Maintenance and repair services
OCDM Order cheque domestic
OCFG Order cheque foreign
OTHR Others
PAYR Payroll
PSFR Passenger fare
REAB Real estate abroad
RELG Rental lease general
SALA Salary payment
SCVE Purchase sale of services
STDY Study
SUPP Supplier payment
TLLT Term loans long-term
TLST Term loans short-term
TRAD Trade services
VIAC Visa application charges