> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cbpayapp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Materialize a checkout payment option (public)

> Creates (lazily) the payment option the payer picked on a universal checkout link and returns its instructions — the payment URL for card/hosted methods, the QR for QR methods, the announce reference for bank transfers, or an exclusive crypto deposit address with the exact quoted amount plus a scannable QR (`qr_payload` + `qr_png_base64` — always the raw address for BTC/TRON/ETH, readable by external wallets and exchanges; BIP-21/EIP-681 URIs are rejected by apps like Binance). Fiat methods require `?country=XX`; the local amount is quoted and FROZEN at this moment. When the country offers the method in more than one currency (see `options[]` of the quote — e.g. QR in BOB and USD, or card corridors) it also requires `&currency=YYY`; each currency is an independent materialization. Bank transfers in Mexico issue a dedicated CLABE exclusive to the link (`destination` with `dedicated: true`): the payer transfers the exact amount with NO reference — the deposit routes to the link automatically. If the dedicated account cannot be issued, the payload degrades to the classic path (merchant account + mandatory `reference` in the transfer description). Pull methods (`collect: true` in the quote, e.g. `c2p` and `debito_inmediato` in Venezuela) freeze the quote and return the form the payer must fill (`banks[]` catalog, `requires_otp_request`); the charge itself runs through `POST /pay/{token}/collect`. Re-POSTing the same country+currency+method returns the SAME materialization; picking a method never blocks the others while nobody has paid. No credentials; rate limited per IP.



## OpenAPI

````yaml /openapi.yaml post /pay/{token}/methods/{method}
openapi: 3.1.0
info:
  title: CBPay API
  version: '1.89'
  description: |
    CBPay is a multi-currency payment platform: fiat payouts and collections
    across Latin America, internal transfers, on-chain funding and
    withdrawals, and KYC screening. Every account holds four independent
    virtual balances — USDT (the operating currency), USDC, BTC and GOLD
    (grams of fine gold) — that never mix or convert automatically.
    Payouts and service fees can be paid from any of the four balances:
    set a default with `PUT /v1/settlement` or override per payout with
    `settlement_asset`.

    All amounts are decimal strings in each currency's precision (6 decimals
    for USDT/USDC/GOLD, 8 for BTC). Errors always return
    `{"error": "<code>", "message": "<detail>"}`.
servers:
  - url: https://api.qbank.cl/platform
    description: Live (production, real money)
  - url: https://cryptobank.qbank.cl/platform
    description: Test (sandbox, simulated money — pk_test_ keys)
security:
  - bearerAuth: []
tags:
  - name: Receipts
    description: >-
      Branded PDF receipt per operation, with a public signed-QR authenticity
      check, receipt_url on every response/webhook and automatic email delivery
      on final states.
  - name: Authentication
    description: Register and log in account members. Sessions last 24 hours.
  - name: Account
    description: Profile, members and API keys of the calling account.
  - name: Balances
    description: Balances, movement history and FX rates.
  - name: Payouts
    description: >-
      Fiat dispersals debited from the settlement balance of your choice (USDT
      by default).
  - name: Payins
    description: Fiat top-ups credited to the USDT balance.
  - name: Transfers
  - name: Contacts
  - name: Swaps
    description: >-
      Free internal transfers between CBPay accounts (person or company, any
      combination).
  - name: Crypto
    description: On-chain funding and withdrawals (TRON, Ethereum and Bitcoin).
  - name: Segregated wallets
    description: >-
      On-chain wallets with their own balance (companies unlimited; persons 1
      per network+asset pair) — create, import, send, export the private key and
      auto-forward. The balance lives on-chain, never in the ledger.
  - name: QR Crypto POS
    description: >-
      Amount-bearing crypto QR charges for processors with physical POS
      terminals (company accounts): verified merchants, exclusive address + QR
      per charge, early payment detection, per-merchant reconciliation and
      refunds over the crypto withdrawal rail.
  - name: KYC / KYB
  - name: AML screening
    description: >-
      Identity verification: KYC for persons, KYB for companies, with AML
      screening, rescreening and continuous monitoring.
  - name: Wallet screening
    description: >-
      AML risk assessment of blockchain addresses (sanctions, illicit-fund
      exposure) with a per-scan fee, plus free automatic protection on
      withdrawals and deposits.
  - name: Analytics
  - name: Webhooks
    description: Subscriptions to receive signed event notifications.
  - name: Status
    description: Service availability.
  - name: Banking
    description: >-
      Real bank accounts: receive, hold and send money over international
      banking rails.
  - name: Cards
    description: >-
      Virtual and physical cards that spend Just-In-Time from the account's USDT
      balance, with per-card spending limits.
  - name: Security (OTP)
    description: >-
      One-time verification codes over SMS/WhatsApp/email protecting sensitive
      actions, plus self-service 2FA preferences. Applies to user sessions only
      — API keys are exempt.
  - name: Passkeys
    description: >-
      Passwordless sign-in with the device's biometrics (Face ID, Touch ID,
      Windows Hello, security keys) via WebAuthn, authenticator apps (TOTP) with
      backup codes, and session/device management.
  - name: Social login
    description: >-
      Passwordless sign up and sign in with Google, Apple, Microsoft and
      Facebook via token exchange. The front end obtains the provider
      credential; the API verifies it and issues the CBPay session.
