On This Page

Validating an Account Using a TMS Token: Instrument Identifier

An instrument identifier is a type of token created by Token Management Systems (TMS) to identify the bank or payment account to use for payment. It can be used to validate a customer's routing and bank account information.

This section describes how to validate using an instrument 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 an Instrument Identifier

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

REST Example: Validating an Account Using an Instrument Identifier

Request

{
    "clientReferenceInformation": {
        "code": "TC50171_3"
    },
    "processingInformation": {
        "validationLevel": 1
    },
    "paymentInformation": {
        "instrumentIdentifier": {
            "id": "4A1A21D4431F45A4E0633F36CF0A2293"
        }
    }
}

Response to a Successful Request

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