Order card API

Card order

post

/issuers/{issuerId}/physicalCards/{cardId}/operations:production

This API is used by the issuer backend to order a single physical card.

Authorizations

AuthorizationstringRequired

A JWT generated by the get token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Authorization flow for more details about the flow and on how to get this JWT.

Path parameters

issuerIdstring · min: 10 · max: 10Required

The id of the issuer

cardIdstring · min: 1 · max: 48Required

Unique identifier of the card.

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

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.

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.

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

Body

Responses

202

Successful card order

application/json

Operation information.

operationIdstring · min: 1 · max: 64Optional

Unique identifier of the operation

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

400

Bad request due to invalid URI, headers, parameters, or payload.
The below table defines the possible errors: | errorCode | error | Retry Possible | Comments | | -------------- | ------------| ----------| -----------------------------------| | - | - | no | General error with no further information provided. | | FIELD_INVALID_FORMAT | Field in error (first found) | no | A field does not match the expected format specified in the documentation. | | CRYPTO_ERROR | - | no | Decryption of the provided encrypted data failed. | | FIELD_INVALID_VALUE | Field in error (first found) | no | A field value is not permitted for the specified field. | | PARSING_ERROR | Field in error (first found) | no | Encrypted data is not a valid JSON string. |

application/json

401

Unauthorized request due to missing or invalid access token.

errorCode	error	Retry Possible	Comments
-	-	no	General error with no further information provided.
AUTHORIZER_UNAUTHORIZED	Unauthorized message	no	Access token not valid

application/json

403

Request forbidden by authorization rules or business constraints.
The below table defines the possible error:

errorCode	error	Retry Possible	Comments
-	-	no	General error with no further information provided.
AUTHORIZER_FORBIDDEN	not_authorized error message	no	The user is not authorized to access the requested resource.
OPERATION_NOT_ALLOWED	Name of the operation/field that is not allowed in this operation	no	The specified operation or field is not permitted for this card product.

application/json

404

Requested resource not found.

application/json

500

Internal server error while processing the request. The below table defines the possible error:

errorCode	error	Retry Possible	Comments
-	-	no	General error with no further information provided.
INTERNAL_ERROR	Error details (if any)	no	The server encountered an issue while processing the request.

application/json

503

The service is temporarily unavailable. You may retry your request later.

post/issuers/{issuerId}/physicalCards/{cardId}/operations:production

POST /banking/v1/issuers/{issuerId}/physicalCards/{cardId}/operations:production HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 659

{
  "distributionChannel": "THALES",
  "consumerId": "consumer_12345",
  "cardProductId": "debit_card_v1",
  "issuerRequestId": "req-001",
  "services": {
    "issuance": "RENEWAL",
    "priority": "P1",
    "delivery": "EXPRESS",
    "packaging": "GOLD_PACK",
    "cardCarrier": "NO_CARRIER",
    "pinMailer": true
  },
  "cardDesign": {
    "cardImage": "myCard_ref"
  },
  "encryptedData": "eyJhbGciOiJ...",
  "paymentApplication": {
    "config": "config_a",
    "odaKeyIndex": 1,
    "derivationKeyIndex": 1
  },
  "cardCarrierConfig": {
    "language": "EN"
  },
  "packagingConfig": {
    "inserts": [
      "promo"
    ]
  },
  "shipment": {
    "type": "INDIVIDUAL",
    "deliveryAddress": {
      "firstName": "John",
      "lastName": "Smith",
      "line1": "1 Main Street",
      "zipCode": 75001,
      "city": "Paris",
      "countryCode": "FR"
    }
  }
}

{
  "operationId": "text"
}

encrypted cardData

Get card order status

get

/issuers/{issuerId}/physicalCards/{cardId}/productionStatus

This API is used by the issuer backend to get the card order status.

Authorizations

AuthorizationstringRequired

Path parameters

issuerIdstring · min: 10 · max: 10Required

The id of the issuer

cardIdstring · min: 1 · max: 48Required

Unique identifier of the card.

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

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.

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.

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

Responses

200

Success

application/json

The card production status and information

statusstring · enumRequired

The current status of card production.

Example: CARD_SHIPPEDPossible values:

reasonstringOptional

Additional details in case of exception during data processing or card production

consumerIdstringOptional

The id of the end user.

Example: 271b-6e47-8ec3-7f3f

issuerRequestIdstring · min: 1 · max: 64Optional

The unique identifier provided by issuer to identify the card production request

Example: 01c5a05e-e197-11ec-8fea-0242ac120002

