Create Ledger Transaction Reversal

post

https://app.moderntreasury.com/api/ledger_transactions/{id}/reversal

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This API creates a new Ledger Transaction that reverses the original Ledger Transaction.

Note that only posted Ledger Transactions can be reversed. For pending Ledger Transactions, please archive them instead of creating reversals.

Path Params

string

required

The ID of the ledger transaction.

Body Params

description

string

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

status

string

Defaults to posted

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

metadata

json

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

effective_at

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_type

string

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

ledgerable_id

string

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

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

422422