This API is used by Financial Institutions to get information on tokens linked to accounts, perform life cycle management operations on tokens and update token restrictions.
This API is used by Financial Institutions to get information on tokens linked to accounts, perform life cycle management operations on tokens and update token restrictions.
Note that when the Financial Institution state is disabled or closed, all API requests are rejected with statusCode 13011: Financial Institution is not in valid state.
| Endpoint | Usage |
|---|---|
| /gettokens | Used to get all the tokens linked to an account. |
| /tokenlifecyclemanagement | Used to perform state change operation on a Token. |
| /replacerealaccount | Used to replace the underlying account of a token. |
<Link to APIConnect reference page>
Overview of message flows for Financial Institution API operations.
The diagrams below provide an overview of the FI API message flows for Get Tokens, Lifecycle Management and Replace underlying real routing and account.
Note that when the Financial Institution state is disabled or closed, all API requests are rejected with statusCode 13011: Financial Institution is not in valid state.
Financial Institutions can manage the lifecycle of tokens associated with their accounts through the FI API.
Financial Institutions can replace the underlying account information for tokens using real account details.
Financial Institutions can replace the underlying account information for tokens using token-based routing information.
Financial Institutions can retrieve all tokens associated with their accounts.
How Financial Institutions manage token lifecycles through the FI API.
Financial Institutions have comprehensive control over the lifecycle of tokens associated with their accounts. This includes the ability to activate, suspend, deactivate, and delete tokens as needed for risk management and operational requirements.
FIs can manage token lifecycles through:
When FIs initiate lifecycle changes, notifications are sent to the relevant Token Requestors to ensure all parties are informed of the state changes.
Process for replacing underlying account information using real account details.
Financial Institutions can replace the underlying real account information for existing tokens using real routing and account numbers. This operation allows FIs to update the account backing a token without affecting the token itself.
Process for replacing underlying account information using token-based routing.
Financial Institutions can replace the underlying account information for tokens using token-based routing and account information. This allows for more flexible account management within the tokenized environment.
PAT validates that:
How Financial Institutions can retrieve tokens associated with their accounts.
Financial Institutions can use the Get Tokens API to retrieve all tokens that are linked to their real account numbers. This operation provides visibility into all tokenized versions of their accounts.
The /gettokens endpoint is used to retrieve all tokens linked to a specific account.
Response codes and status messages for Financial Institution API endpoints.
This section includes detailed information about the API Response fields statusCode and statusMessage.
Start a Project
API Overview
API Reference
{
"messageId": "6fdf4f09-7fbb-48ae-be1e-ac412a2949a7",
"statusCode": "00000",
"statusMessage": "Success.",
"encTokens": "..."
}
| HTTP Code | statusCode | statusMessage | Applicable Message |
|---|---|---|---|
| 200 | 00000 | Success. | - |
| 400 | 13001 | Invalid request. The data field is not in the correct data type format or length or pre-defined values or the required data field is missing. | - |
| 400 | 13003 | Token not found. | - |
| 400 | 13004 | Real account not found. | - |
| 400 | 13005 | Token is not in valid state. | - |
| 400 | 13007 | New account belongs to a range different than the existing account. | - |
| 400 | 13008 | No account range found for new account. | - |
| 400 | 13009 | Feature not supported. | - |
| 400 | 13010 | Token Requestor is not in valid state. | - |
| 400 | 13011 | Financial Institution is not in valid state. | - |
| 401 | 13022 | Unauthorized request | - |
| 500 | 13100 | Unknown internal server error. Try again later. | - |
| 500 | 13199 | Unknown error. | - |
<Link to APIConnect reference page>
Example HTTP 200 response from Financial Institution API with encrypted tokens.
{
"messageId": "6fdf4f09-7fbb-48ae-be1e-ac412a2949a7",
"statusCode": "00000",
"statusMessage": "Success.",
"encTokens": "..."
}
Detailed response message codes for Financial Institution API operations.
This section provides detailed information about response message codes specific to Financial Institution API operations.
All FI API responses follow a standard format with HTTP status codes, PAT-specific status codes, and descriptive messages.
Financial Institution API responses include comprehensive error information to help diagnose and resolve issues: