Skip to main content
POST
/
v1
/
recipients
Create recipient
curl --request POST \
  --url https://api-sandbox.y.uno/v1/recipients \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "merchant_recipient_id": "seller-001",
  "country": "BR",
  "name": "Carlos Oliveira",
  "email": "carlos@example.com",
  "document": {
    "document_type": "CPF",
    "document_number": "98765432100"
  },
  "bank_account": {
    "bank_code": "001",
    "account_number": "12345-6",
    "account_type": "CHECKING"
  }
}
'
{
  "id": "d1e2f3a4-b5c6-7d8e-9f0a-1b2c3d4e5f6a",
  "merchant_recipient_id": "seller-001",
  "country": "BR",
  "name": "Carlos Oliveira",
  "email": "carlos@example.com",
  "document": {
    "document_type": "CPF",
    "document_number": "98765432100"
  },
  "bank_account": {
    "bank_code": "001",
    "account_number": "12345-6",
    "account_type": "CHECKING"
  },
  "created_at": "2026-03-01T09: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
​
merchant_recipient_id
string
required

Your internal recipient identifier

Example:

"seller-001"

​
country
string
required

ISO 3166-1 alpha-2 country code

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

"BR"

​
name
string

Recipient name

Example:

"Carlos Oliveira"

​
email
string<email>
Example:

"carlos@example.com"

​
document
object

Customer's identification document. Both fields are required when the document object is sent. Yuno does not enforce a fixed enum on document_type; pass the local code expected by the destination payment method.

Example:
{
  "document_type": "CPF",
  "document_number": "12345678901"
}
​
bank_account
object

Response

Recipient created successfully

​
id
string<uuid>
Example:

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

​
merchant_recipient_id
string
Example:

"seller-001"

​
country
string
Example:

"BR"

​
name
string
Example:

"Carlos Oliveira"

​
email
string<email>
Example:

"carlos@example.com"

​
document
object

Customer's identification document. Both fields are required when the document object is sent. Yuno does not enforce a fixed enum on document_type; pass the local code expected by the destination payment method.

Example:
{
  "document_type": "CPF",
  "document_number": "12345678901"
}
​
bank_account
object
​
created_at
string<date-time>
Example:

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