NEnestechops
ledger-card accounts

Rename a card account's display name.

Changed on

Replaces the card's label. Purely local ledger metadata - never sent to the card provider - so it can be changed regardless of the card's lifecycle status (including PENDING_KYC, FROZEN, CREATION_FAILED, etc.), unlike the money-movement/state-transition endpoints below which require an ACTIVE card.

put/ledger/card-accounts/{cardAccountId}/display-name

Request

Path parameters

cardAccountIdstring uuid required

The unique card account ID

Request body

displayNamestring required

The new label for the card.

Response

Card account display name updated successfully

idstring uuid required

Unique card account ID.

accountIdstring uuid required

The MAIN account this card is funded from.

currencystring required
status'PENDING_KYC' | 'PENDING_PROVISIONING' | 'ACTIVE' | 'FROZEN' | 'TERMINATED' | 'KYC_REJECTED' | 'CREATION_FAILED' required

Lifecycle of a card account. PENDING_KYC and PENDING_PROVISIONING are transient - a card only starts moving money once it reaches ACTIVE. KYC_REJECTED and CREATION_FAILED are terminal with no funds ever moved (the dedicated ledger account is only created once KYC is approved).

balancenumber required

The card's live spendable balance.

failureReasonstring

Populated when status is KYC_REJECTED or CREATION_FAILED.

createdDatestring date-time required

Example response

{
  "currency": "USD"
}

Changes