API Reference

Create a Ledger Account Payout

post
https://api.sandbox.rootvx.com/api/ledger/payment/create

This endpoint facilitates making payments from one ledger account to another within the system.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

A brief description of the ledger account payment.

string
enum

Specifies the type of payment.

Allowed:
uuid

The ID of the ledger account receiving the funds.

uuid

The ID of the ledger account sending the funds.

uuid
required

The id of the ledger that this ledger account payment belongs to.

int64
required

The amount of the payment in the smallest currency unit.

string | null

Optional remarks for the payment.

string
enum

One of credit, debit. Describes the direction money is flowing in the transaction. A credit moves money from your account to someone else's. A debit pulls money from someone else's account to your own.

Allowed:
string
enum

Specifies the priority of the payment, either normal or high.

Allowed:
string | null

The purpose of the payment.

Headers
string
required

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

Responses

Updated 11 months ago

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

Updated 11 months ago