Tokenisation
Manage payment tokens against the token service provider — suspend, resume, delete, look up and search, and keep the provider in step when the card changes.
Seven operations against the token service provider. They manage tokens that already exist — suspend one, resume it, delete it, read its status, search the set — and keep the provider in step when the card underneath changes or is reissued.
Tokenization Outdoor Integration API 7
v1.0.0.0 · every operation is a POST
Token lifecycle 3
Suspend (block) a token
| /tokenization-outdoor/api/suspendTokenAsync | Type |
|---|---|
| tokenIdentifier | string |
| reason | string |
| reasonDescription | string |
| causedBy | string |
Resume (unblock) a token
| /tokenization-outdoor/api/resumeTokenAsync | Type |
|---|---|
| tokenIdentifier | string |
| reason | string |
| reasonDescription | string |
| causedBy | string |
Delete (terminate) a token permanently
| /tokenization-outdoor/api/deleteTokenAsync | Type |
|---|---|
| tokenIdentifier | string |
| reason | string |
| reasonDescription | string |
| causedBy | string |
Token query 2
Get token status and details
| /tokenization-outdoor/api/getTokenStatusAsync | Type |
|---|---|
| tokenIdentifier | string |
| includeDetails | boolean |
| returns | |
| tokenIdentifier | string |
| paymentAccountReference | string |
| status | string |
| statusTimestamp | string (date-time) |
| details | object |
Search tokens by criteria
| /tokenization-outdoor/api/searchTokensAsync | Type |
|---|---|
| paymentAccountReference | string |
| tokenIdentifier | string |
| status | array |
| maxResults | integer (int32) |
| returns | |
| tokens | array |
| totalCount | integer (int32) |
Card management 2
Notify TSP of card updates (expiry, details)
| /tokenization-outdoor/api/notifyCardUpdateAsync | Type |
|---|---|
| paymentAccountReference | string |
| updateType | string |
| newExpiry | string |
| cardholderInfo | object |
| returns | |
| paymentAccountReference | string |
| tokensAffected | integer (int32) |
| affectedTokens | array |
| updateTimestamp | string (date-time) |
Replace card (new PAN, reissue)
| /tokenization-outdoor/api/replaceCardAsync | Type |
|---|---|
| oldPaymentAccountReference | string |
| newCardData | object |
| reason | string |
| returns | |
| oldPaymentAccountReference | string |
| newPaymentAccountReference | string |
| tokensUpdated | integer (int32) |
| tokenReplacements | array |