Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.y.uno/llms.txt

Use this file to discover all available pages before exploring further.

The Seller object represents a franchise seller mapping with per-provider merchant credentials.

​
Attributes

FieldTypeDescription
seller_idstring (UUID)The Yuno-generated unique identifier for this seller.
account_codestring (UUID)The account under which this seller was created.
merchant_seller_idstringThe merchant’s own identifier for this franchise store (MAX 255; MIN 1).
namestringThe seller’s display name (MAX 255).
emailstringThe seller’s email address.
phoneobjectThe seller’s phone. Contains country_code and number.
phone.country_codestringPhone country code (e.g., "55").
phone.numberstringPhone number (e.g., "11999999999").
documentobjectThe seller’s legal document. Contains type and number.
document.typestringDocument type (e.g., CNPJ, CPF, RUT, NIT).
document.numberstringDocument number (e.g., "12345678000199").
addressobjectThe seller’s address.
address.streetstringStreet name.
address.numberstringStreet number.
address.citystringCity name.
address.statestringState or province code.
address.countrystringCountry code (ISO 3166-1 alpha-2).
address.zip_codestringPostal or ZIP code.
countrystringThe seller’s country (ISO 3166-1 alpha-2, MAX 2).
websitestringThe seller’s website URL.
industrystringThe seller’s industry or business vertical (MAX 255).
merchant_category_codestringMerchant Category Code / MCC (MAX 4).
payment_methodarrayPayment method configurations with provider-specific details.
created_attimestampCreation timestamp (ISO 8601).
updated_attimestampLast update timestamp (ISO 8601).

​
Example Seller Object

{
  "seller_id": "f7a1b2c3-d4e5-6789-abcd-ef0123456789",
  "account_code": "11111111-2222-3333-4444-555555555555",
  "merchant_seller_id": "FRANCHISE_STORE_001",
  "name": "Franchise Store São Paulo",
  "email": "store001@franchise.com",
  "phone": { "country_code": "55", "number": "11999999999" },
  "document": { "type": "CNPJ", "number": "12345678000199" },
  "address": {
    "street": "Av Paulista",
    "number": "1000",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "zip_code": "01310-100"
  },
  "country": "BR",
  "website": "https://store001.franchise.com",
  "industry": "QSR",
  "merchant_category_code": "5812",
  "payment_method": [
    {
      "payment_method_type": "CARD",
      "detail": {
        "card": {
          "provider": {
            "id": "CIELO",
            "merchant_id": "CIELO_CC_12345"
          }
        }
      }
    },
    {
      "payment_method_type": "APPLE_PAY",
      "detail": {
        "wallet": {
          "provider": {
            "id": "APPLE_PAY",
            "merchant_id": "APPLE_PAY_12345",
            "payment_processing_key": "<base64-encoded .pem content>",
            "payment_processing_certificate": "<base64-encoded .pem content>",
            "merchant_identity_key": "<base64-encoded .pem content>",
            "merchant_identity_certificate": "<base64-encoded .pem content>",
            "merchant_identity_password": "password123"
          }
        }
      }
    }
  ],
  "created_at": "2026-03-13T10:00:00Z",
  "updated_at": "2026-03-13T10:00:00Z"
}