v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Update Ledger Account Settlement

patch/ledger_account_settlements/{id}

Path parameters

idstring required

The ID of the ledger account settlement.

Request body

descriptionstring

Maximum of 1000 characters allowed.

statusstring

To post a pending ledger account settlement, use posted. To archive a pending ledger account settlement, use archived.

metadatastring json

Additional data in the form of key-value pairs. Pairs can be removed by passing an empty string or null as the value.

skip_settlement_ledger_transactionboolean

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

Response

200

idstring

objectstring

live_modeboolean

descriptionstring

payout_ledger_account_idstring

funding_ledger_account_idstring

effective_at_upper_boundstring

statusstring

amountinteger

currencystring

ledger_transaction_idstring

metadataobject

created_atstring

updated_atstring

Example response

{
  "id": "dbdbbfe5-da56-4aaf-be36-3fbc415622dd",
  "object": "ledger_account_payout",
  "live_mode": true,
  "description": "Updated description",
  "payout_ledger_account_id": "d44ad0d0-b3ea-4698-867d-09fe961e52a6",
  "funding_ledger_account_id": "3824af4d-4151-48f6-8e8b-bf859cbddbcd",
  "effective_at_upper_bound": "2023-01-01T00:00:00.000Z",
  "status": "posted",
  "amount": 1000,
  "currency": "USD",
  "ledger_transaction_id": "b47ce462-806b-4d5d-9476-9add11a42529",
  "created_at": "2023-01-11T20:35:36Z",
  "updated_at": "2023-01-11T21:55:33Z"
}