Digital card API

Notify Digital Card Operation

post

This request is used by D1 to notify the issuer's backend about all operations done on a digital card.

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

digitalCardIdstring · min: 1 · max: 64Required

The id of the digital card

Pattern: ^[A-Za-z0-9_-]{1,64}$

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.

Body

application/json

The following objects represent the notify digital card request body

operationIdstring · min: 1 · max: 64Optional

Unique identifier of the operation

Pattern: ^[A-Za-z0-9_-]{1,64}$

operationstring · enumOptional

The lifecycle operation name performed on the target digital card.
A digital card can be activated(i.e. resumed), suspended, deleted from the wallet application or CCI portal; it can also be renewed when expired by the TSP and updated after a card update/renewal operation (concerning a PAN and/or expiry date update).

Possible values:

statusstring · enumOptional

Status of the operation

Possible values:

Responses

204

Successful

No content

400

Bad Request, Invalid request URI or header, or unsupported nonstandard parameter

application/json

401

The provided Authorization header is missing or invalid

404

Resource not found. Unknown issuerId or consumerId or accountId or cardId

application/json

500

Internal Server Error

application/json

post/issuers/{issuerId}/digitalCards/{digitalCardId}/notifications

HTTPcURLJavaScriptPython

POST /notifications/d1/v1/issuers/{issuerId}/digitalCards/{digitalCardId}/notifications HTTP/1.1
Host: YOUR_DOMAIN_NAME
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "operationId": "text",
  "operation": "SUSPEND",
  "status": "SUCCESSFUL"
}

No content