Replace or renew card

Request

Path Params

id

string

required

Card id

action

string

required

replace/renew

Header Params

Authorization

string

required

Example:

Bearer {{access_token}}

Content-Type

string

required

Example:

application/json

idempotency-key

string

required

Example:

Body Params application/json

reason

string

required

expiry

string

required

Example

{
    "reason": "string",
    "expiry": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/customers/v1/cards//' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'idempotency-key: {{$string.uuid}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "string",
    "expiry": "string"
}'

Responses

🟢200OK

application/json

Body

A card object representing either a physical or virtual card.

id

string <uuid>

required

The unique identifier of the card.

type

enum<string>

required

The type of card (virtual or physical).

Allowed values:

VIRTUALPHYSICAL

wallet_id

string <uuid>

required

The wallet ID associated with the card.

created_at

string <date-time>

required

The date and time the card was created.

updated_at

string <date-time>

required

The date and time the card was last updated.

status

enum<string>

required

The current status of the card.

Allowed values:

ACTIVEINACTIVESUSPENDEDSTOLENPENDING

external_id

string

required

An external identifier associated with the card.

Example:

1111111

last_four_digit

string

required

The last four digits of the card number.

Example:

1111

expiry

string <date-time>

required

The expiration date of the card.

program_id

string <uuid>

required

The associated card program ID.

m_pan

string

required

The masked primary account number (PAN) of the card.

Example:

1111***1111

Example

{
    "id": "1b8ecc17-4edd-4b74-ae4f-208aeb78f105",
    "type": "PHYSICAL",
    "wallet_id": "7b050dab-889e-5d33-6142-0f7cacb90f2a",
    "created_at": "2025-01-13T17:29:20.127Z",
    "updated_at": "2025-01-13T17:29:20.127Z",
    "status": "SUSPENDED",
    "external_id": "1111111",
    "last_four_digit": "1111",
    "expiry": "2011-10-04T06:36:49.799Z",
    "program_id": "a95b68b6-7bf1-56d6-fbcc-fc235b6b824e",
    "m_pan": "1111***1111"
}