Capture payment

post

https://psp-staging.aerahost.com/uccnp/v1/{pspReference}/capture

Captures an authorized payment, so the money is transferred to you.

Leave out amountDetails to capture the full remaining authorized amount. Send amountDetails to capture part of it, for example when you ship part of an order. You can make several partial captures if the payment method supports it (see splitShipment in Create payment session). On the last partial capture, set cancelRemainingReservation to true to release the rest of the authorized amount.

You don't need to capture payments created with immediateCapture set to true.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

pspReference

string

required

^[0-9A-HJKMNP-TV-Z]{26}$

Aera's unique ID for a payment. Use it to capture, cancel, refund, update or get the status of the payment.

Body Params

The request body for Capture payment.

amountDetails

object

The amount to capture. Leave out to capture the full remaining authorized amount.

reference

string

Your reference for this capture.

cancelRemainingReservation

boolean

Defaults to false

true: Aera cancels the rest of the authorized amount after this capture. Use it on the last partial capture.

Headers

merchant-id

string

required

^[a-zA-Z0-9\-]{1,13}$

Your merchant ID from Aera.

idempotency-key

uuid

required

A unique ID for this request, in UUID v7 format. Use a new key for every new request. If a request fails because of a timeout or network error, send it again with the same key. Aera then doesn't process it twice. It will remember this key for 30 days in the test system and two days in the production system. When a key is found the expected response will be returned.

Responses

200Request processed. responseInfo.responseCode 0 means the capture succeeded.

400Bad request. A required field is missing or a value is invalid. responseInfo.message says which.

401Unauthorized. The API key or access token is missing, invalid or expired.

403Forbidden. Your credentials don't give access to this merchant or this operation.

404Not found. No payment or payment instrument matches the ID in the path.

409Conflict. The operation isn't allowed in the payment's current state, or the idempotency-key was already used for a different request.

429Too many requests. Wait and try again.

500Internal server error. Try again later. If it keeps failing, contact Aera support with responseInfo.cid.