Withdraw from Ledger Account

post

https://api.sandbox.rootvx.com/api/ledger/account/withdraw

This endpoint facilitates the withdrawal of funds from a specified ledger account. It is used to decrease the account balance by the specified amount.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

description

string | null

A brief description of the withdrawal transaction. This can provide context or additional details about the purpose of the withdrawal.

ledgerAccountIdentifier

required

amount

int64

required

≥ 1

The total amount to be withdrawn, specified in the smallest unit of the specified currency.

currency

required

balances

object

The LiveAccountBalance field categorizes the status of an account's balance into three values. PENDING represents a balance that is awaiting confirmation or final processing, POSTED indicates that the balance has been finalized and recorded in the account and AVAILABLE refers to funds that are currently available for use or withdrawal.

Headers

Idempotency-Key

string

required

A unique key to prevent duplicate requests. Typically a UUID.

Responses

201successful

403forbidden

422unsuccessful