Card API

Download D1-Public-OUT-v2-Card.yaml

Notify Card Operations

post

This request is used by D1 to notify the system of the bank about any card status update. There is a retry mechanism in case the notification has not been sent. Thus the bank system can use this notification to synchronize card status with their card repository. The number max of card status update in the notification is defined at onboarding time according to bank's system capability. Each update is linked to a given card id, and can contain a message dedicated for the final end-user.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

issuerIdstring · min: 10 · max: 10Required

The id of the issuer

Header parameters

x-correlation-idstringOptional

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.

There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for other purpose than logging and troubleshooting.

AuthorizationstringOptional

Oauth Access token (optional)

Example: 'Bearer 2zzLJmBAtTNIU8nF8e8XbmDvaNGs'

Body

application/json

Responses

204

Successful

400

Bad Request, Invalid request URI, header, paramters.
D1 will not retry the request until the issue is considered as resolved.

application/json

401

Unauthorized request.
D1 will not retry the request until the issue is considered as resolved.

application/json

403

Forbidden action
D1 will not retry the request until the issue is considered as resolved.

application/json

404

Ressource not found, Unknown issuerId
D1 will not retry the request until the issue is considered as resolved.

application/json

500

Internal Server Error. D1 will retry the request later.

application/json

503

The service is temporarily unavailable. D1 will retry the request later.

post

/notifications/d1/v2/issuers/{issuerId}/cards

HTTPcURLJavaScriptPython

POST /notifications/d1/v2/issuers/{issuerId}/cards HTTP/1.1
Host: YOUR_DOMAIN_NAME
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 453

{
  "operations": [
    {
      "operationId": "text",
      "operation": "RENEW",
      "status": "SUCCESSFUL",
      "startTime": "2022-06-16T06:28:02.492Z",
      "endTime": "2022-06-16T09:28:12.492Z",
      "cardId": "text",
      "details": {
        "cardProductId": "text",
        "cardState": "ACTIVE",
        "reasonState": "CLOSED_ACCOUNT",
        "newCardId": "text",
        "encryptedData": "text"
      },
      "message": {
        "format": "TEXT",
        "title": "Card Suspended",
        "content": "Your card has been suspended."
      },
      "errorCode": "FIELD_INVALID_FORMAT",
      "error": "consumerId"
    }
  ]
}

No content