> ## 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. # List cards > Lists your cards, excluding team-member cards (see GET /api/cards/team-members). ## OpenAPI ````yaml /api-collections/swagger/bitnob-api-v2.openapi.json get /api/cards 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/cards: get: tags: - Cards summary: List cards description: >- Lists your cards, excluding team-member cards (see GET /api/cards/team-members). operationId: cardsList parameters: - description: Only cards held by this customer. example: 019a3b5c-3e5f-7a1b-8c2d-4e5f6a7b8c61 in: query name: customer_id required: false schema: type: string - description: Only this card. example: 019a3b5c-2c4d-7e6f-8a9b-0c1d2e3f4a51 in: query name: card_id required: false schema: format: uuid type: string - description: >- Comma-separated card statuses (pending, active, frozen, blocked, pending_termination, terminated, failed). example: active,frozen in: query name: status required: false schema: type: string - description: Comma-separated card types (virtual, physical, lite). example: virtual in: query name: card_type required: false schema: type: string - description: Card currency. example: USD in: query name: currency required: false schema: type: string - description: Card reference. example: ref_sbx_4f9c2a71 in: query name: reference required: false schema: type: string - description: Only cards with (true) or without (false) a stablecoin address. example: false in: query name: has_address required: false schema: type: boolean - description: 'Page size. Clamped to at most 50. Alias: limit.' example: 20 in: query name: first required: false schema: maximum: 50 minimum: 1 type: integer - description: Alias of first. example: 20 in: query name: limit required: false schema: maximum: 50 minimum: 1 type: integer - description: 'Cursor from page_info.next_cursor. Alias: cursor.' example: >- eyJ0aW1lc3RhbXAiOiIyMDI2LTEwLTI5VDE4OjQwOjEyWiIsImlkIjoiMDE5YTNiNWMtMmM0ZC03ZTZmLTlhOWItMGMxZDJlM2Y0YTUyIn0 in: query name: after required: false schema: type: string - description: Alias of after. example: >- eyJ0aW1lc3RhbXAiOiIyMDI2LTEwLTI5VDE4OjQwOjEyWiIsImlkIjoiMDE5YTNiNWMtMmM0ZC03ZTZmLTlhOWItMGMxZDJlM2Y0YTUyIn0 in: query name: cursor required: false schema: type: string - description: Created at or after (RFC3339). Cannot be combined with period. example: '2026-10-01T00:00:00Z' in: query name: created_after required: false schema: format: date-time type: string - description: Created at or before (RFC3339). Cannot be combined with period. example: '2026-10-30T23:59:59Z' in: query name: created_before required: false schema: format: date-time type: string - description: Creation-date window. custom needs start_date and end_date. example: last_1_month in: query name: period required: false schema: enum: - all_time - last_7_days - last_1_month - last_3_months - last_6_months - last_12_months - year_to_date - custom type: string - description: Start for period=custom (RFC3339 or YYYY-MM-DD). example: '2026-10-01' in: query name: start_date required: false schema: type: string - description: End for period=custom (RFC3339 or YYYY-MM-DD). example: '2026-10-30' in: query name: end_date required: false schema: type: string - description: Minimum spend, micro-units (1 USD = 1,000,000). example: 0 in: query name: spending_min required: false schema: format: int64 minimum: 0 type: integer - description: Maximum spend, micro-units. Must not be below spending_min. example: 500000000 in: query name: spending_max required: false schema: format: int64 minimum: 0 type: integer - description: Minimum balance, micro-units. example: 1000000 in: query name: balance_min required: false schema: format: int64 minimum: 0 type: integer - description: Maximum balance, micro-units. Must not be below balance_min. example: 2500000000 in: query name: balance_max required: false schema: format: int64 minimum: 0 type: integer - description: Exactly 4 digits. example: '4242' in: query name: last_four_digit required: false schema: pattern: ^[0-9]{4}$ type: string - description: Exactly 6 digits. example: '000000' in: query name: first_six_digit required: false schema: pattern: ^[0-9]{6}$ type: string - description: Cardholder name, at most 255 characters. example: Adaeze Okafor in: query name: cardholder_name required: false schema: maxLength: 255 type: string - description: Cardholder email, at most 255 characters. example: adaeze.okafor@example.com in: query name: email required: false schema: maxLength: 255 type: string - description: Free-text search, at most 255 characters. example: Okafor in: query name: search required: false schema: maxLength: 255 type: string - description: Card brand. example: visa in: query name: card_brand required: false schema: enum: - visa - mastercard type: string - description: Provisioning status (processing, completed, failed). example: completed in: query name: created_status required: false schema: type: string - description: Contactless enabled. example: false in: query name: contactless_payment required: false schema: type: boolean - description: Only cards with (true) or without (false) a webhook_url. example: true in: query name: has_webhook required: false schema: type: boolean - description: Channel the card was created from. example: api in: query name: initiated_from required: false schema: type: string - description: Stablecoin network of the card address. example: base in: query name: stablecoin_network required: false schema: type: string responses: '200': content: application/json: examples: empty: summary: No card matches the filters value: data: cards: [] page_info: has_next_page: false has_previous_page: false message: Cards retrieved successfully success: true timestamp: '2026-10-30T09:15:02.481Z' first_page: summary: First page of two, more to come value: data: cards: - available_actions: - FUND - WITHDRAW - FREEZE - UPDATE_LIMITS - TERMINATE balance_amount: '25000000' balance_breakdown: null balance_currency: USD billing_address: city: Miami country: United States line1: 3401 N. Miami, Ave. Ste 230 line2: '' postal_code: '33127' state: Florida business_spend: null card_brand: visa card_limits: daily_limit: '500000000' transaction_limit: '100000000' card_program: prepaid card_type: virtual company_id: 019a3b5c-1a2b-7c3d-8e4f-5a6b7c8d9e01 contactless_payment: false created_at: '2026-10-28T14:02:11Z' created_by: 019a3b5c-1a2b-7c3d-8e4f-5a6b7c8d9e01 created_status: completed customer_id: 019a3b5c-3e5f-7a1b-8c2d-4e5f6a7b8c61 display_amount: 25 first_six_digit: '000000' id: 019a3b5c-2c4d-7e6f-8a9b-0c1d2e3f4a51 last_four_digit: '4242' masked_pan: 000000******4242 name: Adaeze Okafor nickname: '' reference: ref_sbx_4f9c2a71 status: active updated_at: '2026-10-30T09:14:58Z' user_metadata: '{"employee_id":"E-1042"}' webhook_url: https://example.com/webhooks/cards - available_actions: - UNFREEZE - UPDATE_LIMITS - TERMINATE balance_amount: '0' balance_breakdown: null balance_currency: USD billing_address: city: Miami country: United States line1: 3401 N. Miami, Ave. Ste 230 line2: '' postal_code: '33127' state: Florida business_spend: null card_brand: mastercard card_limits: null card_program: prepaid card_type: virtual company_id: 019a3b5c-1a2b-7c3d-8e4f-5a6b7c8d9e01 contactless_payment: false created_at: '2026-10-21T08:30:45Z' created_by: 019a3b5c-1a2b-7c3d-8e4f-5a6b7c8d9e01 created_status: completed customer_id: 019a3b5c-3e5f-7a1b-8c2d-4e5f6a7b8c63 display_amount: 0 first_six_digit: '000000' id: 019a3b5c-2c4d-7e6f-9a9b-0c1d2e3f4a52 last_four_digit: '8810' masked_pan: 000000******8810 name: Tunde Bakare nickname: '' reference: ref_sbx_9b21c7e0 status: frozen updated_at: '2026-10-29T18:40:12Z' user_metadata: '{}' page_info: has_next_page: true has_previous_page: false next_cursor: >- eyJ0aW1lc3RhbXAiOiIyMDI2LTEwLTI5VDE4OjQwOjEyWiIsImlkIjoiMDE5YTNiNWMtMmM0ZC03ZTZmLTlhOWItMGMxZDJlM2Y0YTUyIn0 message: Cards retrieved successfully success: true timestamp: '2026-10-30T09:15:02.481Z' schema: allOf: - $ref: '#/components/schemas/Envelope' - properties: data: $ref: '#/components/schemas/CardsCardPage' type: object description: OK '400': content: application/json: examples: invalid_card_brand: summary: card_brand is not visa or mastercard value: error: code: BAD_REQUEST message: Invalid card_brand, expected visa or mastercard request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00a1 success: false timestamp: '2026-10-30T09:15:02.481Z' invalid_card_id: summary: card_id is not a UUID value: error: code: BAD_REQUEST message: Invalid card_id, expected a UUID request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f009c success: false timestamp: '2026-10-30T09:15:02.481Z' invalid_last_four: summary: last_four_digit is not 4 digits value: error: code: BAD_REQUEST message: Invalid last_four_digit, expected exactly 4 digits request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f009d success: false timestamp: '2026-10-30T09:15:02.481Z' invalid_period: summary: Unknown period value: error: code: BAD_REQUEST message: >- invalid period: must be one of all_time, last_7_days, last_1_month, last_3_months, last_6_months, last_12_months, year_to_date, custom request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00a0 success: false timestamp: '2026-10-30T09:15:02.481Z' period_with_dates: summary: period combined with created_after/created_before value: error: code: BAD_REQUEST message: >- period cannot be combined with created_after/created_before request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f009f success: false timestamp: '2026-10-30T09:15:02.481Z' spending_range: summary: spending_min is above spending_max value: error: code: BAD_REQUEST message: spending_min must not exceed spending_max request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f009e success: false timestamp: '2026-10-30T09:15:02.481Z' schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- A filter is malformed. The handler answers with the envelope; the card service answers an unknown status, card_type value with a Problem (VALIDATION_ERROR). headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '408': $ref: '#/components/responses/RequestTimeout' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' '503': $ref: '#/components/responses/ServiceUnavailable' 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 CardsCardPage: properties: cards: items: $ref: '#/components/schemas/CardsCard' type: array page_info: $ref: '#/components/schemas/CardsPageInfo' 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 CardsCard: description: A card. Optional string fields are omitted when unset. properties: available_actions: items: enum: - FUND - WITHDRAW - FREEZE - UNFREEZE - TERMINATE - UPDATE_LIMITS type: string type: array balance_amount: description: Balance, micro-units (1 USD = 1,000,000). pattern: ^-?[0-9]+$ type: string balance_breakdown: description: >- Null without a live balance read (lists, terminated cards, read failure). oneOf: - $ref: '#/components/schemas/CardsBalanceBreakdown' - type: 'null' balance_currency: type: string billing_address: oneOf: - $ref: '#/components/schemas/CardsBillingAddress' - type: 'null' business_spend: oneOf: - $ref: '#/components/schemas/CardsBusinessSpend' - type: 'null' card_brand: type: string card_limits: oneOf: - $ref: '#/components/schemas/CardsCardLimits' - type: 'null' card_program: enum: - prepaid - collateral - collateral_business type: string card_type: enum: - virtual - physical - lite type: string company_id: format: uuid type: string contactless_payment: type: boolean created_at: format: date-time type: string created_by: type: string created_status: enum: - processing - completed - failed type: string customer_id: format: uuid type: string display_amount: description: Balance in major units (USD). type: number display_spent_current_month: type: number display_topup_current_month: type: number failure_reason: type: string first_six_digit: description: >- Always "000000": the BIN is redacted on every card, including one still provisioning (empty masked_pan). type: string id: format: uuid type: string last_four_digit: type: string masked_pan: type: string name: type: string nickname: description: Company label; empty when none. type: string preferred_name: type: string reference: type: string spent_current_month: description: Present when aggregates are included, micro-units. pattern: ^-?[0-9]+$ type: string stablecoin_address: type: string stablecoin_network: type: string status: enum: - pending - active - frozen - blocked - pending_termination - terminated - failed type: string terminated_at: type: string termination_reason: type: string topup_current_month: description: Present when aggregates are included, micro-units. pattern: ^-?[0-9]+$ type: string updated_at: format: date-time type: string user_metadata: description: JSON string; "{}" when unset. type: string webhook_url: type: string required: - id - company_id - customer_id - card_type - status - created_status - masked_pan - balance_amount - balance_currency - card_program - available_actions - display_amount - contactless_payment - card_limits - nickname - business_spend - balance_breakdown - user_metadata - billing_address - created_by - created_at - updated_at type: object CardsPageInfo: description: Cursor pagination state. properties: has_next_page: type: boolean has_previous_page: type: boolean next_cursor: type: string previous_cursor: type: string total: format: int32 type: integer type: object CardsBalanceBreakdown: description: Live split of balance_amount. properties: amount_due: description: Owed to our partner, micro-units. pattern: ^-?[0-9]+$ type: string as_of: description: When our partner was read; may be cached up to 5 minutes. format: date-time type: string available: description: Spendable now, micro-units. Equals balance_amount. pattern: ^-?[0-9]+$ type: string currency: description: ISO 4217. type: string non_withdrawable: description: Spendable but not withdrawable, micro-units. pattern: ^-?[0-9]+$ type: string pending: description: >- Authorization holds, micro-units; null when our partner does not report them. pattern: ^-?[0-9]+$ type: - string - 'null' scope: enum: - CARD - SHARED_POOL type: string withdrawable: description: Withdrawable, micro-units. pattern: ^-?[0-9]+$ type: string type: object CardsBillingAddress: properties: city: type: string country: type: string line1: type: string line2: type: string postal_code: type: string state: type: string type: object CardsBusinessSpend: description: Business card limit and spend, in cents. properties: available_to_spend: description: Cents. format: int64 type: integer limit_amount: description: Cents; 0 means no card limit. format: int64 type: integer limit_frequency: description: Empty means no card limit. type: string spent_in_period: description: Cents. format: int64 type: integer type: object CardsCardLimits: description: Set limits only; unset keys are omitted. properties: all_time_limit: description: all_time_limit, micro-units. pattern: ^-?[0-9]+$ type: string daily_limit: description: daily_limit, micro-units. pattern: ^-?[0-9]+$ type: string monthly_limit: description: monthly_limit, micro-units. pattern: ^-?[0-9]+$ type: string transaction_limit: description: transaction_limit, micro-units. pattern: ^-?[0-9]+$ type: string weekly_limit: description: weekly_limit, micro-units. pattern: ^-?[0-9]+$ type: string yearly_limit: description: yearly_limit, micro-units. pattern: ^-?[0-9]+$ 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' Forbidden: content: application/json: examples: account_transactions_paused: $ref: '#/components/examples/AccountTransactionsPaused' client_inactive: $ref: '#/components/examples/ClientInactive' feature_not_enabled: $ref: '#/components/examples/FeatureNotEnabled' ip_not_whitelisted: $ref: '#/components/examples/IPNotWhitelisted' org_not_active: $ref: '#/components/examples/OrgNotActive' org_not_active_live: $ref: '#/components/examples/OrgNotActiveLive' tier_product_locked: $ref: '#/components/examples/TierProductLocked' schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- Not allowed: the request's IP is not on the key's allowlist, the client is inactive, a live key is used before the organisation is active (ORG_NOT_ACTIVE), a feature is off (FEATURE_NOT_ENABLED), or the organisation's tier does not include the product (TIER_PRODUCT_LOCKED). 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' ServiceUnavailable: content: application/json: examples: auth_service_busy: $ref: '#/components/examples/AuthServiceBusy' auth_service_unavailable: $ref: '#/components/examples/AuthServiceUnavailable' limits_unavailable: $ref: '#/components/examples/LimitsUnavailable' platform_paused: $ref: '#/components/examples/PlatformPaused' partner_unavailable: $ref: '#/components/examples/PartnerUnavailable' service_unavailable_envelope: $ref: '#/components/examples/ServiceUnavailableEnvelope' schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- Temporarily unavailable; retry later. The identity service could not check the credentials (sent with Retry-After), a partner is down (SERVICE_UNAVAILABLE), the limits check could not run (LIMITS_UNAVAILABLE), or a platform control paused money movement (PLATFORM_PAUSED). headers: Retry-After: $ref: '#/components/headers/Retry-After' X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' examples: 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 AccountTransactionsPaused: summary: Money movement is paused on this account value: code: FEATURE_NOT_ENABLED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: >- Transactions on this account are currently paused. Contact support if you did not request this. extensions: feature_key: send_fiat request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 403 timestamp: '2026-10-30T09:15:02Z' title: Account Transactions Paused type: https://api.bitnob.com/errors/FEATURE_NOT_ENABLED 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 FeatureNotEnabled: description: feature_key names the feature that refused the call. summary: The feature is off for this organisation value: code: FEATURE_NOT_ENABLED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: The fiat payouts feature is currently not available. extensions: feature_key: send_fiat request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 403 timestamp: '2026-10-30T09:15:02Z' title: Feature Not Enabled type: https://api.bitnob.com/errors/FEATURE_NOT_ENABLED 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' TierProductLocked: summary: The organisation's tier does not include the product value: code: TIER_PRODUCT_LOCKED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: >- Your account's tier 1 does not include USD wire transfers. Upgrade to tier 2 to unlock it. extensions: product: usd_wire required_tier: '2' tier: '1' request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 403 timestamp: '2026-10-30T09:15:02Z' title: Not Available On Your Tier type: https://api.bitnob.com/errors/TIER_PRODUCT_LOCKED 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 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 PlatformPaused: summary: Money movement is paused by a platform control value: code: PLATFORM_PAUSED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: >- Money movement is temporarily paused. Nothing is lost — requests can be retried once the pause lifts. extensions: scope: asset:BTC request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 503 timestamp: '2026-10-30T09:15:02Z' title: Money Movement Paused type: https://api.bitnob.com/errors/PLATFORM_PAUSED 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 ServiceUnavailableEnvelope: summary: Unavailable (answered by the handler) value: error: code: SERVICE_UNAVAILABLE message: LNURL payments are temporarily disabled request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' 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.