API Explorer
Aera web
  1. Aera Online Payments API
  2. Payment Lifecycle

Cancel Payment (by pspReference)

post
{baseUrl}/v1//cancel

Cancels (voids) a previously authorized payment, in full or in part. Only possible before the payment has been captured. Recommended method — see POST /v1/cancel for the merchantReference fallback.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique payment identifier returned during session creation.

Body Params

Omit entirely (or send an empty object) for a full cancel.

Omit the body entirely for a full cancel.

string

Required for partial cancel.

amountDetails
object
string

Optional free-text reference for reconciliation/audit. See spec-level note (3) regarding a naming discrepancy in the source docs' example (which used merchantReference for this field).

Headers
string
required

Merchant ID assigned by Aera (13 characters).

uuid
required

Merchant-provided UUID v7, unique per logical operation. Safe retries must reuse the same key; reusing a key with a different body returns an error.

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.payments.v1+json

Updated about 1 month ago

Did this page help you?