Reversals

A reversal represents a reversal of a single payment order. In order to reverse an ACH payment, your internal account must support ACH payment origination in the opposite direction. For example, to reverse a credit payment order, your internal account must have debit capabilities.

Related Guides: Reversing an ACH payment

Attribute

Description

id string

Unique identifier for the return.

reason
string

The reason for the reversal.

payment_order_id
string

The ID of the relevant Payment Orders

ledger_transaction_id
string

The ID of the ledger transaction linked to the payment order. See Linking to other Modern Treasury objects .

metadata
object

Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata .

live_mode
boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

{
  "id": "08c251e1-4cba-4706-8faa-9c2df2682aa3",
  "object": "reversal",
  "reason": "duplicate",
  "payment_order_id": "4f898a70-6aeb-41f8-9b98-82e42f54cad8",
  "ledger_transaction_id": nil,
  "metadata": {},
  "live_mode": true,
  "created_at": "2019-11-09T00:11:07Z",
  "updated_at": "2019-11-09T00:11:07Z"
}