Payment Account Tokenization

Start a Project Start a Project API Overview API Overview API Reference API Reference
Navigate to...
keyboard_arrow_down

Token Requestor Onboarding API

API Overview

This API is used to onboard new token requestors under an aggregator requestor.

Available Endpoints

Endpoint Usage
/onboardtokenrequestors Used to onboard requestors for an aggregator.

Onboard Token Requestors

This flow is used to add one or more TRIDs at a time by simply providing the ID of the requestor under which a TRID needs to be added, and the name this TRID will carry. The API is synchronous. The response to the request message includes information about the TRIDs that were created.

Onboard new token requestors

PAT_TRO_Create_TokenRequestor_Sync

Token Requestor Onboarding API Response Codes

Response Codes

This section includes detailed information about the API Response fields: statusCode, statusMessage, result, reasonCode and message.

Example HTTP 200 onboardtokenrequestors Response Example

{
    "messageId":"b71c617a-56fd-4f45-b045-604ae426478f", 
    "statusCode":"00000",
    "statusMessage":"SUCCESS", 
    "tokenRequestors":[
    {
        "entityId":"5faf4f06", 
        "tokenRequestorId":"77738551970", 
        "onboardingStatus":[
            {
                "result":"SUCCESS", 
                "reasonCode":"SUCCESS"
            }
        ]
        },
        {
            "entityId":"5faf4f07", 
            "onboardingStatus":[
                {
                    "result":"INVALID_VALUE",
                    "reasonCode":"INVALID_FIELD_VALUE",
                    "message": "Token Requestor legal name is already used by another TRID"
                }
            ]
        }
    ]
}

Response Message: HTTP Code, statusCode and statusMessage

HTTP Code statusCode statusMessage Applicable Message
200 00000 SUCCESS onboardtokenrequestors
400 16001 Invalid request onboardtokenrequestors
401 16003 Unauthorized request onboardtokenrequestors
400 16004 Invalid Domain onboardtokenrequestors
400 16005 Invalid Requestor onboardtokenrequestors
500 16999 Internal server error onboardtokenrequestors

onboardingStatus: result, reasonCode and message

result reasonCode message
SUCCESS SUCCESS -
INVALID_VALUE INVALID_FIELD_VALUE Requestor is not valid
INVALID_VALUE INVALID_FIELD_VALUE Token Requestor legal name is already used by another TRID
INVALID_VALUE INVALID_FIELD_VALUE Requestor is not in same hierarchy as the calling requestor
INVALID_VALUE INTERNAL_PROCESSING_FAILURE Error occurred while onboarding requestor
INVALID_VALUE INVALID_FIELD_VALUE Token Requestor legal name is empty