NEnestechops
ledger-card accounts

Withdraw from a card account back to the business's MAIN account.

Changed on
post/ledger/card-accounts/{cardAccountId}/withdraw

Request

Path parameters

cardAccountIdstring uuid required

The unique card account ID

Request body

amountnumber required
clientReferencestring

Optional idempotency key. A retry with the same reference is recognized as the same withdrawal attempt and is not double-processed; omit only for callers that handle their own retry safety.

Response

Withdrawal completed 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

  • 5b7b2c163546Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 1805362fe220Revision changes
    • info

      endpoint added