Enroll Payment Method

POST

customers

{customer_id}

payment-methods

Enroll payment method

curl --request POST \
  --url https://api-sandbox.y.uno/v1/customers/{customer_id}/payment-methods \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "type": "CARD",
  "token": "tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678",
  "country": "BR"
}
'

import requests

url = "https://api-sandbox.y.uno/v1/customers/{customer_id}/payment-methods"

payload = {
    "type": "CARD",
    "token": "tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678",
    "country": "BR"
}
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({type: 'CARD', token: 'tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678', country: 'BR'})
};

fetch('https://api-sandbox.y.uno/v1/customers/{customer_id}/payment-methods', 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/{customer_id}/payment-methods",
  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([
    'type' => 'CARD',
    'token' => 'tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678',
    'country' => 'BR'
  ]),
  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/customers/{customer_id}/payment-methods"

	payload := strings.NewReader("{\n  \"type\": \"CARD\",\n  \"token\": \"tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678\",\n  \"country\": \"BR\"\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/customers/{customer_id}/payment-methods")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"CARD\",\n  \"token\": \"tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678\",\n  \"country\": \"BR\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/customers/{customer_id}/payment-methods")

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  \"type\": \"CARD\",\n  \"token\": \"tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678\",\n  \"country\": \"BR\"\n}"

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

{
  "id": "pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  "customer_id": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
  "type": "CARD",
  "status": "ACTIVE",
  "card": {
    "last_four": "4242",
    "brand": "VISA",
    "expiry_month": 12,
    "expiry_year": 2028
  },
  "vaulted_token": "vtok_9f8e7d6c-5b4a-3210-fedc-ba9876543210",
  "created_at": "2026-03-01T10:00:00.000Z"
}

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

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

Vaults a payment method for a customer. Returns a vaulted_token for recurring use.

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

customer_id

string<uuid>

required

The unique identifier of the customer

Body

application/json

type

enum<string>

required

Payment method type

Available options:

CARD,

PIX,

BOLETO,

PSE,

SPEI,

OXXO

Example:

"CARD"

token

string

required

One-time token from SDK tokenization

Example:

"tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678"

country

string

ISO 3166-1 alpha-2 country code

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

Example:

"BR"

Response

Payment method enrolled successfully

string<uuid>

Example:

"pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890"

customer_id

string<uuid>

Example:

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

type

enum<string>

Available options:

CARD,

PIX,

BOLETO,

PSE,

SPEI,

OXXO

Example:

"CARD"

status

enum<string>

Available options:

ACTIVE,

EXPIRED,

REVOKED

Example:

"ACTIVE"

card

object

Show child attributes

vaulted_token

string

Token for reuse in future payments

Example:

"vtok_9f8e7d6c-5b4a-3210-fedc-ba9876543210"

created_at

string<date-time>

Example:

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

Enroll payment method

curl --request POST \
  --url https://api-sandbox.y.uno/v1/customers/{customer_id}/payment-methods \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "type": "CARD",
  "token": "tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678",
  "country": "BR"
}
'

import requests

url = "https://api-sandbox.y.uno/v1/customers/{customer_id}/payment-methods"

payload = {
    "type": "CARD",
    "token": "tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678",
    "country": "BR"
}
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({type: 'CARD', token: 'tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678', country: 'BR'})
};

fetch('https://api-sandbox.y.uno/v1/customers/{customer_id}/payment-methods', 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/{customer_id}/payment-methods",
  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([
    'type' => 'CARD',
    'token' => 'tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678',
    'country' => 'BR'
  ]),
  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/customers/{customer_id}/payment-methods"

	payload := strings.NewReader("{\n  \"type\": \"CARD\",\n  \"token\": \"tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678\",\n  \"country\": \"BR\"\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/customers/{customer_id}/payment-methods")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"CARD\",\n  \"token\": \"tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678\",\n  \"country\": \"BR\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/customers/{customer_id}/payment-methods")

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  \"type\": \"CARD\",\n  \"token\": \"tok_4a8b9c2d-1e3f-5678-90ab-cdef12345678\",\n  \"country\": \"BR\"\n}"

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

{
  "id": "pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  "customer_id": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
  "type": "CARD",
  "status": "ACTIVE",
  "card": {
    "last_four": "4242",
    "brand": "VISA",
    "expiry_month": 12,
    "expiry_year": 2028
  },
  "vaulted_token": "vtok_9f8e7d6c-5b4a-3210-fedc-ba9876543210",
  "created_at": "2026-03-01T10:00:00.000Z"
}

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

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

Body

Response