> ## 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. # Get a payin ## OpenAPI ````yaml /openapi.yaml get /v1/payins/{payinID} 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/payins/{payinID}: get: tags: - Payins summary: Get a payin operationId: getPayin parameters: - name: payinID in: path required: true schema: type: string format: uuid responses: '200': description: The payin. content: application/json: schema: $ref: '#/components/schemas/Payin' example: payin_id: 4f8a1b2c-3d4e-5f60-7a8b-9c0d1e2f3a4b account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d kind: qr country: BO currency: BOB method: '' local_amount: '700.00' status: credited reference: QR-778812 created_at: '2026-07-07T12:00:00Z' updated_at: '2026-07-07T12:00:00Z' fx_rate: '6.91' usdt_gross: '101.302460' fee: '1.000000' usdt_credited: '100.302460' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' components: schemas: Payin: type: object properties: payin_id: type: string format: uuid account_id: type: string kind: type: string enum: - qr - collect - push country: type: string currency: type: string method: type: string local_amount: type: string status: type: string enum: - pending - credited - unassigned - expired - failed reference: type: string created_at: type: string format: date-time updated_at: type: string format: date-time fx_rate: type: string description: >- Your payin rate at credit time (present once the payment was received and converted). usdt_gross: type: string fee: type: string usdt_credited: type: string failure: type: object description: >- Present only when the payin is `failed` on active collections: where the rejection originated (`provider` = the payer's bank, `core` = pre-charge validation) plus the concrete code and message. properties: source: type: string code: type: string message: type: string 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 NotFound: description: Resource not found (`not_found`). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: not_found message: resource not found 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. ````