Skip to main content
POST
/
v1
/
payouts
Create payout
curl --request POST \
  --url https://api-sandbox.y.uno/v1/payouts \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "amount": {
    "currency": "BRL",
    "value": 500
  },
  "country": "BR",
  "recipient_id": "d1e2f3a4-b5c6-7d8e-9f0a-1b2c3d4e5f6a",
  "description": "Seller payout - Order #1234",
  "merchant_reference": "payout-ref-001",
  "purpose": "SELLER_PAYMENT"
}
'
{
  "id": "e2f3a4b5-c6d7-8e9f-0a1b-2c3d4e5f6a7b",
  "status": "PENDING",
  "amount": {
    "currency": "BRL",
    "value": 500
  },
  "country": "BR",
  "recipient_id": "d1e2f3a4-b5c6-7d8e-9f0a-1b2c3d4e5f6a",
  "merchant_reference": "payout-ref-001",
  "created_at": "2026-03-01T16:00:00.000Z"
}

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)

Body

application/json
​
amount
object
required
Example:
{ "currency": "BRL", "value": 100 }
​
country
string
required

ISO 3166-1 alpha-2 country code

Pattern: ^[A-Z]{2}$
Example:

"BR"

​
recipient_id
string<uuid>
required

The recipient to send funds to

Example:

"d1e2f3a4-b5c6-7d8e-9f0a-1b2c3d4e5f6a"

​
description
string

Payout description

Example:

"Seller payout - Order #1234"

​
merchant_reference
string

Your internal payout reference

Example:

"payout-ref-001"

​
purpose
string

Purpose of the payout (see Purposes reference list)

Example:

"SELLER_PAYMENT"

Response

Payout created successfully

​
id
string<uuid>
Example:

"e2f3a4b5-c6d7-8e9f-0a1b-2c3d4e5f6a7b"

​
status
enum<string>

Current payout status

Available options:
SUCCEEDED,
PENDING,
FAILED,
CANCELLED
Example:

"PENDING"

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

"BR"

​
recipient_id
string<uuid>
Example:

"d1e2f3a4-b5c6-7d8e-9f0a-1b2c3d4e5f6a"

​
merchant_reference
string
Example:

"payout-ref-001"

​
created_at
string<date-time>
Example:

"2026-03-01T16:00:00.000Z"