API de tarjetas
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
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 other purpose than logging and troubleshooting.
^[A-Za-z0-9_-]{1,64}$Identifier of the user that requests the operation on D1 API. This value is provided for information purpose, D1 doesn't do any verification based on this identifier.
D1 manages to propagate the information to a subsequent internal system for tracking purpose.
This identifier is not mandatory.
^[A-Za-z0-9_-]{1,15}$Unique identifier of the consumer.
^[A-Za-z0-9_-]{1,64}$Unique identifier of the type of card ( defined during the onboarding of D1)
^[A-Za-z0-9_-]{1,48}$The state of the card
If not provided, the card is considered ACTIVE
Name of the card holder as it will be printed/embossed on the card.
For virtual card this value will be used exclusively for card display.
Empty string supported.
^[a-zA-Z. -]{0,26}$Optional second card holder name as it will be printed/embossed on the card under the first card holder name.
Not used in case of virtual card.
^[a-zA-Z. -]{0,26}$This indicates the state of the card once it's created
INPattern: ^[a-zA-Z]{0,2}$Successful card creation
Information related to the created card.
Unique identifier of the card.
^[A-Za-z0-9_-]{1,48}$Bad Request, Invalid request URI, header, paramters. The below table defines the possible 'Bad request' error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| FIELD_INVALID_FORMAT | Contains the field in error (first found) | no | JSON not well formatted or One field is not expected format as defined in this documentation |
| FIELD_INVALID_VALUE | Contains the field in error (first found) | no | One field value is not allowed for the given field |
Unauthorized request, the provided Authorization header is missing or invalid. In the table below only the field "error" is provided.
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| AUTHORIZER_UNAUTHORIZED | Unauthorized message | no | Access token not valid |
Forbidden action detected by WAF or the application.
The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| AUTHORIZER_FORBIDDEN | not authorized error message | no | User is not authorized to access this resource |
| CARD_CREATION_COUNT_EXCEEDED | - | no | The maximum number of cards for the consumer is reached. Creation of additional card is not possible. |
| OPERATION_NOT_ALLOWED | Name of the operation/field that is not allowed in this operation | no | Card creation is not allowed for this card product |
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_CONSUMER | - | no | Consumer does not exist |
Internal Server Error. The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | yes | No error details available |
| INTERNAL_ERROR | error details if any | no | The server has encountered an error when executing the request. |
The service is temporarily unavailable. You may retry your request later.
POST /banking/v2/issuers/{issuerId}/cards HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 203
{
"consumerId": "text",
"cardProductId": "text",
"state": "ACTIVE",
"name": "text",
"secondName": "text",
"statusReason": "IN",
"accountList": [
{
"default": true,
"type": "CHECKING",
"number": "text",
"currencyCode": "EUR"
}
]
}{
"cardId": "text"
}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 other purpose than logging and troubleshooting.
^[A-Za-z0-9_-]{1,64}$Identifier of the user that requests the operation on D1 API. This value is provided for information purpose, D1 doesn't do any verification based on this identifier.
D1 manages to propagate the information to a subsequent internal system for tracking purpose.
This identifier is not mandatory.
^[A-Za-z0-9_-]{1,15}$Unique identifier of the consumer.
^[A-Za-z0-9_-]{1,64}$Unique identifier of the type of card ( defined during the onboarding of D1)
^[A-Za-z0-9_-]{1,48}$The state of the card
If not provided, the card is considered ACTIVE
Name of the card holder as it will be printed/embossed on the card.
For virtual card this value will be used exclusively for card display.
Empty string supported.
^[a-zA-Z. -]{0,26}$Optional second card holder name as it will be printed/embossed on the card under the first card holder name.
Not used in case of virtual card.
^[a-zA-Z. -]{0,26}$The encryptedData is the encrypted json (cf http://www.json.org/) representation of the Card information.
This value is encrypted using the JWE encryption (please refer to the Encrypt sensitive data for more details)
Once deciphered, the plaintext contains a json structure with:
| JSON field parameter name | description | MOC | Format |
|---|---|---|---|
| pan | The funding pan value. | M | string - up to 19 digits |
| exp | The expiry date of the card. | M | string - 4 digits, following the format MMYY |
| 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 |
As D1 is able to compute the CVV2, the cvv parameter is not expected.
^(?:[\x20-\x2D\x2F-\x7F]*\.){4}(?:[\x20-\x2D\x2F-\x7F]*)$Successful card registration
Sin contenido
Bad Request, Invalid request URI, header, paramters. The below table defines the possible 'Bad request' error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| FIELD_INVALID_FORMAT | Contains the field in error (first found) | no | One field is not expected format as defined in this documentation |
| CRYPTO_ERROR | - | no | Not possible to decrypt the provided encrypted data |
| FIELD_INVALID_VALUE | - | no | One field value is not allowed for the given field |
| INVALID_PAN | - | no | PAN is invalid |
| INVALID_EXPIRY_DATE | Expiry date is invalid |
Unauthorized request, the provided Authorization header is missing or invalid. In the table below only the field "error" is provided.
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| AUTHORIZER_UNAUTHORIZED | Unauthorized message | no | Access token not valid |
Forbidden action detected by WAF or the application. The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| AUTHORIZER_FORBIDDEN | not_authorized error message | no | User_is_not_authorized_to_access_this_resource |
| CARD_ALREADY_EXISTS | - | no | CardId already registered in the solution |
| CARD_INVALID_STATE | - | no | CardId already registered in the solution and has an invalid card state (REPLACED or DELETED) |
| CONSUMER_INVALID_STATE | - | no | Consumer exists with an invalid consumer state (DELETED) |
| OPERATION_NOT_ALLOWED | Name of the operation/field that is not allowed in this operation | no | Register is not allowed for this card product |
Ressource not found, Unknown issuerId
Internal Server Error. The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | yes | No error details available |
| INTERNAL_ERROR | error details if any | no | The server has encountered an error when executing the request. |
The service is temporarily unavailable. You may retry your request later.
PUT /banking/v2/issuers/{issuerId}/cards/{cardId} HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 118
{
"consumerId": "text",
"cardProductId": "text",
"state": "ACTIVE",
"name": "text",
"secondName": "text",
"encryptedData": "text"
}Sin contenido
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 other purpose than logging and troubleshooting.
^[A-Za-z0-9_-]{1,64}$Identifier of the user that requests the operation on D1 API. This value is provided for information purpose, D1 doesn't do any verification based on this identifier.
D1 manages to propagate the information to a subsequent internal system for tracking purpose.
This identifier is not mandatory.
^[A-Za-z0-9_-]{1,15}$Successful get card credentials
The encryptedData is the encrypted json (cf http://www.json.org/) representation of the Card information.
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 pan value. | M | string - up to 19 digits |
| exp | The expiry date of the card. | M | string - 4 digits, following the format MMYY |
| name | The card holder name. | O | string - up to 26 characters |
| cvv | The CVV2 or DCVV2 value of the card | M | string - 3 or 4 digits |
^(?:[\x20-\x2D\x2F-\x7F]*\.){4}(?:[\x20-\x2D\x2F-\x7F]*)$Bad Request, Invalid request URI, header, paramters. The below table defines the possible 'Bad request' error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| FIELD_INVALID_FORMAT | Contains the field in error (first found) | no | One field is not expected format as defined in this documentation |
Unauthorized request, the provided Authorization header is missing or invalid.
In the table below only the field "error" is provided.
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| AUTHORIZER_UNAUTHORIZED | Unauthorized_message | no | Access token not valid |
Forbidden action detected by WAF or the application.
The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| AUTHORIZER_FORBIDDEN | not_authorized error message | no | User is not authorized to access this resource |
| CARD_INVALID_STATE | - | no | Impossible to get card credentials as the card is DELETED, SUSPENDED or REPLACED. |
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. The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | yes | No error details available |
| INTERNAL_ERROR | error details if any | no | The server has encountered an error when executing the request. |
| WRONG_CONFIGURATION | Missing key configuration for encryption | The server is not configured to performe the encryption of card information |
The service is temporarily unavailable. You may retry your request later.
GET /banking/v2/issuers/{issuerId}/cards/{cardId}/credentials HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"encryptedData": "text"
}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 other purpose than logging and troubleshooting.
^[A-Za-z0-9_-]{1,64}$Identifier of the user that requests the operation on D1 API. This value is provided for information purpose, D1 doesn't do any verification based on this identifier.
D1 manages to propagate the information to a subsequent internal system for tracking purpose.
This identifier is not mandatory.
^[A-Za-z0-9_-]{1,15}$The reason why the action is performed.
This a free text field in case the bank 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
Unique identifier of the operation
^[A-Za-z0-9_-]{1,64}$Bad Request, Invalid request URI, header, paramters. The below table defines the possible 'Bad request' error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| FIELD_INVALID_FORMAT | Contains the field in error (first found) | no | JSON not well formatted or One field is not expected format as defined in this documentation |
Unauthorized request, the provided Authorization header is missing or invalid. In the table below only the field "error" is provided.
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| AUTHORIZER_UNAUTHORIZED | Unauthorized message | no | Access token not valid |
Forbidden action detected by WAF or the application.
The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| AUTHORIZER_FORBIDDEN | not authorized error message | no | User is not authorized to access this resource |
| CARD_INVALID_STATE | - | no | Possible error is card already deleted with an other reason |
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. The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | yes | No error details available |
| INTERNAL_ERROR | error details if any | no | The server has encountered an error when executing the request. |
The service is temporarily unavailable. You may retry your request later.
POST /banking/v2/issuers/{issuerId}/cards/{cardId}/operations:delete HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"reason": "customer was contacted on June 28",
"stateReason": "CLOSED_ACCOUNT"
}{
"operationId": "text"
}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 other purpose than logging and troubleshooting.
^[A-Za-z0-9_-]{1,64}$Identifier of the user that requests the operation on D1 API. This value is provided for information purpose, D1 doesn't do any verification based on this identifier.
D1 manages to propagate the information to a subsequent internal system for tracking purpose.
This identifier is not mandatory.
^[A-Za-z0-9_-]{1,15}$Unique identifier of the new card. Provided in case the card is in REPLACED state.
^[A-Za-z0-9_-]{1,48}$The encryptedData has to be provided in case of card registered in D1. It is not needed for card created by D1.
The encryptedData is the encrypted json (cf http://www.json.org/) representation of the Card information.
This value is encrypted using the JWE encryption (please refer to the Encrypt sensitive data for more details)
Once deciphered, the plaintext contains a json structure with:
| JSON field parameter name | description | MOC | Format |
|---|---|---|---|
| pan | The funding pan value. | M | string - up to 19 digits |
| exp | The expiry date of the card. | M | string - 4 digits, following the format MMYY |
| 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 |
^(?:[\x20-\x2D\x2F-\x7F]*\.){4}(?:[\x20-\x2D\x2F-\x7F]*)$The reason why the action is performed.
This a free text field in case the bank 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 replaced Successfully
Unique identifier of the operation
^[A-Za-z0-9_-]{1,64}$Unique identifier of the card.
^[A-Za-z0-9_-]{1,48}$Bad Request, Invalid request URI, header, paramters. The below table defines the possible 'Bad request' error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| FIELD_INVALID_FORMAT | Contains the field in error (first found) | no | JSON not well formatted or One field is not expected format as defined in this documentation |
| FIELD_INVALID_VALUE | Contains the field in error (first found) | no | One field value is not allowed for the given field |
| CRYPTO_ERROR | - | no | Not possible to decrypt the provided encrypted data |
| INVALID_PAN | - | no | PAN is invalid |
| INVALID_EXPIRY_DATE | Expiry date is invalid |
Unauthorized request, the provided Authorization header is missing or invalid. In the table below only the field "error" is provided.
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| AUTHORIZER_UNAUTHORIZED | Unauthorized message | no | Access token not valid |
Forbidden action detected by WAF or the application. The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| AUTHORIZER_FORBIDDEN | not authorized error message | no | User is not authorized to access this resource |
| CARD_INVALID_STATE | - | no | The card to replace is in invalid state (DELETED, REPLACED) |
| CARD_ALREADY_EXISTS | - | no | The new card referenced by newCardId or new PAN already exists in the solution |
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. The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | yes | No error details available |
| INTERNAL_ERROR | error details if any | no | The server has encountered an error when executing the request. |
The service is temporarily unavailable. You may retry your request later.
POST /banking/v2/issuers/{issuerId}/cards/{cardId}/operations:replace HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"newCardId": "text",
"encryptedData": "text",
"reason": "customer was contacted on June 28",
"stateReason": "CARD_LOST"
}{
"operationId": "text",
"newCardId": "text"
}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 other purpose than logging and troubleshooting.
^[A-Za-z0-9_-]{1,64}$Identifier of the user that requests the operation on D1 API. This value is provided for information purpose, D1 doesn't do any verification based on this identifier.
D1 manages to propagate the information to a subsequent internal system for tracking purpose.
This identifier is not mandatory.
^[A-Za-z0-9_-]{1,15}$Expiry date of the card in MMYY format
1024Pattern: ^(0[1-9]|1[0-2])\d{2}$Expiry date of the card in MMYY format
1024Pattern: ^(0[1-9]|1[0-2])\d{2}$The reason why the action is performed.
This a free text field in case the bank 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
Unique identifier of the operation
^[A-Za-z0-9_-]{1,64}$Bad Request, Invalid request URI, header, paramters. The below table defines the possible 'Bad request' error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| FIELD_INVALID_FORMAT | Contains the field in error (first found) | no | JSON not well formatted or One field is not expected format as defined in this documentation |
| FIELD_INVALID_VALUE | Contains the field in error (first found) | no | One field is |
Unauthorized request, the provided Authorization header is missing or invalid. In the table below only the field "error" is provided.
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| AUTHORIZER_UNAUTHORIZED | Unauthorized message | no | Access token not valid |
Forbidden action detected by WAF or the application. The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | no | No error details available |
| AUTHORIZER_FORBIDDEN | not authorized error message | no | User is not authorized to access this resource |
| CARD_INVALID_STATE | - | no | Renewal with this state reason is not allowed |
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. The below table defines the possible error:
| errorCode | error | Retryable | Comments |
|---|---|---|---|
| - | - | yes | No error details available |
| INTERNAL_ERROR | error details if any | no | The server has encountered an error when executing the request. |
The service is temporarily unavailable. You may retry your request later.
POST /banking/v2/issuers/{issuerId}/cards/{cardId}/operations:renew HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"newExp": "1024",
"newAuxiliaryExp": "1024",
"reason": "customer was contacted on June 28",
"stateReason": "ISSUER_DECISION"
}{
"operationId": "text"
}Última actualización
¿Te fue útil?