Capture Payment

post

{baseUrl}/v1/{pspReference}/capture

Captures funds from a previously authorized payment, in full or in part. Not needed if the session/authorization was created with immediateCapture: true.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

pspReference

uuid

required

Unique payment identifier returned when the checkout session was created.

Body Params

Omit entirely (or send an empty object) to capture the full remaining authorized amount.

Omit the body entirely (or send {}) for a full capture.

merchantId

string

Required for partial capture.

amountDetails

object

reference

string

Optional free-text reference for the operation.

cancelRemainingReservation

boolean

If true, cancels any remaining authorized amount after this capture. Set for the final partial capture. See spec-level note (4).

Headers

merchant-id

string

required

Merchant ID assigned by Aera (13 characters).

idempotency-key

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

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.payments.v1+json

200Capture successful.

defaultError response (NOT documented in the source — inferred shape based on the success-response envelope pattern; please replace with the real error schema and status codes once available).