Create Recipient

POST

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"
  }
}
'

import requests

url = "https://api-sandbox.y.uno/v1/recipients"

payload = {
    "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"
    }
}
headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'public-api-key': '<api-key>',
    'private-secret-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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'}
  })
};

fetch('https://api-sandbox.y.uno/v1/recipients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/recipients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/recipients"

	payload := strings.NewReader("{\n  \"merchant_recipient_id\": \"seller-001\",\n  \"country\": \"BR\",\n  \"name\": \"Carlos Oliveira\",\n  \"email\": \"carlos@example.com\",\n  \"document\": {\n    \"document_type\": \"CPF\",\n    \"document_number\": \"98765432100\"\n  },\n  \"bank_account\": {\n    \"bank_code\": \"001\",\n    \"account_number\": \"12345-6\",\n    \"account_type\": \"CHECKING\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.y.uno/v1/recipients")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchant_recipient_id\": \"seller-001\",\n  \"country\": \"BR\",\n  \"name\": \"Carlos Oliveira\",\n  \"email\": \"carlos@example.com\",\n  \"document\": {\n    \"document_type\": \"CPF\",\n    \"document_number\": \"98765432100\"\n  },\n  \"bank_account\": {\n    \"bank_code\": \"001\",\n    \"account_number\": \"12345-6\",\n    \"account_type\": \"CHECKING\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/recipients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"merchant_recipient_id\": \"seller-001\",\n  \"country\": \"BR\",\n  \"name\": \"Carlos Oliveira\",\n  \"email\": \"carlos@example.com\",\n  \"document\": {\n    \"document_type\": \"CPF\",\n    \"document_number\": \"98765432100\"\n  },\n  \"bank_account\": {\n    \"bank_code\": \"001\",\n    \"account_number\": \"12345-6\",\n    \"account_type\": \"CHECKING\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "amount must be greater than 0",
    "country must not be blank"
  ]
}

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"

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.

Show child attributes

Example:

{
  "document_type": "CPF",
  "document_number": "12345678901"
}

bank_account

object

Show child attributes

Response

Recipient created successfully

string<uuid>

Example:

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

merchant_recipient_id

string

Example:

"seller-001"

country

string

Example:

"BR"

name

string

Example:

"Carlos Oliveira"

string<email>

Example:

"carlos@example.com"

document

object

Show child attributes

Example:

{
  "document_type": "CPF",
  "document_number": "12345678901"
}

bank_account

object

Show child attributes

created_at

string<date-time>

Example:

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

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"
  }
}
'

import requests

url = "https://api-sandbox.y.uno/v1/recipients"

payload = {
    "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"
    }
}
headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'public-api-key': '<api-key>',
    'private-secret-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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'}
  })
};

fetch('https://api-sandbox.y.uno/v1/recipients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/recipients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/recipients"

	payload := strings.NewReader("{\n  \"merchant_recipient_id\": \"seller-001\",\n  \"country\": \"BR\",\n  \"name\": \"Carlos Oliveira\",\n  \"email\": \"carlos@example.com\",\n  \"document\": {\n    \"document_type\": \"CPF\",\n    \"document_number\": \"98765432100\"\n  },\n  \"bank_account\": {\n    \"bank_code\": \"001\",\n    \"account_number\": \"12345-6\",\n    \"account_type\": \"CHECKING\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.y.uno/v1/recipients")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchant_recipient_id\": \"seller-001\",\n  \"country\": \"BR\",\n  \"name\": \"Carlos Oliveira\",\n  \"email\": \"carlos@example.com\",\n  \"document\": {\n    \"document_type\": \"CPF\",\n    \"document_number\": \"98765432100\"\n  },\n  \"bank_account\": {\n    \"bank_code\": \"001\",\n    \"account_number\": \"12345-6\",\n    \"account_type\": \"CHECKING\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/recipients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"merchant_recipient_id\": \"seller-001\",\n  \"country\": \"BR\",\n  \"name\": \"Carlos Oliveira\",\n  \"email\": \"carlos@example.com\",\n  \"document\": {\n    \"document_type\": \"CPF\",\n    \"document_number\": \"98765432100\"\n  },\n  \"bank_account\": {\n    \"bank_code\": \"001\",\n    \"account_number\": \"12345-6\",\n    \"account_type\": \"CHECKING\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "amount must be greater than 0",
    "country must not be blank"
  ]
}

Getting started

Conventions

Core

Recurring

Hosted

Marketplace

Embedded finance

Operations

Recovery

Reference data

Authorizations

Body

Response