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

This API is used to onboard new Token Requestors under an aggregator requestor.

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.

API Reference

<Link to APIConnect reference page>

Onboard Token Requestors

Process for onboarding new Token Requestors in the PAT system.

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.

Onboarding Process

  1. Aggregator requestor submits onboarding request
  2. PAT validates the request and requestor hierarchy
  3. New TRID is created and assigned
  4. Response includes success or failure information

Requirements

  • Valid aggregator requestor credentials
  • Unique Token Requestor legal name
  • Proper hierarchy relationship
  • Valid domain assignment

Token Requestor Onboarding API Response Codes

Response codes and status messages for Token Requestor Onboarding API endpoints.

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

API Reference

<Link to APIConnect reference page>

Example Onboard HTTP 200 Response

Example HTTP 200 response from Token Requestor Onboarding API.

Example HTTP 200 onboardtokenrequestors Response

{
"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 Structure

  • messageId: Unique message identifier
  • statusCode: Overall request status code
  • statusMessage: Overall request status message
  • tokenRequestors: Array of onboarding results for each requestor
  • entityId: Internal entity identifier
  • tokenRequestorId: Assigned Token Requestor ID
  • onboardingStatus: Individual onboarding result details

Onboarding Response Message Codes

Detailed response message codes for Token Requestor Onboarding API operations.

Onboarding Response Message Codes

This section provides detailed information about response message codes specific to Token Requestor Onboarding API operations.

Onboarding Validation

The onboarding process includes multiple validation steps:

  • Requestor hierarchy validation
  • Legal name uniqueness checking
  • Domain assignment validation
  • Authorization verification

Batch Onboarding

Multiple Token Requestors can be onboarded in a single request, with individual status reporting for each requestor in the batch.

Onboarding Status Result and Reason Codes

Onboarding status results, reason codes and messages for Token Requestor Onboarding API.

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