Skip to main content
POST
Replace Card

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-idempotency-key
string

Idempotency key of the request.

x-audit-user
string

Optional audit user header

Path Parameters

id
string<uuid>
required

Unique identifier of the card to be replaced.

Body

application/json
description
string

Description of why the card should be replaced.

Example:

"The cardholder’s wallet was stolen, so the card must be replaced."

pinStatus
enum<string>
  • GENERATED - A pin should be randomly generated for the card.
  • WAITING - A pin is waiting to be set on the card.
Available options:
GENERATED,
WAITING
Example:

"GENERATED"

Response

Successful replacement of card

description
string

A description of the response returned.

id
string<uuid>

A unique identifier assigned to identify the endpoint request.

Example:

"20218aae-b15e-406c-9e9f-23735cd86a48"