Retrieve Customer by External ID

GET

customers

merchant-customer-id

{merchant_customer_id}

Get customer by merchant ID

curl --request GET \
  --url https://api-sandbox.y.uno/v1/customers/merchant-customer-id/{merchant_customer_id} \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>'

import requests

url = "https://api-sandbox.y.uno/v1/customers/merchant-customer-id/{merchant_customer_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/customers/merchant-customer-id/{merchant_customer_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/customers/merchant-customer-id/{merchant_customer_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/customers/merchant-customer-id/{merchant_customer_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/customers/merchant-customer-id/{merchant_customer_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/customers/merchant-customer-id/{merchant_customer_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": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
  "merchant_customer_id": "cust-internal-001",
  "merchant_customer_created_at": "2024-01-15T12:34:56.123456Z",
  "first_name": "Maria",
  "last_name": "Silva",
  "email": "maria.silva@example.com",
  "gender": "F",
  "date_of_birth": "1990-02-28",
  "country": "BR",
  "nationality": "BR",
  "document": {
    "document_type": "CPF",
    "document_number": "12345678901"
  },
  "phone": {
    "country_code": "55",
    "number": "11999990000"
  },
  "billing_address": {
    "address_line_1": "Av. Paulista, 1000",
    "address_line_2": "Apto 502",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "zip_code": "01310100",
    "neighborhood": "Bela Vista"
  },
  "shipping_address": {
    "address_line_1": "Av. Paulista, 1000",
    "address_line_2": "Apto 502",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "zip_code": "01310100",
    "neighborhood": "Bela Vista"
  },
  "metadata": [
    {
      "key": "loyalty_tier",
      "value": "gold"
    },
    {
      "key": "signup_source",
      "value": "web"
    }
  ],
  "created_at": "2026-03-01T10:00:00.000000Z",
  "updated_at": "2026-03-01T10:00:00.000000Z"
}

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

Path Parameters

merchant_customer_id

string

required

The merchant-assigned customer identifier

Response

Customer details

Customer object returned by Create, Get, List, and Update endpoints.

string<uuid>

Yuno's unique customer identifier (UUID v4). Use this value when referencing the customer in checkout sessions, payments, enrollments, and subscriptions.

Example:

"c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f"

merchant_customer_id

string

Echoed from the request — your unique identifier for this customer.

Example:

"cust-internal-001"

merchant_customer_created_at

string<date-time> | null

Echoed from the request, or null if not supplied.

Example:

"2024-01-15T12:34:56.123456Z"

first_name

string | null

Example:

"Maria"

last_name

string | null

Example:

"Silva"

string<email> | null

Example:

"maria.silva@example.com"

gender

enum<string> | null

Available options:

M,

F,

NB,

null

Example:

"F"

date_of_birth

string | null

Example:

"1990-02-28"

country

string | null

Example:

"BR"

nationality

string | null

Example:

"BR"

document

object | null

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

phone

object | null

Customer's phone number, split into country calling code and the local number. Both fields are required when the phone object is sent.

Show child attributes

Example:

{
  "country_code": "57",
  "number": "3132450765"
}

billing_address

object | null

Postal address. Used for both billing_address and shipping_address. All fields are optional, but providing as much detail as possible improves authorization rates and downstream fraud-prevention scoring.

Show child attributes

Example:

{
  "address_line_1": "Calle 34 # 56 - 78",
  "address_line_2": "Apartamento 502, Torre I",
  "city": "Bogotá",
  "state": "Cundinamarca",
  "country": "CO",
  "zip_code": "111111",
  "neighborhood": "Chapinero"
}

shipping_address

object | null

Show child attributes

Example:

{
  "address_line_1": "Calle 34 # 56 - 78",
  "address_line_2": "Apartamento 502, Torre I",
  "city": "Bogotá",
  "state": "Cundinamarca",
  "country": "CO",
  "zip_code": "111111",
  "neighborhood": "Chapinero"
}

metadata

object[] | null

Echoed from the request. Returns an empty array (or omitted) when no metadata was provided.

Show child attributes

created_at

string<date-time>

Server-generated ISO 8601 timestamp of when the customer record was created.

Example:

"2026-03-01T10:00:00.000000Z"

updated_at

string<date-time>

Server-generated ISO 8601 timestamp of the last update to the customer record.

Example:

"2026-03-01T10:00:00.000000Z"

Get customer by merchant ID

curl --request GET \
  --url https://api-sandbox.y.uno/v1/customers/merchant-customer-id/{merchant_customer_id} \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>'

import requests

url = "https://api-sandbox.y.uno/v1/customers/merchant-customer-id/{merchant_customer_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/customers/merchant-customer-id/{merchant_customer_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/customers/merchant-customer-id/{merchant_customer_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/customers/merchant-customer-id/{merchant_customer_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/customers/merchant-customer-id/{merchant_customer_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/customers/merchant-customer-id/{merchant_customer_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": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
  "merchant_customer_id": "cust-internal-001",
  "merchant_customer_created_at": "2024-01-15T12:34:56.123456Z",
  "first_name": "Maria",
  "last_name": "Silva",
  "email": "maria.silva@example.com",
  "gender": "F",
  "date_of_birth": "1990-02-28",
  "country": "BR",
  "nationality": "BR",
  "document": {
    "document_type": "CPF",
    "document_number": "12345678901"
  },
  "phone": {
    "country_code": "55",
    "number": "11999990000"
  },
  "billing_address": {
    "address_line_1": "Av. Paulista, 1000",
    "address_line_2": "Apto 502",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "zip_code": "01310100",
    "neighborhood": "Bela Vista"
  },
  "shipping_address": {
    "address_line_1": "Av. Paulista, 1000",
    "address_line_2": "Apto 502",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "zip_code": "01310100",
    "neighborhood": "Bela Vista"
  },
  "metadata": [
    {
      "key": "loyalty_tier",
      "value": "gold"
    },
    {
      "key": "signup_source",
      "value": "web"
    }
  ],
  "created_at": "2026-03-01T10:00:00.000000Z",
  "updated_at": "2026-03-01T10:00:00.000000Z"
}

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

Path Parameters

Response