Skip to main content
POST
/
v1
/
payments
/
{payment_id}
/
transactions
/
{transaction_id}
/
capture
Capture authorization
curl --request POST \
  --url https://api-sandbox.y.uno/v1/payments/{payment_id}/transactions/{transaction_id}/capture \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "amount": {
    "currency": "BRL",
    "value": 150
  }
}
'
{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "SUCCEEDED",
  "amount": {
    "currency": "BRL",
    "value": 150
  }
}
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.

Authorizations

​
public-api-key
string
header
required

Your public API key from the Yuno Dashboard

​
private-secret-key
string
header
required

Your private secret key (server-side only)

Path Parameters

​
payment_id
string<uuid>
required

The unique identifier of the payment

​
transaction_id
string<uuid>
required

The transaction ID from the authorization response

Body

application/json
​
amount
object

Optional partial capture amount. If omitted, captures the full authorized amount.

Example:
{ "currency": "BRL", "value": 100 }

Response

Payment captured successfully

​
id
string<uuid>

Unique payment identifier

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
checkout_session
string<uuid>
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
status
enum<string>

Current payment status

Available options:
SUCCEEDED,
PENDING,
DECLINED,
REJECTED,
CANCELLED,
REFUNDED,
PARTIALLY_REFUNDED,
AUTHORIZED
Example:

"SUCCEEDED"

​
amount
object
Example:
{ "currency": "BRL", "value": 100 }
​
country
string
Example:

"BR"

​
payment_method
object
​
provider
object
​
merchant_order_id
string
Example:

"order-20260301-001"

​
created_at
string<date-time>
Example:

"2026-03-01T14:31:00.000Z"

​
updated_at
string<date-time>
Example:

"2026-03-01T14:31:02.000Z"

​
transactions
object[]

Individual processing attempts for this payment

​
refunds
object[]

Refund records associated with this payment

​
three_ds
object

3DS authentication details, present for card payments

​
metadata
object

Custom key-value pairs set by the merchant

​
failure_reason
object

Decline details when status is DECLINED or REJECTED

​
customer_id
string<uuid>

ID of the associated customer record

​
installments
object

Installment details if payment was split into installments