paths:
  /pay/{token}/methods/{method}:
    post:
      tags:
        - Payins
      summary: Materialize a checkout payment option (public)
      description: >-
        Creates (lazily) the payment option the payer picked on a universal
        checkout link and returns its instructions — the payment URL for
        card/hosted methods, the QR for QR methods, the announce reference for
        bank transfers, or an exclusive crypto deposit address with the exact
        quoted amount plus a scannable QR (`qr_payload` + `qr_png_base64` —
        always the raw address for BTC/TRON/ETH, readable by external wallets
        and exchanges; BIP-21/EIP-681 URIs are rejected by apps like Binance).
        Fiat methods require `?country=XX`; the local amount is quoted and
        FROZEN at this moment. When the country offers the method in more than
        one currency (see `options[]` of the quote — e.g. QR in BOB and USD, or
        card corridors) it also requires `&currency=YYY`; each currency is an
        independent materialization. Bank transfers in Mexico issue a dedicated
        CLABE exclusive to the link (`destination` with `dedicated: true`): the
        payer transfers the exact amount with NO reference — the deposit routes
        to the link automatically. If the dedicated account cannot be issued,
        the payload degrades to the classic path (merchant account + mandatory
        `reference` in the transfer description). Pull methods (`collect: true`
        in the quote, e.g. `c2p` and `debito_inmediato` in Venezuela) freeze the
        quote and return the form the payer must fill (`banks[]` catalog,
        `requires_otp_request`); the charge itself runs through `POST
        /pay/{token}/collect`. Re-POSTing the same country+currency+method
        returns the SAME materialization; picking a method never blocks the
        others while nobody has paid. No credentials; rate limited per IP.
      operationId: checkoutMaterialize
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
          description: Opaque checkout token embedded in the `checkout_url`.
        - name: method
          in: path
          required: true
          schema:
            type: string
          description: >-
            Method to materialize — a fiat method from the multi-country catalog
            (`qr`, `card`, `fintoc`, `bank_transfer`, `c2p`, `debito_inmediato`;
            requires `?country=XX`) or a crypto option (`crypto:tron:usdt`,
            `crypto:eth:usdt`, `crypto:eth:usdc`, `crypto:btc:btc`; no country).
        - name: country
          in: query
          required: false
          schema:
            type: string
          description: >-
            ISO-3166 alpha-2 country of the fiat method being materialized.
            Required for fiat methods, ignored for crypto.
        - name: currency
          in: query
          required: false
          schema:
            type: string
          description: >-
            Charge currency of the materialization, picked from the `options[]`
            (or `cards[]`) catalog of the quote (e.g. `BOB` or `USD`). Required
            when the country offers the method in more than one currency;
            ignored when there is a single one (it is determined by the
            country).
      responses:
        '200':
          description: Instructions for the chosen payment method.
          content:
            application/json:
              examples:
                crypto:
                  summary: Crypto — exclusive deposit address with scannable QR
                  value:
                    method: crypto:btc:btc
                    payload:
                      chain: btc
                      asset: BTC
                      address: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
                      due: '0.00046120'
                      received: '0.00000000'
                      qr_payload: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
                      qr_png_base64: iVBORw0KGgo…
                      quote_expires_at: '2026-07-16T18:15:00Z'
                      note: >-
                        send the exact amount to the address; the payment is
                        confirmed on-chain automatically
                bank_transfer:
                  summary: Bank transfer — announce reference (frozen local quote)
                  value:
                    method: bank_transfer
                    country: CL
                    currency: CLP
                    local_amount: '47180'
                    payload:
                      reference: CB68JZCT46QE
                      note: >-
                        include the reference in the transfer description so the
                        payment is detected automatically
                bank_transfer_dedicated_account:
                  summary: >-
                    Bank transfer with a dedicated CLABE exclusive to the link
                    (MX)
                  value:
                    method: bank_transfer
                    country: MX
                    currency: MXN
                    local_amount: '941.00'
                    payload:
                      destination:
                        type: clabe
                        account: '710969000012345678'
                        beneficiary: Acme Store S.A.
                        dedicated: true
                      note: >-
                        transfer the exact amount to this dedicated account; no
                        reference is needed — the payment is detected
                        automatically
                collect:
                  summary: Pull method (VE C2P) — frozen quote + payer form definition
                  value:
                    method: c2p
                    country: VE
                    currency: VES
                    local_amount: '4266.77'
                    payload:
                      collect: true
                      currency: VES
                      amount: '4266.77'
                      requires_otp_request: false
                      banks:
                        - code: '0102'
                          name: Banco de Venezuela
                        - code: '0134'
                          name: Banesco
                card:
                  summary: Card — hosted payment page in the chosen currency
                  value:
                    method: card
                    country: BO
                    currency: USD
                    local_amount: '50.75'
                    payload:
                      charge_id: 8f6a2c1e-4b7d-4a1e-9c3f-2d5e6f7a8b9c
                      payment_url: https://api.qbank.cl/pay/cards/9f3XkT2m…
                      expires_at: '2026-07-17T18:15:00Z'
        '400':
          description: >-
            Fiat method without the required country, or card without the charge
            currency.
          content:
            application/json:
              examples:
                country_required:
                  summary: Fiat method without country
                  value:
                    error: country_required
                    message: send ?country=XX to choose the payment corridor
                currency_required:
                  summary: Method offered in several currencies without picking one
                  value:
                    error: currency_required
                    message: >-
                      this country accepts this method in more than one
                      currency; send ?currency=XXX
        '404':
          description: Invalid token or unknown payment link.
          content:
            application/json:
              example:
                error: not_found
                message: payment link not found
        '409':
          description: The link was already paid via another method.
          content:
            application/json:
              example:
                error: already_paid
                message: this payment link was already paid
        '410':
          description: The link expired without payment.
          content:
            application/json:
              example:
                error: checkout_expired
                message: this payment link expired
        '422':
          description: The method is not available for this link or country.
          content:
            application/json:
              examples:
                method_unavailable:
                  summary: Method not offered
                  value:
                    error: method_unavailable
                    message: this payment method is not available for this link
                country_unavailable:
                  summary: Country without live methods
                  value:
                    error: country_unavailable
                    message: no payment methods are available for that country
        '429':
          description: Too many requests from this IP.
          content:
            application/json:
              example:
                error: too_many_attempts
                message: too many requests; wait a moment and retry
        '503':
          description: Pricing temporarily unavailable.
          content:
            application/json:
              example:
                error: pricing_unavailable
                message: pricing is temporarily unavailable; retry in a moment
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Session JWT (from register/login) or API key (`pk_...`).
        `X-API-Key: <token>` is accepted as an alternative header.

````