The following APIs and endpoints are available to provide PAT services for token requestors, financial institutions, and transaction processing.
| API | Description | Endpoint | Usage |
|---|---|---|---|
| Token Requestor API | This API is used by Token Requestors like Financial Institutions, Central Operators, Fintech aggregators etc. to provision a token and perform life cycle management operations on it. | /tokenize | Used to tokenize an account. |
| /requestlifecyclemanagement | Used to perform a state change operation on a Token. | ||
| /tokenstatusinquiry | Used to enquire status of a token. | ||
| /updatetokenrestrictions | Used to update restrictions of a token. | ||
| Financial Institution API | 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. | /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. | ||
| Token Requestor Onboarding API | This API is used to onboard new Token Requestors under an aggregator requestor. | /onboardtokenrequestors | Used to onboard requestors for an aggregator. |
| Transaction API | This API is used to detokenize the debtor and creditor tokens and validate the attributes on the tokens against the transaction data. | /validatetransaction | Used to detokenize and validate token attributes. |
| Notification API | This API is used to notify Financial Institutions and Token Requestors when tokens are provisioned or when the state of a token change. | /token/state/provisioned | Notification to inform FI that the token was provisioned to their account. |
| /token/state/changed | Notification to inform FIs and TRs that token state has changed. |
Start a Project
API Overview
API Reference