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 all required properties depending on the type of payment you want to make:

• Always specify the SourceOfCash and purpose properties.
• If you want to pay a business or an individual, only include the beneficiary_token .
• If you want to pay a business or an individual on behalf of a third-party business, include both beneficiary_token and originator_token .

The following tabs show sample user_info objects for each type of payment:

{
    "user_info": {
        "beneficiary_token": "11111111-abcd-2222-efgh-333333333333",
        "SourceOfCash": "SVGS",
        "purpose": "OTHR"
    }
}

{
    "user_info": {
        "originator_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.

originator_token

This property identifies the party that originates the payment. The value of this property is the identityId of an existing originator.

To get an existing originator's identityId, call the GET /identities operation with the query parameter identityType set to ORIGINATOR. You can get the originator's identityId from the response. For more information, see the Get an identity tutorial.

beneficiary_token

This property identifies the beneficiary of this payment. The value of this property is the identityId of an existing beneficiary.

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. For more information, see the Get an identity tutorial .

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.

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.