> ## 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. # Active collection (pull) > Charges the payer directly in corridors that support pull collections (e.g. Venezuela `c2p` / `debito_inmediato`). Synchronous: if the charge is approved the deposit converts at your current `payin_rate` and is credited in the same call, net of the payin fee. If the payer declines, `paid` is false, the payin is marked failed and nothing is charged. ## OpenAPI ````yaml /openapi.yaml post /v1/payins/collect 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/collect: post: tags: - Payins summary: Active collection (pull) description: >- Charges the payer directly in corridors that support pull collections (e.g. Venezuela `c2p` / `debito_inmediato`). Synchronous: if the charge is approved the deposit converts at your current `payin_rate` and is credited in the same call, net of the payin fee. If the payer declines, `paid` is false, the payin is marked failed and nothing is charged. operationId: payinCollect parameters: - $ref: '#/components/parameters/idempotencyKeyHeader' requestBody: required: true content: application/json: schema: type: object required: - method - amount - idempotency_key properties: country: type: string default: VE currency: type: string default: VES method: type: string description: Collection method (e.g. c2p, debito_inmediato). amount: type: string description: Local amount as a positive decimal string. description: type: string our_reference: type: string payer_document: type: string payer_phone: type: string payer_bank: type: string payer_account: type: string payer_name: type: string payer_account_type: type: string otp: type: string otp_reference: type: string idempotency_key: type: string description: >- Required — a collect executes a real charge; retries with the same key never re-charge. example: method: c2p amount: '1200.00' description: Order 5512 payer_document: V12345678 payer_phone: '04141234567' payer_bank: '0102' otp: '12345678' idempotency_key: collect-2026-07-07-a responses: '200': description: 'Collection result. `paid: true` means the deposit was credited.' content: application/json: schema: type: object properties: payin_id: type: string kind: type: string country: type: string currency: type: string method: type: string local_amount: type: string status: type: string fx_rate: type: string usdt_gross: type: string fee: type: string usdt_credited: type: string paid: type: boolean provider_reference: type: string status_code: type: string status_message: 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 example: payin_id: 7b3c9e2f-1a2b-3c4d-5e6f-7a8b9c0d1e2f account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d kind: collect country: VE currency: VES method: c2p local_amount: '1200.00' status: credited reference: REF-102030 fx_rate: '36.50' usdt_gross: '32.876712' fee: '0.300000' usdt_credited: '32.576712' paid: true provider_reference: PRV-889911 status_code: '00' status_message: approved created_at: '2026-07-07T12:00:00Z' updated_at: '2026-07-07T12:00:02Z' '400': description: invalid_request / invalid_amount content: application/json: schema: $ref: '#/components/schemas/Error' example: error: invalid_request message: method is required (e.g. c2p, debito_inmediato) '401': $ref: '#/components/responses/Unauthorized' '403': description: Account not active (account_blocked). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: account_blocked message: account is not active '502': description: Core unavailable (core_unavailable). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: core_unavailable message: could not execute the collection components: parameters: idempotencyKeyHeader: name: Idempotency-Key in: header required: false description: Alternative to the `idempotency_key` body field. schema: type: string 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 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. ````