Create Ledger Account Settlement

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

It is set to pending by default. To post a ledger account settlement at creation, use posted. To have the ability to manually attach ledger entries to the settlement use drafting.

string
required

The ledger account whose ledger entries are queried against, and its balance is reduced as a result.

string
required

The ledger account that sends to or receives funds from the settled ledger account.

date

The maximum effective_at timestamp of the ledger entries to be included in the ledger account settlement. The default value is the created_at timestamp of the ledger account settlement.

boolean
Defaults to false

If true, the settlement amount and settlement_entry_direction will bring the settled ledger account’s balance closer to zero, even if the balance is negative.

json

Metadata to be added to the ledger account settlement. Must be a JSON object.

boolean
Defaults to false

It is set to false by default. It should be set to true when migrating existing settlements.

Responses

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