curl --request GET \
--url https://api-sandbox.y.uno/v1/recipients/{recipient_id} \
--header 'private-secret-key: <api-key>' \
--header 'public-api-key: <api-key>'import requests
url = "https://api-sandbox.y.uno/v1/recipients/{recipient_id}"
headers = {
"public-api-key": "<api-key>",
"private-secret-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'public-api-key': '<api-key>', 'private-secret-key': '<api-key>'}
};
fetch('https://api-sandbox.y.uno/v1/recipients/{recipient_id}', 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/{recipient_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.y.uno/v1/recipients/{recipient_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("public-api-key", "<api-key>")
req.Header.Add("private-secret-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.y.uno/v1/recipients/{recipient_id}")
.header("public-api-key", "<api-key>")
.header("private-secret-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.y.uno/v1/recipients/{recipient_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "9104911d-5df9-429e-8488-ad41abea1a4b",
"account_id": "9104911d-5df9-429e-8488-ad41abea1a4b",
"merchant_recipient_id": "AAAA01",
"national_entity": "INDIVIDUAL",
"first_name": "John",
"last_name": "Doe",
"legal_name": "Arcos dorados S.A.",
"email": "john.doe@email.com",
"country": "CO",
"document": {
"document_number": "1093333333",
"document_type": "CC"
},
"phone": {
"country_code": "57",
"number": "3132450765"
},
"address": {
"address_line_1": "Calle 34 # 56 - 78",
"address_line_2": "Apartamento 502, Torre I",
"city": "Bogota",
"country": "CO",
"state": "Cundinamarca",
"zip_code": "111111"
},
"withdrawal_methods": [
{
"bank": {
"code": "246",
"branch": "XXXX",
"account": "1093333333",
"account_type": "SAVINGS"
}
}
],
"onboardings": [
{
"type": "PREVIOUSLY_ONBOARDED",
"workflow": "HOSTED_BY_PROVIDER",
"callback_url": "https://www.google.com",
"provider": {
"id": "PAGARME"
}
}
],
"split_configuration": {
"calculation_type": "PERCENTAGE",
"percentage": 10.5,
"rounding_mode": "STANDARD",
"currency": "USD"
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}{
"code": "INVALID_PARAMETERS",
"messages": [
"The query parameter 'account_id' is required."
]
}{
"code": "INVALID_CREDENTIALS",
"messages": [
"Invalid credentials"
]
}{
"code": "AUTHORIZATION_REQUIRED",
"messages": [
"The merchant has no authorization to use this API."
]
}Get Recipient
curl --request GET \
--url https://api-sandbox.y.uno/v1/recipients/{recipient_id} \
--header 'private-secret-key: <api-key>' \
--header 'public-api-key: <api-key>'import requests
url = "https://api-sandbox.y.uno/v1/recipients/{recipient_id}"
headers = {
"public-api-key": "<api-key>",
"private-secret-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'public-api-key': '<api-key>', 'private-secret-key': '<api-key>'}
};
fetch('https://api-sandbox.y.uno/v1/recipients/{recipient_id}', 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/{recipient_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.y.uno/v1/recipients/{recipient_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("public-api-key", "<api-key>")
req.Header.Add("private-secret-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.y.uno/v1/recipients/{recipient_id}")
.header("public-api-key", "<api-key>")
.header("private-secret-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.y.uno/v1/recipients/{recipient_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "9104911d-5df9-429e-8488-ad41abea1a4b",
"account_id": "9104911d-5df9-429e-8488-ad41abea1a4b",
"merchant_recipient_id": "AAAA01",
"national_entity": "INDIVIDUAL",
"first_name": "John",
"last_name": "Doe",
"legal_name": "Arcos dorados S.A.",
"email": "john.doe@email.com",
"country": "CO",
"document": {
"document_number": "1093333333",
"document_type": "CC"
},
"phone": {
"country_code": "57",
"number": "3132450765"
},
"address": {
"address_line_1": "Calle 34 # 56 - 78",
"address_line_2": "Apartamento 502, Torre I",
"city": "Bogota",
"country": "CO",
"state": "Cundinamarca",
"zip_code": "111111"
},
"withdrawal_methods": [
{
"bank": {
"code": "246",
"branch": "XXXX",
"account": "1093333333",
"account_type": "SAVINGS"
}
}
],
"onboardings": [
{
"type": "PREVIOUSLY_ONBOARDED",
"workflow": "HOSTED_BY_PROVIDER",
"callback_url": "https://www.google.com",
"provider": {
"id": "PAGARME"
}
}
],
"split_configuration": {
"calculation_type": "PERCENTAGE",
"percentage": 10.5,
"rounding_mode": "STANDARD",
"currency": "USD"
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}{
"code": "INVALID_PARAMETERS",
"messages": [
"The query parameter 'account_id' is required."
]
}{
"code": "INVALID_CREDENTIALS",
"messages": [
"Invalid credentials"
]
}{
"code": "AUTHORIZATION_REQUIRED",
"messages": [
"The merchant has no authorization to use this API."
]
}Authorizations
Path Parameters
The unique identifier of the recipient
Response
Success Response
The unique identifier of the recipient.
"3aaa4d82-11e8-48ce-8ef5-04eee3a10802"
The account identifier associated with this recipient.
"fe14c7c6-c75e-43b7-bdbe-4c87ad52c482"
Unique identifier of the recipient defined by the merchant.
"MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6"
Beneficiary's national entity type.
"INDIVIDUAL"
Beneficiary's type of organization.
"PRIVATE"
Beneficiary's name.
"Juan"
Beneficiary's last name.
"Perez"
Beneficiary's legal name.
null
The Beneficiary's email.
"juan.perez@example.com"
Beneficiary's date of birth.
"1990-01-15"
The Beneficiary's country.
"CO"
The seller's website URL.
"https://juanperez.com"
The seller's industry.
"Technology"
The merchant category code (MCC) (MAX 235; MIN 1).
"5734"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Rules for automatic split calculation at the recipient level.
Show child attributes
Show child attributes
Recipient creation date (ISO 8601 MAX 27; MIN 27).
"2025-08-27T15:41:19.497413Z"
Last Recipient updated date (ISO 8601 MAX 27; MIN 27).
"2025-08-27T15:41:19.497425Z"
Was this page helpful?