Capture Authorization

post

https://api-sandbox.y.uno/v1/payments/{payment_id}/transactions/{transaction_id}/capture

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

⚠️
Do not execute a capture while another is in progress. Wait for the current operation to complete before starting a new one.

This request captures a payment that was previously authorized. This action is required to finalize a payment when an authorization was created with the capture option set false. Depending on the payment provider, the capture could be partial (including multiple captures) or total.

Note that this request requires an X-Idempotency-Key. Check the Authentication page for more information.

Path Params

payment_id

string

required

The unique identifier of the payment (UUID, 36 chars).

transaction_id

string

required

The unique identifier of the transaction (UUID, 36 chars)

Body Params

merchant_reference

string

required

Identification of the payment transaction defined by the merchant (MAX 255; MIN 3)

amount

object

required

Specifies the amount object for capturing.

reason

string

required

Indicating the reason for the capture. For example: PRODUCT_CONFIRMED and REQUESTED_BY_CUSTOMER.

additional_data

object

Additional data to complement the payment capture

simplified_mode

boolean

Determines whether Yuno should automatically attempt to capture a payment after an initial error or decline. When set to true, Yuno will retry the process if the first attempt fails. By default, this is set to false. Access Transaction Retries for more details.

Responses

200200

400400

401401

403403