Update a card by ID

put

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/cards/{cardId}

Updates card attributes including status, PIN, PIN retry count, and spending rules. PIN changes require the caller to be PCI compliant or to supply a valid Card Access Password (CAP).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

cardId

int64

required

Body Params

All things that can be updated on a card. Used for PUT to change a card's behaviour

cap

string

Optional,The card access password of the customer. Required if no JWT is provided and want to update card.

cardHolderName

string

Allows the update of cardholder name associated with the card

cardRules

object

Optional. If passed then any non null rules will be set on the card

lifeCycleStatus

string

enum

Optional: The lifecycle status of the card can only be ACTIVE or INACTIVE e.g. On Pn the card can be on status ACTIVE with hold response code RESTRICTED

Allowed:

limitConfiguration

array of objects

limitConfiguration

string

length between 4 and 4

The initial or updated PIN to set on the card. Dont pass this parameter to leave PIN as-is

pinBlock

string

length between 1 and 32

Optional. The PINBlock encrypted under Terminal PIN Key (TPK). The PINBlock would be translated to ZPK Encryption for transportation

pinBlockFormat

string

enum

Optional. The PINBlock format for the PINBlock encrypted under TPK

Allowed:

pinRetryCounter

int32

Pass as 0 to reset the incorrect pin retry counter to 0. Any other value is ignored

programName

string

Allows the update of card program name associated with the card

reason

string

enum

If changed the status of card than must need to specify the reason

sovName

string

Allows the update of sov name for cards migrated to Eclipse as SOV

status

string

enum

Optional. If passed then the status will be changed. For detailed status change rules refer to the API spec documentation

syncWithRemote

boolean

Optionally disable syncing card with remote by default its synced

userId

int64

Allows the update of userId associated with the card

virtualCardIdentifier

object

If it is provided then it must be an identifier for an unused virtual card

Responses

400

Bad Request

200OK

404Card not found

500Internal Server Error