Paths
/v1/cards/plastic/cvv2/retrieve
To retrieve dynamically generated CVV2 and 2FA using debit or credit card parameters.
This API returns a dynamically generated CVV2 from ECS backend for Credit and S045 for Debit. This API returns also a 2FA (Second Factor of Authentication). This API is Post-login so SCOPE is VISITOR and SID is required which was provided in previous E2EE APIs interaction.
The client ID you received during application registration in the developer portal
Bearer token aquired from APIM token endpoint
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.
Session is generated and returned on the first API call as response header, which needs to be present on succesive calls of the same session.
Content-Types that are acceptable for the response
Language to be send to the backend systems must be 'es' for spanish and 'en' for english
{
"default": "es"
}channel ID used by the user, it is required for the first call in a new session.
Content-Types that are sent in the request
{
"default": "application\/json"
}This request is to retrieve dynamically generated CVV2 and 2FA.
CVV2 and 2FA retrieved successfully
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | cannotDecryptData | 620-Cannot decrypt, please re-check the encrypted value |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| error | productNotAllowed | The card is not allowed to issue CVV2 and 2FA. |
| Type | Code | Details |
| error | backendError | Failed during a call to backend service |
| error | timeoutError | Time to complete a transaction is over |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Definitions
{
"type": "object",
"required": [
"cardType",
"encryptedCardNumber",
"encryptedExpiryDate"
],
"properties": {
"encryptedCardNumber": {
"type": "string",
"description": "Card number for which the CVV2 and 2FA is generated. This value must be encrypted with AES key shared previously using E2E-Encryption API's.",
"example": "1234567890123456"
},
"encryptedExpiryDate": {
"type": "string",
"format": "date",
"description": "The expiration date of the card in format MMYY. This value must be encrypted with AES key shared previously using E2E-Encryption API's.",
"example": "2019-06-22",
"maxLength": 10
},
"cardType": {
"type": "string",
"description": "Identifier that indicate the type of the card: DEBIT for debit card CREDIT for credit card\n",
"default": "CREDIT",
"enum": [
"CREDIT",
"DEBIT"
]
}
}
}
{
"type": "object",
"properties": {
"digitalCvvNumber": {
"type": "string",
"format": "string",
"example": "1234",
"description": "Dynamically generated CVV2. This value will be returned encrypted with previously shared AES key, so once decrypted the max length is 4 digits.",
"maxLength": 4
},
"authenticationFactor": {
"type": "string",
"example": "213515",
"description": "Second factor of authentication. This value will be returned encrypted with previously shared AES key, so once decrypted the max length is 6 digits.",
"maxLength": 6
}
}
}
{
"required": [
"code",
"details",
"location",
"moreInfo",
"timestamp",
"type"
],
"properties": {
"type": {
"type": "string",
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
]
},
"code": {
"type": "string",
"description": "Error code which qualifies the error"
},
"details": {
"type": "string",
"description": "Human readable explanation specific to the occurrence of the problem"
},
"location": {
"type": "string",
"description": "The name of the field that resulted in the error"
},
"moreInfo": {
"type": "string",
"description": "URI to human readable documentation of the error"
},
"timestamp": {
"type": "string",
"description": "Timestamp of the error"
}
}
}