> ## Documentation Index > Fetch the complete documentation index at: https://www.bitnob.dev/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Bitnob API requests authenticate with an `X-Auth-Client` API key header against https://api.bitnob.com. > Always use the sandbox environment for testing. Never put live API keys in sample code. > Money amounts are integers in the smallest unit of the currency (satoshis for BTC, cents for fiat). Never use floats. > Every state-changing request takes a client-supplied `reference` and must be treated as idempotent on retry. > Quotes expire. Re-quote rather than reusing a stale quote id. # Finalize a payout > Step 3 of 3: approves an initialized payout, holds total_amount on your balance and sends it. Follow it with GET /api/payouts/{id} or webhooks until it reaches SUCCESS or FAILED. Retrying is safe. ## OpenAPI ````yaml /api-collections/swagger/bitnob-api-v2.openapi.json post /api/payouts/{quoteId}/finalize openapi: 3.1.0 info: description: >- The Bitnob API for businesses: customers, virtual accounts, cards, payouts, crypto addresses and transfers, Lightning, trading and exchange rates. ## Authentication Every request is signed with your API key's client id and secret. **Signed requests (recommended).** Send: - `X-Auth-Client`: your client id - `X-Auth-Timestamp`: the current Unix time in seconds; requests more than 5 minutes off are refused - `X-Auth-Nonce`: a unique random string for this request - `X-Auth-Signature`: hex HMAC-SHA256 of `{client_id}:{timestamp}:{nonce}:{body}` using your secret, where body is the raw request body (empty for GET) **Secret mode.** Send `X-Auth-Client` and `X-Auth-Secret` instead. Simpler, but the secret travels with every request. Live keys work only for an active organisation; sandbox keys work at any time. `ANY /api/whoami` echoes the authenticated client and is the quickest way to check your signing. ## Responses Successful responses are wrapped in an envelope with `success`, `message`, `data` and, on lists, `metadata`. Errors come either as the envelope with `success: false` and an `error` object, or as an RFC 7807 problem with a machine-readable `code`; branch on the code. Every response carries an `X-Correlation-ID` header; errors repeat it as `request_id`. Quote it to support. Every request passes a per-IP rate limit of 500 requests a minute (429 with `Retry-After`). This document is maintained by hand and checked against the route table on every build: every /api route is listed here. title: Bitnob API version: 1.0.0 servers: - description: Production url: https://api.bitnob.com security: - BitnobClientId: [] BitnobClientSecret: [] tags: - description: Check that your requests are signed correctly. name: Authentication - description: >- The people and businesses you serve. Creating and editing them needs the customers feature. name: Customers - description: >- Naira accounts that receive bank transfers, for your company or for a customer. name: Virtual accounts - description: Crypto deposit addresses, for your company or for a customer. name: Addresses - description: >- Virtual cards: issue, fund, withdraw, freeze, terminate, and the card KYC and corporate onboarding behind them. name: Cards - description: 'Pay out to bank accounts and mobile money: quote, initialize, finalize.' name: Payouts - description: Saved payout recipients. name: Beneficiaries - description: Banks and account lookups for payouts. name: Banks - description: Balance transfers between Bitnob organisations. name: Transfers - description: Crypto withdrawals. name: Withdrawals - description: Lightning invoices and payments. name: Lightning - description: Lightning addresses, LNURL withdraw links and LNURL payments. name: LNURL - description: Blockchain node access. name: Nodes - description: Quotes and orders for buying and selling. name: Trading - description: Rates and conversions. name: Exchange rates - description: Your transaction history. name: Transactions - description: Wallet balances. name: Balances paths: /api/payouts/{quoteId}/finalize: post: tags: - Payouts summary: Finalize a payout description: >- Step 3 of 3: approves an initialized payout, holds total_amount on your balance and sends it. Follow it with GET /api/payouts/{id} or webhooks until it reaches SUCCESS or FAILED. Retrying is safe. operationId: payoutsFinalize parameters: - description: The quote_id returned when the quote was created example: QT2_100482 in: path name: quoteId required: true schema: type: string responses: '200': content: application/json: examples: already_processing: summary: A retry on a payout already PROCESSING returns it unchanged value: data: payout: amount: '100' beneficiary: account_name: Adaeze Okafor account_number: '0000000001' bank_code: '000014' country: NG destination_type: bank beneficiary_id: 019a3b5e-5b84-73a6-8e7f-1a2b3c4d5e60 btc_amount: '0.00147059' callback_url: https://example.com/webhooks/payouts cent_amount: '14970000' cent_fees: '500000' company_id: 019a3b5c-1f0e-7d2c-8a9b-4c5d6e7f8a90 country: NG created_at: '2026-10-30T09:15:02.481Z' exchange_rate: btc_rate: '68000' currency: ngn effective_rate: '1497' rate: '1500' expires_at: '2026-10-30T09:31:02.481Z' fee_currency: USD fees: '0.5' from_asset: USDT id: 019a3b5c-8e21-7a4c-9b3d-2f6e8a1c4d70 payment_reason: Supplier invoice 0042 quote_id: QT2_100482 reference: payout_ref_20261030_0007 sat_amount: '147059' settlement_amount: '149700' source: OFFCHAIN source_fee: '0.5' status: PROCESSING to_currency: NGN total_amount: '100.5' trip: initialized_at: '2026-10-30T09:16:40.127Z' processing_start: '2026-10-30T09:17:06.311Z' quote_at: '2026-10-30T09:15:02.481Z' updated_at: '2026-10-30T09:17:06.311Z' message: Payout finalized successfully success: true timestamp: '2026-10-30T09:15:02.481Z' pending: summary: >- Funds held; the payout is PENDING and is processed in the background value: data: payout: amount: '100' beneficiary: account_name: Adaeze Okafor account_number: '0000000001' bank_code: '000014' country: NG destination_type: bank beneficiary_id: 019a3b5e-5b84-73a6-8e7f-1a2b3c4d5e60 btc_amount: '0.00147059' callback_url: https://example.com/webhooks/payouts cent_amount: '14970000' cent_fees: '500000' company_id: 019a3b5c-1f0e-7d2c-8a9b-4c5d6e7f8a90 country: NG created_at: '2026-10-30T09:15:02.481Z' exchange_rate: btc_rate: '68000' currency: ngn effective_rate: '1497' rate: '1500' expires_at: '2026-10-30T09:31:02.481Z' fee_currency: USD fees: '0.5' from_asset: USDT id: 019a3b5c-8e21-7a4c-9b3d-2f6e8a1c4d70 payment_reason: Supplier invoice 0042 quote_id: QT2_100482 reference: payout_ref_20261030_0007 sat_amount: '147059' settlement_amount: '149700' source: OFFCHAIN source_fee: '0.5' status: PENDING to_currency: NGN total_amount: '100.5' trip: initialized_at: '2026-10-30T09:16:40.127Z' quote_at: '2026-10-30T09:15:02.481Z' updated_at: '2026-10-30T09:17:05.902Z' message: Payout finalized successfully success: true timestamp: '2026-10-30T09:15:02.481Z' schema: allOf: - $ref: '#/components/schemas/Envelope' - properties: data: $ref: '#/components/schemas/PayoutsPayoutResult' type: object description: OK '400': content: application/json: examples: already_finished: summary: The payout already completed value: code: VALIDATION_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Cannot transition from 'success' to 'pending' extensions: current_status: success target_status: pending request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 400 timestamp: '2026-10-30T09:15:02Z' title: Validation Error type: https://api.bitnob.com/errors/VALIDATION_ERROR awaiting_deposit_status: summary: An onchain payout still waiting for its deposit value: code: VALIDATION_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: >- Cannot transition from 'pending_address_deposit' to 'pending' extensions: current_status: pending_address_deposit target_status: pending request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 400 timestamp: '2026-10-30T09:15:02Z' title: Validation Error type: https://api.bitnob.com/errors/VALIDATION_ERROR deposit_not_received: summary: The onchain deposit has not been credited yet value: code: VALIDATION_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: >- This payout is still waiting for its onchain deposit. Finalize it once the deposit has been confirmed. extensions: reason: awaiting_onchain_deposit request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 400 timestamp: '2026-10-30T09:15:02Z' title: Validation Error type: https://api.bitnob.com/errors/VALIDATION_ERROR not_initialized: summary: Initialize the quote first value: code: VALIDATION_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Cannot transition from 'quote' to 'pending' extensions: current_status: quote target_status: pending request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 400 timestamp: '2026-10-30T09:15:02Z' title: Validation Error type: https://api.bitnob.com/errors/VALIDATION_ERROR quote_expired: summary: >- The quote expired (6 minutes for BTC, 16 for stablecoins and NGN); create a new one value: code: VALIDATION_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Quote 'QT2_100482' has expired extensions: quote_id: QT2_100482 reason: expired request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 400 timestamp: '2026-10-30T09:15:02Z' title: Validation Error type: https://api.bitnob.com/errors/VALIDATION_ERROR schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- VALIDATION_ERROR: the quote expired, the payout is not in INITIATED status (a QUOTE that was never initialized, an onchain payout still waiting in PENDING_ADDRESS_DEPOSIT, or a payout already finished), or an onchain deposit has not been credited yet. headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' '401': $ref: '#/components/responses/Unauthorized' '403': content: application/json: examples: client_inactive: $ref: '#/components/examples/ClientInactive' ip_not_whitelisted: $ref: '#/components/examples/IPNotWhitelisted' org_not_active: $ref: '#/components/examples/OrgNotActive' org_not_active_live: $ref: '#/components/examples/OrgNotActiveLive' schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- ORG_NOT_ACTIVE for a live key on an organisation that is not active, or a refusal before the handler. headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' '404': content: application/json: examples: quote_not_found: summary: No quote with this quote_id belongs to your organisation value: code: NOT_FOUND correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: quote with ID 'QT2_999999' was not found extensions: id: QT2_999999 resource: quote request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 404 timestamp: '2026-10-30T09:15:02Z' title: Resource Not Found type: https://api.bitnob.com/errors/NOT_FOUND schema: $ref: '#/components/schemas/Problem' description: No quote with this quote_id belongs to your organisation. headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' '408': $ref: '#/components/responses/RequestTimeout' '412': content: application/json: examples: tier_limit_reached: $ref: '#/components/examples/TierLimitReached' schema: $ref: '#/components/schemas/Problem' description: >- TIER_LIMIT_REACHED: the payout would exceed the organisation's tier limit; the figures are in extensions. Nothing is held. headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' '422': content: application/json: examples: insufficient_funds: summary: The hold of total_amount failed on the balance value: code: INSUFFICIENT_FUNDS correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Insufficient funds to complete the transaction extensions: account_id: 019a3b5c-1f0e-7d2c-8a9b-4c5d6e7f8a90 request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 422 timestamp: '2026-10-30T09:15:02Z' title: Insufficient Funds type: https://api.bitnob.com/errors/INSUFFICIENT_FUNDS payout_fee_pending: summary: >- The fee is not known yet; poll the quote, re-quote if it never appears value: code: PRECONDITION_FAILED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: >- The fee for this payout isn't available yet. Fetch the quote again to see the fee before finalizing — if it doesn't appear before the quote expires, create a new quote. extensions: quote_id: QT2_100482 reason: payout_fee_pending request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 422 timestamp: '2026-10-30T09:15:02Z' title: Payout Fee Pending type: https://api.bitnob.com/errors/PRECONDITION_FAILED schema: $ref: '#/components/schemas/Problem' description: >- PRECONDITION_FAILED: our partner has not priced the payout yet (payout_fee_pending); INSUFFICIENT_FUNDS: the balance no longer covers total_amount when the funds are held. headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' '503': content: application/json: examples: auth_service_busy: $ref: '#/components/examples/AuthServiceBusy' auth_service_unavailable: $ref: '#/components/examples/AuthServiceUnavailable' limits_unavailable: $ref: '#/components/examples/LimitsUnavailable' partner_unavailable: $ref: '#/components/examples/PartnerUnavailable' schema: $ref: '#/components/schemas/Problem' description: >- LIMITS_UNAVAILABLE: the tier limit check could not run; SERVICE_UNAVAILABLE: the ledger could not be reached to hold the funds. Retry; a retried finalize replaces its own reservation. headers: Retry-After: $ref: '#/components/headers/Retry-After' X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' components: schemas: Envelope: description: >- Successful responses are wrapped in this envelope, and so are errors a handler answers itself (request body and field validation, some not-found and conflict cases, ORG_NOT_ACTIVE): success is false and error carries a code and message. Errors raised by authentication and by the services behind a handler are a Problem instead. properties: data: description: >- The payload; its shape is given per operation. Omitted when there is none. error: $ref: '#/components/schemas/ErrorInfo' message: description: Human-readable summary; omitted when empty. type: string metadata: $ref: '#/components/schemas/Pagination' request_id: description: >- Set on error envelopes: the request's correlation id (req_ followed by a UUID), the same value as the X-Correlation-ID response header. Quote it to support. type: string success: description: true on success type: boolean timestamp: description: When the response was written. format: date-time type: string required: - success - timestamp type: object PayoutsPayoutResult: properties: payout: $ref: '#/components/schemas/PayoutsPayout' required: - payout type: object ErrorEnvelope: allOf: - $ref: '#/components/schemas/Envelope' - properties: success: const: false required: - error type: object description: >- The envelope as an error: success is false, error is set, data is absent. Problem: description: >- RFC 7807 problem. Returned when authentication fails and for errors raised by the services behind a handler (validation, domain refusals such as FEATURE_NOT_ENABLED or PRECONDITION_FAILED, partner outages); branch on code. properties: code: description: >- Machine-readable; branch on this, not on the status or the wording. For example VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_NOT_ENABLED, PERSONAL_WORKSPACE_CUSTOMERS, TIER_PRODUCT_LOCKED, NOT_FOUND, DUPLICATE_KEY_ERROR, ALREADY_EXISTS, PRECONDITION_FAILED, INSUFFICIENT_FUNDS, TIER_LIMIT_REACHED, RATE_LIMIT_EXCEEDED, TIMEOUT, SERVICE_UNAVAILABLE, LIMITS_UNAVAILABLE, PLATFORM_PAUSED, INTERNAL_ERROR. type: string correlation_id: description: >- The request's correlation id, the same value as the X-Correlation-ID response header. type: string detail: description: >- What went wrong for this request, safe to show; internal and partner failures carry a generic sentence. type: string extensions: additionalProperties: true description: >- Code-specific facts, for example feature_key (FEATURE_NOT_ENABLED), field or field_violations (VALIDATION_ERROR), rail, window, limit, used, requested and remaining (TIER_LIMIT_REACHED), scope (PLATFORM_PAUSED). type: object instance: type: string request_id: description: Equal to correlation_id. type: string status: description: The HTTP status, repeated. type: integer timestamp: format: date-time type: string title: description: >- Short summary of the code, for example Validation Error or Feature Not Enabled. type: string type: description: https://api.bitnob.com/errors/{code} format: uri type: string required: - type - title - status - code - timestamp type: object ErrorInfo: properties: code: description: >- Machine-readable, for example BAD_REQUEST, NOT_FOUND, CONFLICT, ORG_NOT_ACTIVE, RATE_LIMIT_EXCEEDED, SERVICE_UNAVAILABLE, INTERNAL_ERROR. type: string details: additionalProperties: true description: >- For field validation, a map of field name to message ("email": "Email must be a valid email address"); for a body that does not decode, the offending field. type: object message: type: string required: - message type: object Pagination: description: >- List metadata. Page lists set page, per_page, total and total_pages; offset and cursor lists set limit, offset, has_more and next_cursor. Zero and empty fields are omitted, and metadata is absent when nothing is set. properties: has_more: type: boolean limit: type: integer next_cursor: description: Opaque; pass as cursor for the next page. type: string offset: type: integer page: type: integer per_page: type: integer total: type: integer total_pages: type: integer type: object PayoutsPayout: description: >- A payout or quote. 64-bit integers are sent as strings. Optional fields are absent when unset. properties: address: description: Deposit address (or Lightning invoice) for onchain payouts type: string amount: description: >- Source amount in major units of from_asset (decimal string), excluding fees type: string beneficiary: additionalProperties: true description: Beneficiary details as stored type: object beneficiary_id: format: uuid type: string btc_amount: description: Decimal BTC type: string callback_url: type: string cent_amount: description: Source amount in base units, as a string type: string cent_fees: description: Fee in base units of the source asset, as a string type: string chain: description: CHAIN_TYPE_ followed by the upper-case chain, e.g. CHAIN_TYPE_TRON type: string company_id: anyOf: - format: uuid type: string - const: '' description: Empty on the initialize response. country: description: >- ISO 3166-1 alpha-2 destination country; empty on the initialize response. type: string created_at: description: Null on the initialize response. format: date-time type: - string - 'null' customer_id: format: uuid type: string deposit_amount: description: Amount to deposit for an onchain payout (initialize response only) type: string exchange_rate: $ref: '#/components/schemas/PayoutsExchangeRate' expires_at: format: date-time type: string fee_currency: description: Denomination of fees type: string fees: description: Fee as a decimal string, in fee_currency type: string from_asset: enum: - BTC - USDT - USDC - NGN - UNSPECIFIED_ASSET type: string id: format: uuid type: string invoice_s3_key: type: string payment_reason: type: string quote_id: description: Quote identifier used by initialize and finalize type: string reference: type: string sat_amount: description: Satoshis, as a string. For BTC this is principal plus fee type: string settlement_amount: description: Amount the beneficiary receives, in major units of to_currency type: string source: description: >- SOURCE_UNSET only on the initialize response, which does not carry the source enum: - OFFCHAIN - ONCHAIN - SOURCE_UNSET type: string source_fee: description: Fee in major units of from_asset type: string status: enum: - QUOTE - INITIATED - PENDING - PENDING_ADDRESS_DEPOSIT - PROCESSING - SUCCESS - FAILED - EXPIRED - UNDERPAYMENT type: string to_currency: description: Upper-case settlement currency, e.g. NGN type: string total_amount: description: amount plus source_fee, in major units of from_asset type: string trip: $ref: '#/components/schemas/PayoutsTrip' updated_at: description: Null on the initialize response. format: date-time type: - string - 'null' required: - id - quote_id - status - source - from_asset - to_currency - amount - settlement_amount - cent_fees - fees - fee_currency - source_fee - total_amount - company_id - country - created_at - updated_at type: object PayoutsExchangeRate: description: Rate snapshot on a payout. Values are decimal strings. properties: btc_rate: description: BTC to USD rate used for BTC payouts type: string currency: description: >- Settlement currency in lower case (for example "ngn"); empty on the initialize response. type: string effective_rate: description: settlement_amount divided by amount type: string rate: description: USD to to_currency rate type: string type: object PayoutsTrip: description: >- Milestones of the payout. Each is an RFC 3339 UTC timestamp, absent until reached. properties: asset_received: format: date-time type: string completion_time: format: date-time type: string initialized_at: format: date-time type: string processing_start: format: date-time type: string quote_at: format: date-time type: string submitted: format: date-time type: string type: object headers: X-Correlation-ID: description: >- Generated for every request (any value the client sends is ignored); quote it to support. Errors repeat it as request_id and correlation_id. example: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 schema: type: string Retry-After: description: Seconds to wait before retrying. example: 1 schema: minimum: 0 type: integer X-RateLimit-Limit: description: Requests allowed per window by the per-IP limiter (500 a minute). example: 500 schema: type: integer X-RateLimit-Remaining: description: Requests left in the current window. example: 0 schema: type: integer X-RateLimit-Reset: description: Seconds until the window resets. example: 37 schema: type: integer responses: Unauthorized: content: application/json: examples: unauthorized_auth_failed: $ref: '#/components/examples/UnauthorizedAuthFailed' unauthorized_invalid_secret: $ref: '#/components/examples/UnauthorizedInvalidSecret' unauthorized_invalid_signature: $ref: '#/components/examples/UnauthorizedInvalidSignature' unauthorized_locked_out: $ref: '#/components/examples/UnauthorizedLockedOut' schema: $ref: '#/components/schemas/Problem' description: >- Authentication failed: a signing header is missing or malformed, the timestamp is more than 5 minutes off, the signature or secret is wrong, or the client is locked out after failed checks (UNAUTHORIZED). headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' RequestTimeout: content: application/json: examples: request_timeout: $ref: '#/components/examples/RequestTimeout' schema: $ref: '#/components/schemas/Problem' description: >- The request ran past its deadline (TIMEOUT); retry, with the same reference for writes. headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' TooManyRequests: content: application/json: examples: rate_limited: $ref: '#/components/examples/RateLimited' rate_limited_envelope: $ref: '#/components/examples/RateLimitedEnvelope' schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- Rate limited. The per-IP limiter (500 requests a minute) answers with a Problem and Retry-After; operation-specific throttles answer with the envelope. headers: Retry-After: $ref: '#/components/headers/Retry-After' X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' ServerError: content: application/json: examples: internal_error: $ref: '#/components/examples/InternalError' internal_error_envelope: $ref: '#/components/examples/InternalErrorEnvelope' internal_error_unhandled: $ref: '#/components/examples/InternalErrorUnhandled' schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- Something failed on our side; safe to retry idempotent requests (INTERNAL_ERROR). headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' examples: ClientInactive: summary: The API key's client is deactivated value: code: FORBIDDEN correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Client account is inactive request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 403 timestamp: '2026-10-30T09:15:02Z' title: Forbidden type: https://api.bitnob.com/errors/FORBIDDEN IPNotWhitelisted: summary: The request came from an IP not on the key's allowlist value: code: FORBIDDEN correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: IP address not whitelisted request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 403 timestamp: '2026-10-30T09:15:02Z' title: Forbidden type: https://api.bitnob.com/errors/FORBIDDEN OrgNotActive: description: Live keys only; sandbox requests pass. summary: A money-moving operation from an organisation that is not active value: error: code: ORG_NOT_ACTIVE message: >- Your organisation is not currently active. Please contact your administrator. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' OrgNotActiveLive: description: Sandbox keys are never refused this way. summary: A live key on an organisation that is not active yet value: error: code: ORG_NOT_ACTIVE message: >- Your business isn't active yet, so live isn't available. Use your sandbox keys until it's activated. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' TierLimitReached: summary: The movement would exceed the organisation's tier limit value: code: TIER_LIMIT_REACHED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: >- This payout would exceed your daily fiat outflow limit of 5000 USD (used 4200, requested 1000) extensions: direction: out limit: '5000' rail: payout remaining: '800' requested: '1000' tier: '1' unit: fiat used: '4200' window: daily request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 412 timestamp: '2026-10-30T09:15:02Z' title: Tier Limit Reached type: https://api.bitnob.com/errors/TIER_LIMIT_REACHED AuthServiceBusy: description: 'Sent with Retry-After: 1.' summary: Too many large signed bodies are being checked at once value: code: SERVICE_UNAVAILABLE correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Authentication service is busy, retry shortly request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 503 timestamp: '2026-10-30T09:15:02Z' title: Service Unavailable type: https://api.bitnob.com/errors/SERVICE_UNAVAILABLE AuthServiceUnavailable: description: 'Sent with Retry-After: 1. The detail is worded exactly like this today.' summary: The identity service could not be reached to check the credentials value: code: SERVICE_UNAVAILABLE correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Service Authentication service unavailable is currently unavailable request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 503 timestamp: '2026-10-30T09:15:02Z' title: Service Unavailable type: https://api.bitnob.com/errors/SERVICE_UNAVAILABLE LimitsUnavailable: summary: The tier limit check could not run value: code: LIMITS_UNAVAILABLE correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: >- We could not verify your account limits right now. Please try again shortly. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 503 timestamp: '2026-10-30T09:15:02Z' title: Limits Unavailable type: https://api.bitnob.com/errors/LIMITS_UNAVAILABLE PartnerUnavailable: summary: A partner or internal service is unavailable value: code: SERVICE_UNAVAILABLE correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Service is temporarily unavailable. Please try again later. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 503 timestamp: '2026-10-30T09:15:02Z' title: Service Unavailable type: https://api.bitnob.com/errors/SERVICE_UNAVAILABLE UnauthorizedAuthFailed: description: >- Returned when X-Auth-Client, X-Auth-Timestamp, X-Auth-Nonce or X-Auth-Signature is missing, the nonce is not 8 to 128 characters, the signature is not hex, or the timestamp is more than 5 minutes from the server's clock. The detail does not say which; check each. summary: A signing header is missing or malformed, or the timestamp is stale value: code: UNAUTHORIZED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Authentication failed request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 401 timestamp: '2026-10-30T09:15:02Z' title: Unauthorized type: https://api.bitnob.com/errors/UNAUTHORIZED UnauthorizedInvalidSecret: summary: 'Secret mode: the client id or secret is wrong' value: code: UNAUTHORIZED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Invalid credentials request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 401 timestamp: '2026-10-30T09:15:02Z' title: Unauthorized type: https://api.bitnob.com/errors/UNAUTHORIZED UnauthorizedInvalidSignature: description: >- The detail is the identity service's reason when it gives one (an unknown client or a reused nonce reads differently); Invalid signature otherwise. summary: The signature does not match value: code: UNAUTHORIZED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Invalid signature request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 401 timestamp: '2026-10-30T09:15:02Z' title: Unauthorized type: https://api.bitnob.com/errors/UNAUTHORIZED UnauthorizedLockedOut: summary: Too many failed credential checks value: code: UNAUTHORIZED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Too many failed credential checks; retry later request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 401 timestamp: '2026-10-30T09:15:02Z' title: Unauthorized type: https://api.bitnob.com/errors/UNAUTHORIZED RequestTimeout: summary: The request ran past its deadline value: code: TIMEOUT correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: The request took too long to complete. Please try again. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 408 timestamp: '2026-10-30T09:15:02Z' title: Request Timeout type: https://api.bitnob.com/errors/TIMEOUT RateLimited: summary: The per-IP limit (500 requests a minute) is reached value: code: RATE_LIMIT_EXCEEDED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Too many requests. Please try again later. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 429 timestamp: '2026-10-30T09:15:02Z' title: Rate Limit Exceeded type: https://api.bitnob.com/errors/RATE_LIMIT_EXCEEDED RateLimitedEnvelope: summary: An operation-specific throttle (answered by the handler) value: error: code: RATE_LIMIT_EXCEEDED message: >- a verification link was sent to this customer in the last minute; try again shortly request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' InternalError: summary: Something failed on our side value: code: INTERNAL_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: An internal error occurred. Please try again later. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 500 timestamp: '2026-10-30T09:15:02Z' title: Internal Server Error type: https://api.bitnob.com/errors/INTERNAL_ERROR InternalErrorEnvelope: summary: A failure answered by the handler value: error: code: INTERNAL_ERROR message: Failed to list transactions request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' InternalErrorUnhandled: summary: An unexpected failure value: code: INTERNAL_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: An internal server error occurred request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 500 timestamp: '2026-10-30T09:15:02Z' title: Internal Server Error type: https://api.bitnob.com/errors/INTERNAL_ERROR securitySchemes: BitnobClientId: type: apiKey in: header name: X-Auth-Client description: | Your workspace client id. All calls must include four headers: - `X-Auth-Client` — your workspace client id - `X-Auth-Timestamp` — Unix seconds - `X-Auth-Nonce` — 16-byte random hex - `X-Auth-Signature` — hex(HMAC-SHA256( `{client_id}:{timestamp}:{nonce}:{raw_body}`, client_secret)) The playground computes the timestamp, nonce and signature for you. BitnobClientSecret: type: apiKey in: header name: X-Playground-Client-Secret description: > Your sandbox client secret. The playground uses it to sign the request in your browser and removes it before the request is sent. Never send your client secret as a header in your own integration. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.