curl --request GET \
--url https://api.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields \
--header 'PRIVATE-SECRET-KEY: <api-key>' \
--header 'PUBLIC-API-KEY: <api-key>' \
--header 'X-Account-Code: <api-key>'import requests
url = "https://api.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields"
headers = {
"PUBLIC-API-KEY": "<api-key>",
"PRIVATE-SECRET-KEY": "<api-key>",
"X-Account-Code": "<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>',
'X-Account-Code': '<api-key>'
}
};
fetch('https://api.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields', 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.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields",
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>",
"X-Account-Code: <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.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("PUBLIC-API-KEY", "<api-key>")
req.Header.Add("PRIVATE-SECRET-KEY", "<api-key>")
req.Header.Add("X-Account-Code", "<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.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields")
.header("PUBLIC-API-KEY", "<api-key>")
.header("PRIVATE-SECRET-KEY", "<api-key>")
.header("X-Account-Code", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields")
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>'
request["X-Account-Code"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"field_name": "security_code",
"is_active": true,
"current_value": null
},
{
"field_name": "installment",
"is_active": true,
"current_value": null
},
{
"field_name": "first_name",
"is_active": true,
"current_value": null
},
{
"field_name": "last_name",
"is_active": true,
"current_value": null
},
{
"field_name": "document",
"is_active": true,
"current_value": null
},
{
"field_name": "email",
"is_active": true,
"current_value": null
},
{
"field_name": "phone",
"is_active": true,
"current_value": null
},
{
"field_name": "billing_address",
"is_active": true,
"current_value": null
},
{
"field_name": "shipping_address",
"is_active": true,
"current_value": null
},
{
"field_name": "zip_code",
"is_active": false,
"current_value": null
}
]{
"code": "INVALID_CREDENTIALS",
"messages": [
"Invalid credentials"
]
}{
"code": "AUTHORIZATION_REQUIRED",
"messages": [
"The merchant has no authorization to use this API."
]
}Get Required Fields
Returns the set of configurable required fields for a given payment method and flow type. Use this before building a required_fields_to_override payload to ensure you reference valid field names.
curl --request GET \
--url https://api.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields \
--header 'PRIVATE-SECRET-KEY: <api-key>' \
--header 'PUBLIC-API-KEY: <api-key>' \
--header 'X-Account-Code: <api-key>'import requests
url = "https://api.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields"
headers = {
"PUBLIC-API-KEY": "<api-key>",
"PRIVATE-SECRET-KEY": "<api-key>",
"X-Account-Code": "<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>',
'X-Account-Code': '<api-key>'
}
};
fetch('https://api.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields', 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.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields",
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>",
"X-Account-Code: <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.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("PUBLIC-API-KEY", "<api-key>")
req.Header.Add("PRIVATE-SECRET-KEY", "<api-key>")
req.Header.Add("X-Account-Code", "<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.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields")
.header("PUBLIC-API-KEY", "<api-key>")
.header("PRIVATE-SECRET-KEY", "<api-key>")
.header("X-Account-Code", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.y.uno/v1/checkouts/payment-methods/{payment_method_type}/required-fields")
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>'
request["X-Account-Code"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"field_name": "security_code",
"is_active": true,
"current_value": null
},
{
"field_name": "installment",
"is_active": true,
"current_value": null
},
{
"field_name": "first_name",
"is_active": true,
"current_value": null
},
{
"field_name": "last_name",
"is_active": true,
"current_value": null
},
{
"field_name": "document",
"is_active": true,
"current_value": null
},
{
"field_name": "email",
"is_active": true,
"current_value": null
},
{
"field_name": "phone",
"is_active": true,
"current_value": null
},
{
"field_name": "billing_address",
"is_active": true,
"current_value": null
},
{
"field_name": "shipping_address",
"is_active": true,
"current_value": null
},
{
"field_name": "zip_code",
"is_active": false,
"current_value": null
}
]{
"code": "INVALID_CREDENTIALS",
"messages": [
"Invalid credentials"
]
}{
"code": "AUTHORIZATION_REQUIRED",
"messages": [
"The merchant has no authorization to use this API."
]
}Authorizations
Merchant public API key. Found in Yuno dashboard → Settings → API Keys.
Merchant private secret key, paired with the public key. Never embed in client-side code.
UUID of the merchant account scope for the request.
Path Parameters
The payment method type (e.g. CARD, GOOGLE_PAY, APPLE_PAY).
Query Parameters
The flow to query: ENROLLMENT for the saved-card flow, or PAYMENT_METHOD for the first-time entry flow.
ENROLLMENT, PAYMENT_METHOD Response
200
Field identifier used in required_fields_to_override. Common values for CARD: security_code, installment, first_name, last_name, document, email, phone, billing_address, shipping_address, zip_code.
"security_code"
Default active state for this field.
true
Default value override. For security_code, FIRST_TIME means CVV is only required on first use.
null
Was this page helpful?