v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Create Ledger Transaction Reversal

post/ledger_transactions/{id}/reversal

Path parameters

idstring required

The ID of the ledger transaction.

Request body

descriptionstring

An optional free-form description for the reversal ledger transaction. Maximum of 1000 characters allowed.

statusstring

Status of the reversal ledger transaction. It defaults to posted if not provided.

metadatastring json

Metadata to be added to the reversal ledger transaction. Must be a JSON object.

effective_atstring date-time

The timestamp (ISO8601 format) at which the reversal ledger transaction happened for reporting purposes. It defaults to the effective_at of the original ledger transaction if not provided.

ledgerable_typestring

Specify this if you'd like to link the reversal ledger transaction to a Payment object like Return or Reversal.

ledgerable_idstring

Specify this if you'd like to link the reversal ledger transaction to a Payment object like Return or Reversal.

Response

201

idstring

objectstring

live_modeboolean

external_idstring

{"stackTrail":"paths:/ledger_transactions/{id}/reversal:post:responses:201:content:application/json:schema:properties:ledgerable_type","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/ledger_transactions/{id}/reversal:post:responses:201:content:application/json:schema:properties:ledgerable_id","oasType":"schema","type":"unknown"}

ledger_idstring

{"stackTrail":"paths:/ledger_transactions/{id}/reversal:post:responses:201:content:application/json:schema:properties:description","oasType":"schema","type":"unknown"}

statusstring

reverses_ledger_transaction_idstring

posted_atstring

effective_atstring

effective_datestring

metadataobject

created_atstring

updated_atstring

Example response

{
  "id": "53769ada-5ae4-4184-bb39-a3632daa88f9",
  "object": "ledger_transaction",
  "external_id": "1590aa8d-24e0-491b-bc06-d4e5843a212c",
  "ledger_id": "fe96565f-4b9c-4871-8fb0-e6f02683458e",
  "status": "posted",
  "reverses_ledger_transaction_id": "b3ea66d8-ffa9-44e6-96d2-591cdb998a5e",
  "ledger_entries": [
    {
      "id": "afd72914-6014-46a8-997b-3a862aed6375",
      "object": "ledger_entry",
      "amount": 100,
      "direction": "debit",
      "status": "posted",
      "ledger_account_id": "6168628a-05a6-4d30-80ca-4080ea699179",
      "ledger_account_currency": "USD",
      "ledger_account_currency_exponent": 2,
      "ledger_account_lock_version": 1,
      "ledger_transaction_id": "53769ada-5ae4-4184-bb39-a3632daa88f9",
      "resulting_ledger_account_balances": {
        "pending_balance": {
          "currency": "USD",
          "currency_exponent": 2
        },
        "posted_balance": {
          "currency": "USD",
          "currency_exponent": 2
        },
        "available_balance": {
          "currency": "USD",
          "currency_exponent": 2
        }
      },
      "created_at": "2022-11-01T21:24:45Z",
      "updated_at": "2022-11-01T21:24:45Z"
    }
  ],
  "posted_at": "2022-11-01T21:24:45Z",
  "effective_at": "2022-11-01T00:00:00.000000Z",
  "effective_date": "2022-11-01",
  "created_at": "2022-11-01T21:24:45Z",
  "updated_at": "2022-11-01T21:24:45Z"
}