> ## 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. # Scan a payout QR (Bolivia, Brazil) > Step 1 of the QR payout — Bolivia (local interoperable QR) and Brazil (PIX QR, including the "copia e cola" code): reads a collection QR and returns the recipient's data plus the `provider_reference` needed to confirm. **Free of charge** — nothing is debited until the confirm step. Defaults to Bolivia; for Brazil send `country: "BR"` and `currency: "BRL"`. Brazil supports **static** PIX QRs (key embedded); a dynamic QR (PSP URL payload) answers `400` — ask the beneficiary for their PIX key and use the `pix` method. An empty `amount` in the scan response means an open-amount QR. ## OpenAPI ````yaml /openapi.yaml post /v1/payouts/qr/scan 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": "", "message": ""}`. 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: /v1/payouts/qr/scan: post: tags: - Payouts summary: Scan a payout QR (Bolivia, Brazil) description: >- Step 1 of the QR payout — Bolivia (local interoperable QR) and Brazil (PIX QR, including the "copia e cola" code): reads a collection QR and returns the recipient's data plus the `provider_reference` needed to confirm. **Free of charge** — nothing is debited until the confirm step. Defaults to Bolivia; for Brazil send `country: "BR"` and `currency: "BRL"`. Brazil supports **static** PIX QRs (key embedded); a dynamic QR (PSP URL payload) answers `400` — ask the beneficiary for their PIX key and use the `pix` method. An empty `amount` in the scan response means an open-amount QR. operationId: payoutQrScan requestBody: required: true content: application/json: schema: type: object required: - qr_payload properties: country: type: string enum: - BO - BR default: BO currency: type: string enum: - BOB - USD - BRL default: BOB qr_payload: type: string description: >- Raw content of the scanned QR (in Brazil, also the PIX "copia e cola" code). example: qr_payload: currency: BOB responses: '200': description: Recipient data for user confirmation. content: application/json: schema: type: object properties: scan_id: type: string provider_reference: type: string beneficiary_name: type: string destination_account: type: string amount: type: string currency: type: string glosa: type: string status: type: string example: scan_id: 5c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f provider_reference: QR-REF-889923 beneficiary_name: Juan Quispe destination_account: '****4521' amount: '700.00' currency: BOB glosa: '' status: scanned '400': description: >- qr_payload missing (invalid_request) or unreadable/unsupported QR (invalid_qr_payload — corrupt BR Code, bad checksum, or a dynamic PIX QR; the message explains the exact reason). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: invalid_qr_payload message: >- dynamic pix qr codes are not supported yet: pay with method pix using the beneficiary pix key '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/AccountRequired' '502': description: Core unavailable (core_unavailable). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: core_unavailable message: could not scan the QR components: schemas: Error: type: object properties: error: type: string description: Machine-readable error code (snake_case). example: insufficient_funds message: type: string description: Human-readable explanation. responses: Unauthorized: description: Missing or invalid credential (`unauthorized`). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: unauthorized message: invalid or missing credentials AccountRequired: description: This endpoint requires an account credential (`account_required`). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: account_required message: this endpoint requires an account credential securitySchemes: bearerAuth: type: http scheme: bearer description: | Session JWT (from register/login) or API key (`pk_...`). `X-API-Key: ` is accepted as an alternative header. ````