Skip to main content
POST
/
v1
/
payouts
curl --request POST \
  --url https://api-sandbox.y.uno/v1/payouts \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "account_id": "YOUR_ACCOUNT_ID",
  "merchant_reference": "payout-001",
  "country": "US",
  "purpose": "PROVIDER_SERVICES",
  "amount": {
    "currency": "USD",
    "value": 10000
  },
  "beneficiary": {
    "merchant_beneficiary_id": "beneficiary-001",
    "national_entity": "INDIVIDUAL",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane.smith@example.com",
    "country": "US",
    "document": {
      "document_type": "DNI",
      "document_number": "987654321"
    }
  },
  "withdrawal_method": {
    "type": "CARD",
    "provider_id": "UNLIMINT"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merchant_reference": "<string>",
  "status": "SUCCEEDED",
  "amount": {
    "currency": "<string>",
    "value": 123
  },
  "created_at": "2023-11-07T05:31:56Z"
}

Headers

​
X-Idempotency-Key
string<uuid>
required

Unique UUID per request. Prevents duplicate processing on retries.

Body

application/json
​
account_id
string<uuid>
required
​
merchant_reference
string
required
Required string length: 3 - 255
​
country
enum<string>
required

ISO 3166-1 alpha-2 country code

Available options:
AR,
BO,
BR,
CL,
CO,
CR,
EC,
SV,
GT,
HN,
MX,
NI,
PA,
PY,
PE,
US,
UY
​
purpose
enum<string>
required
Available options:
FAMILY_AND_FRIENDS,
PERSONAL_TRANSFER,
REMITTANCES,
PROVIDER_SERVICES,
EXPENSES,
REFUND,
SALARY,
PENSION,
LOAN,
DIVIDENDS
​
amount
object
required
​
beneficiary
object
required
​
withdrawal_method
object
required
​
description
string

Response

201 - application/json

Payout created

​
id
string<uuid>
​
merchant_reference
string
​
status
enum<string>
Available options:
SUCCEEDED,
PENDING,
DECLINED,
PROCESSING
​
amount
object
​
created_at
string<date-time>