Skip to main content
POST
Reverse a payment your organization posted

Authorizations

Authorization
string
header
required

Short-lived access token minted by POST /v1/oauth/token.

Headers

Idempotency-Key
string
required
Required string length: 1 - 255

Path Parameters

payment_id
string
required

Body

application/json

Request body for reversing a payment your organization posted.

reason
string
required

Why the payment is reversed.

Required string length: 1 - 200
is_nsf
boolean
default:false

Reverse as NSF (returned funds).

Response

Successful Response

A payment an organization posted to one of its accounts.

payment_id
string
required

Monterey payment ID.

account_id
string
required

The account the payment was posted to.

amount_cents
integer
required

Payment amount, in integer cents.

payment_method
string
required

How the payment was collected.

check_number
integer | null
required

Check number, when applicable.

status
string
required

pending, posted, pending_confirmation, reversal_pending, reversed or failed.

effective_date
string<date> | null
required

Date the payment applies.

external_reference
string | null
required

Your own reference.

memo
string | null
required

Free-text note.

reference_number
integer | null
required

Reference number of the posted payment.

posted_at
string<date-time> | null
required

When it was posted.

reversal
ReversalOut · object | null
required

Reversal details; null unless the payment was reversed.