Skip to main content
POST
Void letter

Authorizations

Authorization
string
header
default:aro_sk_your_key_here
required

AroPay API key, sent as Authorization: Bearer aro_sk_…. Created in the dashboard under Settings → API keys. Takes precedence over a session cookie when both are present.

Path Parameters

id
string
required

Letter ID.

Body

application/json
acknowledgeMailed
boolean

Required true to void a MAILED letter (stop-payment; the paper letter stops working). Ignored for ESCROWED letters.

Response

The letter as VOIDED, with refund populated.

ok
any
required
data
object
required