API de Click to Pay
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}$The card holder name as present on the card. It is applicable only to Visa.
John SmithPattern: ^[\p{L}\p{N}\u0600-\u06FF ,.'_#;:\/-]{1,26}$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 enrolment to Click to Pay has been taken into account.
Operation result information.
Unique identifier of the operation
^[A-Za-z0-9_-]{1,64}$Status of the operation
Bad Request, Invalid request URI, header, paramters. The below table defines the possible 'Bad request' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| FIELD_INVALID_FORMAT | no | At least one field is not in 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. The below table defines the possible 'Forbidden' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| CARD_INVALID_STATE | no | We cannot enrol an inactive card |
| OPERATION_NOT_ALLOWED | no | Only Visa and Mastercard cards are supported |
Not Found. The below table defines the possible 'Not Found' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| UNKNOWN_CARD | no | Unknown card |
Internal Server Error. The below table defines the possible 'Internal Server Error' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | yes | No error details available |
| WRONG_CONFIGURATION | no | At least one configuration is missing |
| INTERNAL_ERROR | no | - |
| SCHEME_ERROR | no | An error occured while trying to contact the scheme |
| SCHEME_CARD_INELIGIBLE | no | Reason could be that the card is not eligible to tokenization, not configured on scheme side, or that it is expired, or inactive or... |
| SCHEME_AMBIGUOUS_PROFILE | no | A profile already exist but email or phonenumber does not match with already existing record |
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 consumer.
^[A-Za-z0-9_-]{1,64}$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}$Profile retrieved.
Optional string message. In case issuer is using both schemes and one of the two is returning an error, we will send back partial answer in the clickToPayProfiles array, and in this message we will giving more details on the received error. This field is for troubleshooting purposes only, it can change at any time so MUST NOT be parsed, and is not supposed to be human readable so CANNOT be displayed to end users.
Bad Request, Invalid request URI, header, paramters. The below table defines the possible 'Bad request' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| FIELD_INVALID_FORMAT | no | At least one field is not in 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 |
Not Found. The below table defines the possible 'Not Found' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| UNKNOWN_CONSUMER | no | Unknown end user (consumer) |
Internal Server Error. The below table defines the possible 'Internal Server Error' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | yes | No error details available |
| WRONG_CONFIGURATION | no | At least one configuration is missing |
| INTERNAL_ERROR | no | - |
| SCHEME_ERROR | no | An error occured while trying to contact the scheme |
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}$The card holder name as present on the card. It is applicable only to Visa.
John SmithPattern: ^[\p{L}\p{N}\u0600-\u06FF ,.'_#;:\/-]{1,26}$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 information update has been taken into account.
Operation result information.
Unique identifier of the operation
^[A-Za-z0-9_-]{1,64}$Status of the operation
Bad Request, Invalid request URI, header, paramters. The below table defines the possible 'Bad request' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| FIELD_INVALID_FORMAT | no | At least one field is not in 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. The below table defines the possible 'Forbidden' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| OPERATION_NOT_ALLOWED | no | Only Visa and Mastercard cards are supported |
Not found. The below table defines the possible 'Not found' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| UNKNOWN_CARD | no | The card does not exist in D1 |
| SCHEME_ERROR | no | The card does not exist in Click to Pay |
Internal Server Error. The below table defines the possible 'Internal Server Error' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | yes | No error details available |
| WRONG_CONFIGURATION | no | At least one configuration is missing |
| INTERNAL_ERROR | no | - |
| SCHEME_ERROR | no | An error occured while trying to contact the scheme |
Click to Pay update consumer
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 consumer.
^[A-Za-z0-9_-]{1,64}$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}$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.
End user (consumer) information update has been taken into account.
Operation result information.
Unique identifier of the operation
^[A-Za-z0-9_-]{1,64}$Status of the operation
Bad Request, Invalid request URI, header, paramters. The below table defines the possible 'Bad request' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| FIELD_INVALID_FORMAT | no | At least one field is not in 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. The below table defines the possible 'Forbidden' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| OPERATION_NOT_ALLOWED | no | Only Visa and Mastercard cards are supported |
Not Found. The below table defines the possible 'Not Found' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| UNKNOWN_CONSUMER | no | The end user (consumer) does not exist in D1 |
| SCHEME_ERROR | no | The end user (consumer) does not exist in Click to Pay |
Internal Server Error. The below table defines the possible 'Internal Server Error' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | yes | No error details available |
| WRONG_CONFIGURATION | no | At least one configuration is missing |
| INTERNAL_ERROR | no | - |
| SCHEME_ERROR | no | An error occured while trying to contact the scheme |
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}$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 opt-out from Click to Pay has been taken into account.
Operation result information.
Unique identifier of the operation
^[A-Za-z0-9_-]{1,64}$Status of the operation
Bad Request, Invalid request URI, header, paramters. The below table defines the possible 'Bad request' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| FIELD_INVALID_FORMAT | no | At least one field is not in 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. The below table defines the possible 'Forbidden' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| OPERATION_NOT_ALLOWED | no | Only Visa and Mastercard cards are supported |
Not Found. The below table defines the possible 'Not Found' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| UNKNOWN_CARD | no | Unknown card |
Internal Server Error. The below table defines the possible 'Internal Server Error' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | yes | No error details available |
| WRONG_CONFIGURATION | no | At least one configuration is missing |
| INTERNAL_ERROR | no | - |
| SCHEME_ERROR | no | An error occured while trying to contact the scheme |
Click to Pay opt-out consumer
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 consumer.
^[A-Za-z0-9_-]{1,64}$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}$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.
Consumer opt-out from Click to Pay has been taken into account. The opt-out can be PENDING or SUCCESSFUL.
In Case of SUCCESSFUL it can mean that:
- the operation is already finished and success,
- the operation was already done, the consumer was already opted-out,
- the operation was not needed as the consumer was never enrolled to Click to Pay.
Operation result information.
Unique identifier of the operation
^[A-Za-z0-9_-]{1,64}$Status of the operation
Bad Request, Invalid request URI, header, paramters. The below table defines the possible 'Bad request' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| FIELD_INVALID_FORMAT | no | At least one field is not in 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 |
Not Found. The below table defines the possible 'Not Found' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | no | No error details available |
| UNKNOWN_CONSUMER | no | Unknown consumer, when the consumer does not exist in D1 solution |
Internal Server Error. The below table defines the possible 'Internal Server Error' error:
| errorCode | Retryable | Comments |
|---|---|---|
| - | yes | No error details available |
| WRONG_CONFIGURATION | no | At least one configuration is missing |
| INTERNAL_ERROR | no | - |
| SCHEME_ERROR | no | An error occured while trying to contact the scheme |
Última actualización
¿Te fue útil?