On This Page

Validating an Account Using a TMS Token: Customer Identifier

A customer identifier is a type of token created by the Token Management Systems (TMS) to retrieve customer-associated data. It can be used to validate a customer's routing and bank account information.

This section describes how to validate using a customer identifier type of TMS token submitted through the REST API. Follow these steps to request a bank account validation:

Create a request with the required and any optional REST API fields. Refer to the request and response examples, if needed.

Send the completed request to one of these endpoints:

Production:

POST api.cybersource.com/bavs/v1/account-validations

Test:

POST apitest.cybersource.com/bavs/v1/account-validations

Verify the response messages to make sure that the request succeeded. For more information, see the Transaction response codes.

Required Fields for Validating an Account Using a Customer Identifier

processingInformation.validationLevel: Set the value to
1
.
paymentInformation.customer.id: The unique identifier for the Customer token. This value is a non-negative string with 12-32 characters.

Optional Fields for Validating an Account

clientReferenceInformation.code: Set the value to any reference code that you choose to associate with the validation request. This code is returned in the response exactly as provided.

REST Example: Validating an Account Using a Customer Identifier

Request

{
    "clientReferenceInformation": {
        "code": "TC50171_3"
    },
    "processingInformation": {
        "validationLevel": 1
        },
    "paymentInformation": {
        "customer": {
            "id": "4A1B5976688BAD2EE0633F36CF0A054E"
        }
    }
}

Response to a Successful Request

{
    "clientReferenceInformation": {
        "code": "TC50171_3"
    },
    "requestId": "string",
    "submitTimeUtc": "string",
    "bankAccountValidation": {
        "rawValidationCode": integer,
        "resultCode": integer,
        "resultMessage": "string"
    }
}