Skip to main content
POST
Resolve a payment exception

Authorizations

Authorization
string
header
required

Sign in to the admin dashboard and use the resulting ID token for a store and operation you can access. The authenticated dashboard cookie is accepted when the Authorization header is absent. Missing or insufficient access returns 401.

Path Parameters

ulid
string
required
Maximum string length: 128

Body

application/json

Resolve a payment exception. Optional fields cannot be null. Amount, method and reference are unused for adjusted, dismiss and approve_refund.

action
enum<string>
required
Available options:
refund,
approve_refund,
adjusted,
dismiss,
recover
remarks
string

Nonblank after trimming for adjusted, dismiss and recover; otherwise blank is allowed.

Maximum string length: 1000
amount

Up to 15 digits, including two decimal places; numeric strings are also accepted by the backend. Defaults to the unrefunded capture remainder for refund or the entire due NACH amount for recover. A supplied recover amount must equal the full due amount. Not used for a held_refund: its refund is what is left of what the cancel owes.

Required range: 0.01 <= x <= 9999999999999.99Must be a multiple of 0.01
payment_method
string

Open payment method; absent or blank defaults to manual for recover.

Maximum string length: 64
payment_reference_number
string

Absent or blank stores a null reference for recover.

Maximum string length: 128

Response

OK

message
string
required
Example:

"payment exception resolved successfully."

success
boolean
required
content
object
required