> ## 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. # Refund a card payin > Returns money to the cardholder and reverses the credit on your balance. Only card-acquired payins in status `credited` can be refunded (`refund_not_supported` on the other rails) — and only once their balance is actually available: a credited payin whose settlement is still pending (`settlement_pending: true`, balance lands at `settle_at`) is declined with `422 settlement_pending`. The gross amount is debited: the fee and the FX spread of the original payin are NOT refundable. `idempotency_key` is mandatory; a replay returns the same refund with `idempotency_hit` and never sends a second refund to the processor. Requires OTP when the caller is a session (API keys are exempt). ## OpenAPI ````yaml /openapi.yaml post /v1/payins/{payinID}/refunds 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/{payinID}/refunds: parameters: - name: payinID in: path required: true schema: type: string format: uuid post: tags: - Payins summary: Refund a card payin description: >- Returns money to the cardholder and reverses the credit on your balance. Only card-acquired payins in status `credited` can be refunded (`refund_not_supported` on the other rails) — and only once their balance is actually available: a credited payin whose settlement is still pending (`settlement_pending: true`, balance lands at `settle_at`) is declined with `422 settlement_pending`. The gross amount is debited: the fee and the FX spread of the original payin are NOT refundable. `idempotency_key` is mandatory; a replay returns the same refund with `idempotency_hit` and never sends a second refund to the processor. Requires OTP when the caller is a session (API keys are exempt). operationId: createPayinRefund parameters: - name: X-OTP-Token in: header required: false schema: type: string description: >- One-time-use OTP token (see the OTP guide). Only for session callers. requestBody: required: true content: application/json: schema: type: object required: - idempotency_key properties: amount: type: string description: >- Amount in the original local currency. Omit it for a full refund of the remaining refundable value. kind: type: string enum: - refund - void description: >- `refund` (default) returns a settled charge; `void` cancels one that has not settled yet. reason: type: string idempotency_key: type: string example: amount: '150.00' kind: refund reason: customer request idempotency_key: refund-order-8842 responses: '200': description: >- Replay of the same idempotency key — the SAME refund, with `idempotency_hit`. content: application/json: schema: $ref: '#/components/schemas/PayinRefund' example: refund_id: 6f1a2b3c-4d5e-4f6a-8b9c-0d1e2f3a4b5c payin_id: d0135ed5-8e9c-4f8b-a522-8ec100470426 account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d kind: refund status: completed currency: USD local_amount: '150.00' usdt_debited: '150.000000' requested_by: account idempotency_key: refund-order-8842 reason: customer request idempotency_hit: true receipt_url: >- https://api.qbank.cl/platform/v1/payin-refunds/6f1a2b3c-4d5e-4f6a-8b9c-0d1e2f3a4b5c/receipt created_at: '2026-07-25T13:10:00Z' updated_at: '2026-07-25T13:10:03Z' '201': description: >- Refund created and approved by the processor. The balance was debited. content: application/json: schema: $ref: '#/components/schemas/PayinRefund' example: refund_id: 6f1a2b3c-4d5e-4f6a-8b9c-0d1e2f3a4b5c payin_id: d0135ed5-8e9c-4f8b-a522-8ec100470426 account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d kind: refund status: completed currency: USD local_amount: '150.00' usdt_debited: '150.000000' requested_by: account idempotency_key: refund-order-8842 reason: customer request receipt_url: >- https://api.qbank.cl/platform/v1/payin-refunds/6f1a2b3c-4d5e-4f6a-8b9c-0d1e2f3a4b5c/receipt created_at: '2026-07-25T13:10:00Z' updated_at: '2026-07-25T13:10:03Z' '202': description: >- Ambiguous dispatch: the processor may have refunded. The refund stays `pending` with your balance reserved and is resolved by reconciliation. We NEVER retry on our side — retry with the SAME `idempotency_key` and you will get this same refund back. content: application/json: schema: $ref: '#/components/schemas/PayinRefund' example: refund_id: 6f1a2b3c-4d5e-4f6a-8b9c-0d1e2f3a4b5c payin_id: d0135ed5-8e9c-4f8b-a522-8ec100470426 account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d kind: refund status: pending currency: USD local_amount: '150.00' usdt_debited: '150.000000' requested_by: account idempotency_key: refund-order-8842 reconciliation_required: true receipt_url: >- https://api.qbank.cl/platform/v1/payin-refunds/6f1a2b3c-4d5e-4f6a-8b9c-0d1e2f3a4b5c/receipt created_at: '2026-07-25T13:10:00Z' updated_at: '2026-07-25T13:10:00Z' '400': description: '`idempotency_key_required` or `invalid_amount` / `invalid_payload`.' content: application/json: schema: $ref: '#/components/schemas/Error' example: error: idempotency_key_required message: idempotency_key is required '401': $ref: '#/components/responses/Unauthorized' '402': description: >- `insufficient_funds` — top up the balance and retry with the same `idempotency_key`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: insufficient_funds message: >- the account balance is not enough to fund this refund; top up and retry with the same idempotency_key '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': description: '`idempotency_conflict` — another refund with this key is in flight.' content: application/json: schema: $ref: '#/components/schemas/Error' example: error: idempotency_conflict message: another refund with this key is in flight '422': description: >- `payin_not_refundable`, `refund_not_supported`, `refund_exceeds_payin`, `settlement_pending` (the payin is confirmed but its balance is still scheduled for a future `settle_at` — wait for it or ask your org admin to release the settlement first), or a refund the processor declined (the body is the refund with `status: failed` and `failure_reason`; the debit was reversed in full). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: refund_exceeds_payin message: >- the requested amount exceeds what is left to refund on this payin components: schemas: PayinRefund: type: object properties: refund_id: type: string format: uuid payin_id: type: string format: uuid account_id: type: string format: uuid kind: type: string enum: - refund - void - chargeback description: >- `chargeback` is imposed by the issuer — it is booked automatically and may leave the balance negative. status: type: string enum: - pending - completed - failed currency: type: string description: Currency of the original payin. local_amount: type: string usdt_debited: type: string description: >- Amount debited from the USDT balance. The fee and the FX spread of the original payin are NOT refunded. requested_by: type: string enum: - account - admin - issuer reason: type: string failure_reason: type: string description: Present when `status` is `failed` — the debit was reversed in full. idempotency_key: type: string idempotency_hit: type: boolean reconciliation_required: type: boolean description: >- Present while the refund is `pending` — the outcome is resolved by reconciliation and is never re-dispatched. balance_after: type: string description: >- Present in the `payin_refunded` webhook — the USDT balance after the movement (can be negative on a chargeback). receipt_url: type: string created_at: type: string format: date-time updated_at: type: string format: date-time 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 Forbidden: description: Credential level not allowed for this endpoint (`forbidden`). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: forbidden message: credentials required 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. ````