> ## 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.

# Create an on-chain withdrawal

> Sends USDT, USDC or BTC on-chain from its own balance. Supported pairs: `tron`/`USDT`, `eth`/`USDT`, `eth`/`USDC`, `btc`/`BTC` (GOLD has no on-chain rail). `amount + withdrawal fee` is debited atomically and held; final state arrives via the `crypto_withdrawal_status_changed` webhook. `failed` refunds the full debit.



## OpenAPI

````yaml /openapi.yaml post /v1/crypto/withdrawals
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:
  /v1/crypto/withdrawals:
    post:
      tags:
        - Crypto
      summary: Create an on-chain withdrawal
      description: >-
        Sends USDT, USDC or BTC on-chain from its own balance. Supported pairs:
        `tron`/`USDT`, `eth`/`USDT`, `eth`/`USDC`, `btc`/`BTC` (GOLD has no
        on-chain rail). `amount + withdrawal fee` is debited atomically and
        held; final state arrives via the `crypto_withdrawal_status_changed`
        webhook. `failed` refunds the full debit.
      operationId: createCryptoWithdrawal
      parameters:
        - $ref: '#/components/parameters/idempotencyKeyHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - amount
              properties:
                chain:
                  type: string
                  enum:
                    - tron
                    - eth
                    - btc
                  default: tron
                asset:
                  type: string
                  enum:
                    - USDT
                    - USDC
                    - BTC
                  default: USDT
                  description: >-
                    Asset to send (USDC only over `eth`; on `btc` the asset
                    defaults to `BTC`).
                to_address:
                  type: string
                to_contact_id:
                  type: string
                  format: uuid
                  description: >-
                    Use the contact's saved address for this chain instead of
                    `to_address` (an explicit `to_address` always wins).
                amount:
                  type: string
                  description: Positive decimal string, up to 6 decimal places (8 for BTC).
                idempotency_key:
                  type: string
                contact_name:
                  type: string
                  description: Name for the auto-saved contact holding this address.
                save_contact:
                  type: boolean
                  default: true
                  description: >-
                    The address is saved as a contact automatically; send false
                    to skip it.
                travel_address:
                  type: string
                  description: >-
                    Travel Rule (FATF R.16) — the beneficiary institution's
                    travel address (`ta…` code) for withdrawals above the org
                    threshold towards another institution. The payment address
                    is provided by the receiving institution, so `to_address`
                    can be omitted.
                wallet_type:
                  type: string
                  enum:
                    - self_hosted
                  description: >-
                    Travel Rule — declare `self_hosted` when the destination is
                    the account holder's own wallet (requires
                    `beneficiary_name`).
                beneficiary_name:
                  type: string
                  description: >-
                    Travel Rule — name of the destination holder. Required above
                    the threshold (with `travel_address` or
                    `wallet_type=self_hosted`).
            examples:
              usdt_tron:
                summary: USDT over TRON
                value:
                  chain: tron
                  to_address: TVJ6njG5Fyrq6XwYok3xPQx8kR7HQx6vXk
                  amount: '100.000000'
                  idempotency_key: withdrawal-2026-07-07-a
              usdc_eth:
                summary: USDC over Ethereum
                value:
                  chain: eth
                  asset: USDC
                  to_address: '0x8f3Ba1c2De4567890aBcDeF1234567890aBcDeF1'
                  amount: '50.000000'
                  idempotency_key: withdrawal-usdc-2026-07-09-a
              btc_bitcoin:
                summary: BTC over Bitcoin
                value:
                  chain: btc
                  to_address: bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4
                  amount: '0.00050000'
                  idempotency_key: withdrawal-btc-2026-07-15-a
              travel_rule_self_hosted:
                summary: Above the Travel Rule threshold to an own (self-hosted) wallet
                value:
                  chain: tron
                  to_address: TVJ6njG5Fyrq6XwYok3xPQx8kR7HQx6vXk
                  amount: '1500.000000'
                  wallet_type: self_hosted
                  beneficiary_name: Maria Perez
                  idempotency_key: withdrawal-2026-07-12-a
              travel_rule_vasp:
                summary: Above the threshold to another institution (travel address)
                value:
                  chain: tron
                  amount: '1500.000000'
                  travel_address: ta2AQSjBotWQf38c8sxYYK2KfisPoMsTPiYkviErEcoSn1uK
                  beneficiary_name: Maria Perez
                  idempotency_key: withdrawal-2026-07-12-b
      responses:
        '200':
          description: Idempotency replay.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoWithdrawal'
              example:
                withdrawal_id: 6c5d4e3f-2a1b-0c9d-8e7f-6a5b4c3d2e1f
                account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
                idempotency_key: withdrawal-2026-07-07-a
                chain: tron
                asset: USDT
                to_address: TVJ6njG5Fyrq6XwYok3xPQx8kR7HQx6vXk
                amount: '100.000000'
                fee: '1.000000'
                total_debit: '101.000000'
                status: processing
                status_code: ''
                status_message: broadcasted
                tx_id: >-
                  b1946ac92492d2347c6235b4d2611184e0f0f8c9d3a1e2b3c4d5e6f708192a3b
                created_at: '2026-07-07T12:00:00Z'
                updated_at: '2026-07-07T12:00:00Z'
                idempotency_hit: true
        '202':
          description: Withdrawal accepted and broadcasting.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoWithdrawal'
              example:
                withdrawal_id: 6c5d4e3f-2a1b-0c9d-8e7f-6a5b4c3d2e1f
                account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
                idempotency_key: withdrawal-2026-07-07-a
                chain: tron
                asset: USDT
                to_address: TVJ6njG5Fyrq6XwYok3xPQx8kR7HQx6vXk
                amount: '100.000000'
                fee: '1.000000'
                total_debit: '101.000000'
                status: processing
                status_code: ''
                status_message: broadcasted
                tx_id: >-
                  b1946ac92492d2347c6235b4d2611184e0f0f8c9d3a1e2b3c4d5e6f708192a3b
                created_at: '2026-07-07T12:00:00Z'
                updated_at: '2026-07-07T12:00:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/InsufficientFunds'
        '422':
          description: The core rejected the withdrawal; the debit was refunded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoWithdrawal'
              example:
                withdrawal_id: 6c5d4e3f-2a1b-0c9d-8e7f-6a5b4c3d2e1f
                account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
                idempotency_key: withdrawal-2026-07-07-a
                chain: tron
                asset: USDT
                to_address: TVJ6njG5Fyrq6XwYok3xPQx8kR7HQx6vXk
                amount: '100.000000'
                fee: '1.000000'
                total_debit: '101.000000'
                status: failed
                status_code: core_rejected
                status_message: destination address is invalid
                tx_id: ''
                created_at: '2026-07-07T12:00:00Z'
                updated_at: '2026-07-07T12:00:00Z'
        '503':
          description: >-
            Withdrawals not enabled for this corridor
            (`withdrawals_unavailable`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: withdrawals_unavailable
                message: on-chain withdrawals are not enabled for this corridor yet
components:
  parameters:
    idempotencyKeyHeader:
      name: Idempotency-Key
      in: header
      required: false
      description: Alternative to the `idempotency_key` body field.
      schema:
        type: string
  schemas:
    CryptoWithdrawal:
      type: object
      properties:
        withdrawal_id:
          type: string
          format: uuid
        account_id:
          type: string
          format: uuid
        idempotency_key:
          type: string
        chain:
          type: string
          enum:
            - tron
            - eth
            - btc
        asset:
          type: string
          example: USDT
        to_address:
          type: string
        amount:
          type: string
        fee:
          type: string
        total_debit:
          type: string
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
        status_code:
          type: string
        status_message:
          type: string
        tx_id:
          type: string
        travel_rule_status:
          type: string
          enum:
            - not_required
            - self_hosted_attested
            - approved
          description: >-
            Present when the withdrawal was evaluated against the Travel Rule
            (FATF R.16) policy.
        beneficiary_name:
          type: string
          description: Declared beneficiary name (Travel Rule withdrawals).
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        idempotency_hit:
          type: boolean
    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:
    BadRequest:
      description: Invalid request (see `error` code for the specific validation).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid_json
            message: 'request body is not valid JSON: unknown field'
    Unauthorized:
      description: Missing or invalid credential (`unauthorized`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: invalid or missing credentials
    InsufficientFunds:
      description: Account balance is not enough for this operation (`insufficient_funds`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: insufficient_funds
            message: account balance is not enough for this operation
  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.

````