dueDatestring · dateOptional

The estimated card production date. It is in the format YYYY-MM-DD.

Example: 2023-01-21

productionRequestDatestring · date-timeOptional

The date and time of the card production request. It is in the format YYYY-MM-DDThh:mm:ssZ for the timezone GMT+0.

Example: 2023-01-03T17:12:34Z

productionDatestring · date-timeOptional

The date the card was produced. It is in the format YYYY-MM-DDThh:mm:ssZ for the timezone GMT+0.

Example: 2023-01-20T17:32:28Z

productionSitestring · max: 50Optional

The factory where the card is produced.

Example: Gemenos

namestring · max: 50Optional

The card holder name printed on the card.

Example: MR. JOHN SMITH

maskedPanstring · min: 12 · max: 19Optional

The masked PAN value (Primary Account Number).

Example: 123456xxxxxx7890Pattern: ^[0-9xX\*]{12,19}$

orderIdstringOptional

The unique identifier of order used for card production.

Example: 9b95d70e-21fe-4c36-9368-ddd7fbd729e8Pattern: ^[A-Za-z0-9_-]{1,64}$

packageIdstringOptional

The unique identifier of the package used for card production.

Example: be0b085c-ef03-4581-9e7b-50dbb2f08f43Pattern: ^[A-Za-z0-9_-]{1,64}$

inputFileNamestring · min: 1 · max: 256Optional

Name of the input file in case of hybrid mode.

Example: myInputFile_20240707.gz

400

Malformed request

application/json

401

The provided Authorization header is missing or invalid

application/json

403

Forbidden action, check the state of the linked end user (consumer) or account or card

application/json

404

Resource not found, Unknown issuerId or consumerId or accountId or card id

application/json

500

Internal Server Error

application/json

get/issuers/{issuerId}/physicalCards/{cardId}/productionStatus

GET /banking/v1/issuers/{issuerId}/physicalCards/{cardId}/productionStatus HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "CARD_SHIPPED",
  "reason": "",
  "consumerId": "271b-6e47-8ec3-7f3f",
  "issuerRequestId": "01c5a05e-e197-11ec-8fea-0242ac120002",
  "dueDate": "2023-01-21",
  "productionRequestDate": "2023-01-03T17:12:34Z",
  "productionDate": "2023-01-20T17:32:28Z",
  "productionSite": "Gemenos",
  "name": "MR. JOHN SMITH",
  "maskedPan": "123456xxxxxx7890",
  "orderId": "9b95d70e-21fe-4c36-9368-ddd7fbd729e8",
  "packageId": "be0b085c-ef03-4581-9e7b-50dbb2f08f43",
  "shipment": {
    "pickupDate": "2023-01-21T17:32:28Z",
    "carrier": "fedex",
    "trackingNumber": "61293150000079650811",
    "status": "DELIVERED",
    "message": "Picked up by the customer",
    "trackingUrl": "https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650811&cntry_code=US",
    "redirectUrl": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650811&cntry_code=US",
    "estimatedDeliveryDate": "2023-01-21T17:32:28Z",
    "lastUpdatedAt": "2023-01-21T17:32:28Z",
    "deliveryDate": "2023-01-21T17:32:28Z",
    "signedBy": "Steve Young",
    "failedDeliveryAttempts": "2",
    "lastCheckpoint": {
      "checkpointTime": "2023-01-21T17:32:28Z",
      "city": "New York",
      "countryName": "United States",
      "message": "Package delivered"
    }
  },
  "services": {
    "cardProductId": "text",
    "issuance": "RENEWAL",
    "priority": "P1",
    "delivery": "DHL",
    "packaging": "welcome_pack_red",
    "cardCarrier": "NO_CARRIER"
  },
  "inputFileName": "myInputFile_20240707.gz",
  "cardPackageDetails": {
    "plastic": "CardRef1",
    "artworkId": "CardRef1",
    "cardCarrier": "17609320 Carrier A4 white 100g Thales",
    "envelope": "ENV BLANCHE 115X229mm FEN 45X100X2520 CART1000",
    "package": "text",
    "cardActivationLabel": "text",
    "inserts": [
      "text"
    ]
  },
  "deliveryAddress": {
    "companyName": "Thales",
    "line1": "Street #1",
    "line2": "Street #2",
    "line3": "Street #3",
    "city": "London",
    "state": "text",
    "zipCode": "WC2N 5DU",
    "countryCode": "GB"
  }
}

PreviousOAuth2 API

NextOrder cards API

Last updated 2 months ago

Was this helpful?