Operations
A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.
The id of the issuer
Unique identifier of the card.
[A-Za-z0-9_-]{1,48}Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}The reason why the action is performed.
This a free text field in case the Issuer wants to send details, that will be returned in the operations list.
customer was contacted on June 28Pattern: ^[a-zA-Z0-9 ]{1,64}$The reason why the action has been performed. If not provided, default reason code is ISSUER_DECISION.
Card resumed successfully
Bad Request, Invalid request URI or header, or unsupported nonstandard parameter
The provided Authorization header is missing or invalid
Forbidden operation. Check the state of the end user (consumer) is ACTIVE.
After a migration done from D1 V1 APIs to D1 V2 APIs a 403 may be returned if
- The reasonCode provided is not allowed. Check the card status, or set the reason code to ISSUER_DECISION
Card not found.
Internal Server Error
A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.
The id of the issuer
Unique identifier of the card.
[A-Za-z0-9_-]{1,48}Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}The reason why the action is performed.
This a free text field in case the Issuer wants to send details, that will be returned in the operations list.
customer was contacted on June 28Pattern: ^[a-zA-Z0-9 ]{1,64}$The reason why the action has been performed. If not provided, default reason code is ISSUER_DECISION.
Card was suspended successfully
Bad Request, Invalid request URI or header, or unsupported nonstandard parameter
The provided Authorization header is missing or invalid
After a migration done from D1 V1 APIs to D1 V2 APIs a 403 may be returned if
- The reasonCode provided is not allowed. Check the card status, or set the reason code to ISSUER_DECISION
Card not found.
Internal Server Error
A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.
The id of the issuer
Unique identifier of the card.
[A-Za-z0-9_-]{1,48}Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}The reason why the action is performed.
This a free text field in case the Issuer wants to send details, that will be returned in the operations list.
customer was contacted on June 28Pattern: ^[a-zA-Z0-9 ]{1,64}$The reason why the action has been performed. If not provided, default reason code is ISSUER_DECISION.
Card was deleted successfully
Bad Request, Invalid request URI or header, or unsupported nonstandard parameter
The provided Authorization header is missing or invalid
After a migration done from D1 V1 APIs to D1 V2 APIs a 403 may be returned if
- The reasonCode provided is not allowed. Check the card status, or set the reason code to ISSUER_DECISION
Resource not found, Unknown issuerId or consumerId or accountId
Internal Server Error
A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.
The id of the issuer
Unique identifier of the card.
[A-Za-z0-9_-]{1,48}Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}Unique identifier of the card.
[A-Za-z0-9_-]{1,48}Reserved for future use; card product update is currently not supported.
[A-Za-z0-9_-]{1,48}New state of the card after renew
The encryptedData is the encrypted json (cf http://www.json.org/ ) representation of the new card information.
This field is mandatory for AMEX cards and optional information for all the other schemes, if not provided Thales will call get card credentials API to retrieve the data.
This value is encrypted using the JWE encryption (please refer to the Encrypt sensitive data for more details)
Content
Once deciphered, the plaintext contains a json structure with:
| JSON field parameter name | description | MOC | Format |
|---|---|---|---|
| pan | The funding pan value. | M | string - from 10 to 19 digits |
| exp | The expiry date of the card. | M | string - 4 digits, following the format MMYY |
| psn | PAN Sequence number. | O | string - 2 digits (only applicable to AMEX scheme) |
| auxiliaryPan | The auxiliary funding pan value. It shall be provided when cobadge is supported and if the card has an auxiliary pan. | C | string - up to 19 digits |
| auxiliaryExp | The auxiliary expiry date of the card. It shall be provided when cobadge is supported and if the card has an auxiliary pan. | C | string - 4 digits, following the format MMYY |
encryptedData with card pan and card expPattern: ^(?:[\x20-\x2D\x2F-\x7F]*\.){4}(?:[\x20-\x2D\x2F-\x7F]*)$The reason why the action is performed.
This a free text field in case the Issuer wants to send details, that will be returned in the operations list.
customer was contacted on June 28Pattern: ^[a-zA-Z0-9 ]{1,64}$The reason why the action has been performed. If not provided, default reason code is ISSUER_DECISION.
Card was renewed successfully
Bad Request, Invalid request URI or header, or unsupported nonstandard parameter
The provided Authorization header is missing or invalid
Forbidden action, that can be blocked for different reasons:
- end user (consumer) state shall be active,
- in case the new card was already registered, check that the 2 cards belong to the same end user (consumer),
- in case the new card was already registered, check that the new and old cards are linked to the same CardProductId.
After a migration done from D1 V1 APIs to D1 V2 APIs a 403 may be returned if
- The newCardId provided in the payload is equal to the cardId but the card PAN has been updated. When PAN needs to be updated, the V2 replace API should be called.
- The newCardId provided in the payload is not equal to the cardId but the card PAN is still the same. When a card expiry date update without PAN update is required, the V2 renew API should be called.
- The newCardId provided in the payload is not equal to the cardId but the state passed is INACTIVE. When a state INACTIVE is required, the V2 suspend API should be called after a renew v1 with ACTIVE.
- The reasonCode provided in the payload is not allowed. Check the card status, or set the reason code to ISSUER_DECISION
Card not found.
Internal Server Error
A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.
The id of the issuer
Unique identifier of the card.
[A-Za-z0-9_-]{1,48}Index from which the query starts returning operations – Offset 0 (the default) corresponds to the most recent operation.
Number of operations to be returned
10Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}OK
Bad Request, Invalid request URI or header, or unsupported non-standard parameter
The provided Authorization header is missing or invalid
Ressource not found, Unknown issuerId or consumerId or card id'. The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| UNKNOWN_CARD | - | no | Unknown cardId |
Internal Server Error
A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.
The id of the issuer
Unique identifier of the card.
[A-Za-z0-9_-]{1,48}Unique identifier of the operation
[A-Za-z0-9_-]{1,64}Flag indicating whether digital card details (including the device data used to digitize and the requestor data) should be provided in the response. Only applicable to DIGITIZE Operations
falseRandom identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.
Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.
There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for purposes other than logging and troubleshooting.
[a-zA-Z0-9_\-\. ]{1,64}OK
Bad Request, Invalid request URI or header, or unsupported non-standard parameter
The provided Authorization header is missing or invalid
Ressource not found, Unknown issuerId or consumerId or card id'. The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| UNKNOWN_CARD | - | no | Unknown cardId |
| UNKNOWN_OPERATION | - | no | Unknown operationId |
Internal Server Error
最終更新
役に立ちましたか？