v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
card-sensitive-details

Set card PIN

Sets a PIN during the card order flow. This endpoint will be accessible for partners that require to set a PIN during the card order flow.

Please follow this guide to use this endpoint.

To use this endpoint, make sure to set the api token and the card order id in the headers.

post/twcard-data/v1/sensitive-card-data/preset-pin

Headers

x-tw-twcard-order-idstring required

The card order ID.

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

keyVersioninteger required

The version of the key to use. It is always set to 1.

encryptedPayloadstring required

Your JWE payload.

Example request

{
  "keyVersion": 1,
  "encryptedPayload": "eyJhbGciOiJSU0..."
}

Response

OK - PIN set successfully.

cardOrderIdstring

The card order ID.

Example response

{
  "cardOrderId": "142"
}