Publish Checkout Configuration

PUT

checkouts

{checkout_code}

curl --request PUT \
  --url https://api-sandbox.y.uno/v1/checkouts/{checkout_code} \
  --header 'Content-Type: application/json' \
  --header 'PRIVATE-SECRET-KEY: <api-key>' \
  --header 'PUBLIC-API-KEY: <api-key>' \
  --header 'X-Account-Code: <api-key>' \
  --data '
{
  "name": "Main Checkout",
  "config": {
    "payment_methods": [
      {
        "payment_method_type": "CARD",
        "type": "PAYMENT_METHOD",
        "order_to_show": 0,
        "is_active": true,
        "active_enrollment_type": "BOTH",
        "conditions_to_override": [],
        "required_fields_to_override": {
          "is_active": true,
          "fields": [
            {
              "field_name": "security_code",
              "is_active": true,
              "current_value": "ALWAYS",
              "conditions_to_override": [
                {
                  "name": "BR only",
                  "is_active": true,
                  "priority": 1,
                  "conditions": [
                    {
                      "condition_type": "COUNTRY",
                      "conditional": "ONE_OF",
                      "values": [
                        "BR"
                      ]
                    }
                  ]
                }
              ]
            }
          ],
          "enrollment_fields": [],
          "is_enrollment_active": true
        }
      }
    ],
    "general_settings": {
      "country_documents": [
        {
          "country_code": "BR",
          "documents": [
            "CPF",
            "CNPJ"
          ]
        }
      ]
    }
  },
  "styling": {
    "styles": {
      "global": {
        "accent_color": "#1A73E8",
        "primary_background_color": "#FFFFFF",
        "font_family": "Inter"
      },
      "header": {
        "logo": "https://cdn.example.com/logo.png",
        "font_weight": 600
      },
      "button": {
        "corner_radius": 8,
        "font_weight": 500
      }
    },
    "flags": {
      "force_default_styles": false
    }
  }
}
'

{
  "id": "8005ca91-dcfb-4428-b9f6-49c6e3446474",
  "name": "Main Checkout",
  "description": "Default checkout",
  "is_default": true,
  "is_active": true,
  "created_at": "2026-10-22T03:16:36Z"
}

{
  "code": "INVALID_PARAMETERS",
  "messages": [
    "payment_methods[0].order_to_show must be >= 0",
    "styles.global.accent_color must be a 6- or 8-digit hex color (#RRGGBB or #RRGGBBAA)"
  ]
}

{
  "code": "NOT_AUTHENTICATED",
  "messages": [
    "Not authenticated"
  ]
}

{
  "code": "<string>",
  "messages": [
    "<string>"
  ]
}

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. The tenant is resolved only from this header.

Headers

X-Idempotency-Key

string

Client-generated UUID. Re-sending the same request with the same key is safe and will not double-publish.

Path Parameters

checkout_code

string

required

The unique identifier of the checkout to update (UUID, 36 chars). Non-UUID values are rejected with 400 before processing.

Body

application/json

At least one of config or styling is required. name is required when config is sent.

name

string

Name of the checkout configuration (1 to 50 characters). Required when the body includes config; a request with config and no name returns 400 name must not be blank. A styling-only request does not need it. The value replaces the current checkout name, so send the current name to keep it.

Required string length: 1 - 50

Example:

"Main checkout"

config

object

Checkout configuration: payment methods and general settings. Sparse upsert; omitted payment methods keep their previous state.

Show child attributes

styling

object

Checkout styling and SDK settings. Partial merge; omitted or null fields are preserved; use flags.force_default_styles to reset. settings.urls, settings.click_to_pay, settings.form and settings.google_pay are beta-locked and rejected if sent with a non-empty value.

Show child attributes

Response

Summary of the updated checkout. The configuration and styling are not returned in this response; read them with Fetch checkout configuration. Its identifier is exposed as the top-level id.

string

Example:

"8005ca91-dcfb-4428-b9f6-49c6e3446474"

name

string

Example:

"Main Checkout"

description

string

Example:

"Default checkout"

is_default

boolean

Example:

true

is_active

boolean

Example:

true

created_at

string

Example:

"2026-10-22T03:16:36Z"

⌘I

curl --request PUT \
  --url https://api-sandbox.y.uno/v1/checkouts/{checkout_code} \
  --header 'Content-Type: application/json' \
  --header 'PRIVATE-SECRET-KEY: <api-key>' \
  --header 'PUBLIC-API-KEY: <api-key>' \
  --header 'X-Account-Code: <api-key>' \
  --data '
{
  "name": "Main Checkout",
  "config": {
    "payment_methods": [
      {
        "payment_method_type": "CARD",
        "type": "PAYMENT_METHOD",
        "order_to_show": 0,
        "is_active": true,
        "active_enrollment_type": "BOTH",
        "conditions_to_override": [],
        "required_fields_to_override": {
          "is_active": true,
          "fields": [
            {
              "field_name": "security_code",
              "is_active": true,
              "current_value": "ALWAYS",
              "conditions_to_override": [
                {
                  "name": "BR only",
                  "is_active": true,
                  "priority": 1,
                  "conditions": [
                    {
                      "condition_type": "COUNTRY",
                      "conditional": "ONE_OF",
                      "values": [
                        "BR"
                      ]
                    }
                  ]
                }
              ]
            }
          ],
          "enrollment_fields": [],
          "is_enrollment_active": true
        }
      }
    ],
    "general_settings": {
      "country_documents": [
        {
          "country_code": "BR",
          "documents": [
            "CPF",
            "CNPJ"
          ]
        }
      ]
    }
  },
  "styling": {
    "styles": {
      "global": {
        "accent_color": "#1A73E8",
        "primary_background_color": "#FFFFFF",
        "font_family": "Inter"
      },
      "header": {
        "logo": "https://cdn.example.com/logo.png",
        "font_weight": 600
      },
      "button": {
        "corner_radius": 8,
        "font_weight": 500
      }
    },
    "flags": {
      "force_default_styles": false
    }
  }
}
'

{
  "id": "8005ca91-dcfb-4428-b9f6-49c6e3446474",
  "name": "Main Checkout",
  "description": "Default checkout",
  "is_default": true,
  "is_active": true,
  "created_at": "2026-10-22T03:16:36Z"
}

{
  "code": "INVALID_PARAMETERS",
  "messages": [
    "payment_methods[0].order_to_show must be >= 0",
    "styles.global.accent_color must be a 6- or 8-digit hex color (#RRGGBB or #RRGGBBAA)"
  ]
}

{
  "code": "NOT_AUTHENTICATED",
  "messages": [
    "Not authenticated"
  ]
}

{
  "code": "<string>",
  "messages": [
    "<string>"
  ]
}

Getting Started

Reference

Customers

Network Tokens

Customer Sessions (Enrollment)

Checkout Sessions

Payment Methods (Checkout)

Checkout Builder

Payment Methods (Direct Workflow)

PCI Proxy

Payments

Pre-Debit Notifications

3DS2 Setup

Unreferenced Refunds

Dry-run

Transaction Reporting

Routing Recommendations

Payment Links

Recipients for Marketplace

Sellers (Franchise)

Subscriptions Plans

Subscriptions

Payouts

Organizations

Reports

Installments

AI Caller

Communications Campaigns

Conversion Rate

FX Rates

Banking Connectivity

Webhooks

Authorizations

Headers

Path Parameters

Body

Response