Skip to main content
GET
/
v1
/
checkouts
/
payment-methods
/
{payment_method_type}
/
required-fields
Get Required Fields
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>'
[
  {
    "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
  }
]
This API is in Beta. Endpoints and schemas may change without prior notice.

Authorizations

​
PUBLIC-API-KEY
string
header
required

Merchant public API key. Found in Yuno dashboard → Settings → API Keys.

​
PRIVATE-SECRET-KEY
string
header
required

Merchant private secret key, paired with the public key. Never embed in client-side code.

​
X-Account-Code
string
header
required

UUID of the merchant account scope for the request.

Path Parameters

​
payment_method_type
string
required

The payment method type (e.g. CARD, GOOGLE_PAY, APPLE_PAY).

Query Parameters

​
type
enum<string>
required

The flow to query: ENROLLMENT for the saved-card flow, or PAYMENT_METHOD for the first-time entry flow.

Available options:
ENROLLMENT,
PAYMENT_METHOD

Response

200

​
field_name
string

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.

Example:

"security_code"

​
is_active
boolean

Default active state for this field.

Example:

true

​
current_value
string | null

Default value override. For security_code, FIRST_TIME means CVV is only required on first use.

Example:

null