> ## 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. # Preview the deposit instructions for a corridor > Returns the bank account text your organization publishes for a `bank_transfer` corridor — same content that gets embedded automatically in an announced payin's response. Useful to render a "where do I send the money" screen before the payer creates the payin, or to show the current instructions on a static page. Only corridors with an active, admin-configured instruction return content; everything else responds `404 not_found` (nothing to preview — the corridor either doesn't require it or nobody configured it yet). ## OpenAPI ````yaml /openapi.yaml get /v1/payins/deposit-instructions openapi: 3.1.0 info: title: CBPay API version: '2.62' 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) — convertible on demand with swaps. Payouts and service fees can be paid from any of the four balances (`PUT /v1/settlement` or per-payout `settlement_asset`), and payins can auto-convert to the asset of your choice (`default_payin_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 (QR, transfers, dedicated accounts, pull collections, cards, checkout links) credited automatically — in USDT by default, or auto-converted to the settlement asset of your choice. - name: Checkout description: >- Universal checkout links (`POST /v1/payins` with `method: "checkout"`) and the public payment-page endpoints — multi-country fiat, crypto with an ephemeral wallet per link and direct CBPay payment, settled in the asset of your choice. - name: Stored cards description: >- Cards saved with the payer's explicit consent during a 3-D Secure payment (COF). List, revoke and charge them on demand (MIT) without asking for the card again. - name: Subscriptions description: >- Recurring charges on a stored card managed by the platform scheduler — daily, weekly, monthly or yearly, with pause/resume/cancel and automatic dunning. - name: Transfers description: >- Free internal transfers between CBPay accounts (person or company, any combination). - name: Contacts description: >- Per-account address book of beneficiaries (CBPay, bank and crypto destinations) with phone matching and auto-save on every send. - name: Swaps description: >- Instant conversion between the account's USDT, USDC, BTC and GOLD balances at the account's quoted rate. - 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: Signature proofs description: >- Cryptographic message signing with wallets (EIP-191 ETH/EVM, TIP-191 TRON) — create, list, get and revoke signature proofs with public verification. - name: Wallet links description: >- Link external wallets (custody=client) to your account by signing a nonce challenge — create challenges, verify signatures, list and revoke links. - 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 description: >- Identity verification: KYC for persons, KYB for companies — your own onboarding and third-party verifications for company accounts. - name: AML screening description: >- Standalone AML screening of persons and companies against sanctions, PEP and adverse media lists, with rescreening, continuous monitoring and a downloadable PDF report. - 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: Qscore description: >- API-first credit bureau. Issues complete credit reports with a 1-999 score (bands A-E, or SC when there is no data), reads the latest score of a subject and manages ARCO disputes. Chile first, with a country-agnostic design. Every issued report carries a public verification code. - 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 balance of your choice (USDT, USDC, BTC or GOLD), 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. - name: Real-time events description: >- Server-Sent Events stream with everything that happens in the account (or across the organization for admins), replay with `Last-Event-ID`, optional initial snapshot and a 90-day queryable history. paths: /v1/payins/deposit-instructions: get: tags: - Payins summary: Preview the deposit instructions for a corridor description: |- Returns the bank account text your organization publishes for a `bank_transfer` corridor — same content that gets embedded automatically in an announced payin's response. Useful to render a "where do I send the money" screen before the payer creates the payin, or to show the current instructions on a static page. Only corridors with an active, admin-configured instruction return content; everything else responds `404 not_found` (nothing to preview — the corridor either doesn't require it or nobody configured it yet). operationId: getDepositInstructions parameters: - name: country in: query required: true schema: type: string example: CL - name: currency in: query required: true schema: type: string example: CLP - name: method in: query schema: type: string default: bank_transfer responses: '200': description: Active deposit instructions for the corridor. content: application/json: schema: type: object properties: deposit_instructions: $ref: '#/components/schemas/DepositInstructions' deposit_instructions_swift: $ref: '#/components/schemas/DepositInstructions' description: >- International SWIFT variant of the corridor (US/USD only, when configured). Same shape, with its own `qr_payload` and `qr_png_base64`. examples: cl_bank_transfer: summary: Chile (CLP) value: deposit_instructions: id: 9f0c1a2b-3d4e-4f5a-8b9c-1a2b3c4d5e6f country: CL currency: CLP method: bank_transfer purpose: payin revision: 3 active: true reference_required: true bank_name: Bank of Example account_number: '0001112223' account_type: checking holder_name: Example Org SpA created_at: '2026-07-15T14:02:00Z' qr_payload: |- Bank: Bank of Example Account type: checking Account number: 0001112223 Holder: Example Org SpA qr_png_base64: iVBORw0KGgoAAAANSU... us_bank_transfer: summary: >- United States (USD — dual rail: domestic ABA + international SWIFT) value: deposit_instructions: id: 7b1e4d5a-2c3b-4a59-8877-6f5e4d3c2b1a country: US currency: USD method: bank_transfer purpose: payin revision: 1 active: true reference_required: true bank_name: Partner Bank, N.A. account_number: '000123456789' account_type: checking holder_name: CBPay Operations LLC holder_tax_id: 88-1234567 routing_number: '021000021' holder_address: 25 SW 9th Street, Suite 406, Miami, FL 33130, US created_at: '2026-08-07T10:00:00Z' qr_payload: >- Bank: Partner Bank, N.A. Account type: checking Account number: 000123456789 Routing number (ABA): 021000021 Holder: CBPay Operations LLC Holder address: 25 SW 9th Street, Suite 406, Miami, FL 33130, US Tax ID: 88-1234567 qr_png_base64: iVBORw0KGgoAAAANSU... deposit_instructions_swift: id: 8c2f5e6b-3d4c-5b6a-9988-7f6e5d4c3b2a country: US currency: USD method: swift purpose: payin revision: 1 active: true reference_required: true bank_name: Partner Bank International account_number: '9870001234' account_type: checking holder_name: CBPay Operations LLC holder_tax_id: 88-1234567 swift: PRTBPRI3 bank_address: 200 Example Blvd, San Juan, PR 00901, PR intermediary_bank_name: Intermediary Bank N.A. intermediary_bank_swift: INTRUS33 holder_address: 25 SW 9th Street, Suite 406, Miami, FL 33130, US notes: Select Puerto Rico as the final beneficiary bank country created_at: '2026-08-07T10:00:00Z' qr_payload: >- Bank: Partner Bank International Account type: checking Account number: 9870001234 SWIFT: PRTBPRI3 Bank address: 200 Example Blvd, San Juan, PR 00901, PR Intermediary bank: Intermediary Bank N.A. Intermediary SWIFT: INTRUS33 Holder: CBPay Operations LLC Holder address: 25 SW 9th Street, Suite 406, Miami, FL 33130, US Tax ID: 88-1234567 Note: Select Puerto Rico as the final beneficiary bank country qr_png_base64: iVBORw0KGgoAAAANSU... '400': description: Missing country or currency (invalid_payload). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: invalid_payload message: country and currency are required '401': $ref: '#/components/responses/Unauthorized' '404': description: >- No active deposit instructions configured for this corridor (not_found). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: not_found message: no deposit instructions configured for this corridor components: schemas: DepositInstructions: type: object description: | The bank account text your organization publishes for a `bank_transfer` corridor. Admin-managed, append-only (a new revision never overwrites the text a payin already snapshotted). properties: id: type: string format: uuid country: type: string currency: type: string method: type: string purpose: type: string enum: - payin - otc revision: type: integer active: type: boolean reference_required: type: boolean bank_name: type: string account_number: type: string account_type: type: string holder_name: type: string holder_tax_id: type: string holder_email: type: string routing_number: type: string description: >- ABA routing number of the destination bank (US/USD corridor — domestic ACH and wires). Absent on corridors that do not use it. swift: type: string description: >- SWIFT/BIC of the destination bank (US/USD corridor — international wires). Absent on corridors that do not use it. bank_address: type: string description: >- Registered address of the destination bank. Present when the corridor's bank requires it on the transfer form (US/USD). intermediary_bank_name: type: string description: >- Correspondent (intermediary) bank name — only when the corridor's account receives international wires through one. intermediary_bank_swift: type: string description: SWIFT/BIC of the correspondent bank, when present. holder_address: type: string description: >- Postal address of the account holder. US bank wire forms ask for it; the per-rail QR carries a "Holder address" line when set. notes: type: string description: >- Free operational note for the sending bank (e.g. which country to select as the final beneficiary bank's). Shown to the payer as-is; the per-rail QR carries a "Note" line when set. created_at: type: string format: date-time qr_payload: type: string description: | Multi-line plain text with the bank details (and, when the corridor requires it, the amount and reference). Meant to be read by a human, not scanned by a banking app. qr_png_base64: type: string description: | Base64 PNG rendering `qr_payload` as a QR code, with your organization's branding symbol centered on top. 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. ````