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

Refund Payment

post
{baseUrl}/v1//refund

Refunds funds from a previously captured payment, in full or in part. Refundable amount = captured amount − already-refunded amount.

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

Unique payment identifier returned when the checkout session was created.

Body Params

Omit entirely (or send an empty object) to refund the full available refundable amount.

Omit the body entirely for a full refund of the available refundable amount.

amountDetails
object
string

Optional free-text reference (e.g., return reason).

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?