ApplePay API
home
ApplePay API
Base URLS:
Description:
These APIs are used to trigger the Deliver OTP, Verification and Notification APIs in CMS when a customer wants to verify a card through VISA or notify about card or get consumer information on card or digital card or need a OTP. APIs are exposed to Thales(D1) using REST protocol. The following are the operations available for Thales to consume:
- Verify Card
- Notify Card
- Notify Digital Card
- Deliver OTP
- Get Consumer Information
- Get Card Credentials
High Level Architecture
Flowchart
Technical Specifications
Headers:
Below are the headers that are set with every HTTP Request from D1 towards Mule API.
Header Name | Sample Value | Optional? |
---|---|---|
x-correlation-id | 9712801dbaaffg90d43a0b09c59fdaf21e65524235436 | Mandatory |
Request Body: Please refer the corresponding pages for specific request body.
Error handling
Backend Error Handling.
Http error codes are mapped in Mule based on the business error code received from CMS
HTTP Status
The HTTP error codes that are specified by D1 are as follows:
400 - Bad Request: An error in the client request (Mostly due to validations)
401 - Unauthorized: User can't be authenticated
403 - Forbidden: The server cannot give access to the resource
404 - Not Found: The resource defined in the URL doesn't exist
405 - Method Not Allowed
415 - UnsupportedMediaType
500 - Internal Server Error: The server encountered an unexpected condition
Error Response
A REST API responds with an error code and a message to be shown to the calling system. Error response will be in JSON format towards both CMS and D1.
For few endpoints, error response body is not applicable.
Reference : https://thales-dis-dbp.stoplight.io/docs/d1-api-public/3afa6f17f8548-main-d-1-api
Mulesoft error towards D1 (Sample):
{
"error": "Card does not exist"
}
API Policies:
Name | Description | Example |
---|---|---|
Rate limiting | Limits no.of request | 200 requests per minute |