Topup or withdrawal a ledger account balance

Topup or withdraw a ledger account balance.

Considerations:

  1. This endpoint could be only used for accounts with type subaccount.
  2. The accounts should be active.
  3. The associated account holder should also be active.
  4. You can only make operations if the currency code of the amount is the same as the currency code of the account.
Path Params
string
required

Account ID (Base 62 format)

Body Params

Attributes to topup/withdraw an account balance

amount
object
required

Money schema

string | null

String field

string
required

Unique identifier of the update balance operation

metadata
object | null
string
enum
required

Operation type to perform an update balance, it can be one of the following options:

  • topup: Increment the account balance.
  • withdrawal: Decrease the account balance.
Allowed:
string | null

String field

Headers
uuid

Idempotency key in UUID format

Responses

Callback
Language
Credentials
Bearer
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json