> ## 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 transactions > Lists your transactions, newest first. To get the next page, pass next_cursor as cursor. ## OpenAPI ````yaml /api-collections/swagger/bitnob-api-v2.openapi.json get /api/transactions 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/transactions: get: tags: - Transactions summary: List transactions description: >- Lists your transactions, newest first. To get the next page, pass next_cursor as cursor. operationId: transactionsList parameters: - example: eyJ0IjoiMjAyNi0xMC0yOVQxNjo0MjoxMFoiLCJpZCI6IjAxOWEzZDAyIn0 in: query name: cursor required: false schema: type: string description: Cursor from the previous page. - description: Values below 1 use the default of 25; the handler caps values at 50 example: 25 in: query name: limit required: false schema: default: 25 maximum: 50 minimum: 1 type: integer - example: USDT in: query name: currency required: false schema: example: USDT type: string description: Filter by currency. - example: payout_ref_20261030_0007 in: query name: reference required: false schema: type: string description: Filter by your reference. - example: payout_ref_20261030_0007 in: query name: idempotency_key required: false schema: type: string description: Filter by idempotency key. - description: Ledger state, for example PENDING or SETTLED example: SETTLED in: query name: status required: false schema: type: string - description: >- Ledger transaction type, for example DEPOSIT_CONFIRMED or P2P_TRANSFER example: DEPOSIT_CONFIRMED in: query name: type required: false schema: type: string - description: Passed to the ledger as given, for example inflow or outflow example: inflow in: query name: direction required: false schema: type: string - example: DATE_RANGE_CUSTOM in: query name: date_range required: false schema: enum: - DATE_RANGE_UNSPECIFIED - DATE_RANGE_TODAY - DATE_RANGE_LAST_7_DAYS - DATE_RANGE_LAST_30_DAYS - DATE_RANGE_LAST_90_DAYS - DATE_RANGE_CUSTOM type: string description: >- Preset date range. Use DATE_RANGE_CUSTOM with start_date and end_date. - example: '2026-10-01' in: query name: start_date required: false schema: type: string description: Start of a custom date range, YYYY-MM-DD. - example: '2026-10-30' in: query name: end_date required: false schema: type: string description: End of a custom date range, YYYY-MM-DD. - example: false in: query name: ascending required: false schema: default: false type: boolean description: true returns the oldest first. - description: >- JSON object of string metadata filters, for example {"order_id":"123"} example: '{"order_id":"ord_sbx_1042"}' in: query name: metadata required: false schema: type: string responses: '200': content: application/json: examples: first_page: summary: A page with more to come value: data: has_more: true next_cursor: >- eyJ0IjoiMjAyNi0xMC0yOVQxNjo0MjoxMFoiLCJpZCI6IjAxOWEzZDAyIn0 total_count: 128 transactions: - account_number: '3000000002' amount: '125000000' amount_formatted: '125' created_at: '2026-10-30T08:01:55Z' currency: USDT fee: '1000000' fee_formatted: '1' idempotency_key: payout_ref_20261030_0007 metadata: order_id: ord_sbx_1042 reference: payout_ref_20261030_0007 side: Debit state: PENDING trade_id: 019a3d05-0a1b-7c2d-9e3f-4a5b6c7d8e03 transaction_id: 019a3d05-1c2d-7e3f-8a40-5b6c7d8e9f02 type: P2P_TRANSFER updated_at: '2026-10-30T08:01:55Z' value_date: '2026-10-30' - account_number: '3000000002' amount: '500000000' amount_formatted: '500' created_at: '2026-10-29T16:42:10Z' currency: USDT fee: '0' fee_formatted: '0' idempotency_key: >- deposit:tron:0x5f1c0000000000000000000000000000000000000000000000000000000a91e2 metadata: chain: tron customer_id: 019a3c10-5e6f-7a80-9b1c-2d3e4f5a6b70 reference: dep_sbx_8c21f0a4 side: Credit state: SETTLED transaction_id: 019a3d02-6b7c-7d8e-9f01-2a3b4c5d6e71 type: DEPOSIT_CONFIRMED updated_at: '2026-10-29T16:44:31Z' value_date: '2026-10-29' message: Transactions retrieved successfully success: true timestamp: '2026-10-30T09:15:02.481Z' last_page: summary: 'The last page: no next_cursor, has_more omitted' value: data: previous_cursor: >- eyJ0IjoiMjAyNi0xMC0zMFQwODowMTo1NVoiLCJpZCI6IjAxOWEzZDA1In0 total_count: 128 transactions: - account_number: '3000000002' amount: '500000000' amount_formatted: '500' created_at: '2026-10-29T16:42:10Z' currency: USDT fee: '0' fee_formatted: '0' idempotency_key: >- deposit:tron:0x5f1c0000000000000000000000000000000000000000000000000000000a91e2 metadata: chain: tron customer_id: 019a3c10-5e6f-7a80-9b1c-2d3e4f5a6b70 reference: dep_sbx_8c21f0a4 side: Credit state: SETTLED transaction_id: 019a3d02-6b7c-7d8e-9f01-2a3b4c5d6e71 type: DEPOSIT_CONFIRMED updated_at: '2026-10-29T16:44:31Z' value_date: '2026-10-29' message: Transactions retrieved successfully success: true timestamp: '2026-10-30T09:15:02.481Z' no_matches: summary: No transaction matches the filters value: data: {} message: Transactions retrieved successfully success: true timestamp: '2026-10-30T09:15:02.481Z' schema: allOf: - $ref: '#/components/schemas/Envelope' - properties: data: $ref: '#/components/schemas/TransactionsList' type: object description: OK '400': $ref: '#/components/responses/BadRequest' '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_live: $ref: '#/components/examples/OrgNotActiveLive' 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, or a live key is used before the organisation is active (ORG_NOT_ACTIVE). headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' '408': $ref: '#/components/responses/RequestTimeout' '429': $ref: '#/components/responses/TooManyRequests' '500': content: application/json: examples: internal_error_unhandled: $ref: '#/components/examples/InternalErrorUnhandled' schema: $ref: '#/components/schemas/Problem' description: Something failed on our side; safe to retry (INTERNAL_ERROR). headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' '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 TransactionsList: properties: has_more: type: boolean next_cursor: type: string previous_cursor: type: string total_count: format: int32 type: integer transactions: items: $ref: '#/components/schemas/TransactionsTransaction' type: array 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 TransactionsTransaction: description: Empty fields are omitted. properties: account_number: type: string amount: description: Net amount in the currency's base units type: string amount_formatted: description: Human-readable amount type: string created_at: format: date-time type: string currency: type: string fee: description: Fee in the currency's base units type: string fee_formatted: type: string idempotency_key: type: string metadata: additionalProperties: type: string type: object reference: type: string side: enum: - Credit - Debit type: string state: description: For example PENDING, SETTLED type: string trade_id: description: Only on list items type: string transaction_id: type: string type: description: For example DEPOSIT_CONFIRMED, P2P_TRANSFER type: string updated_at: format: date-time type: string value_date: format: date type: string type: object responses: BadRequest: content: application/json: examples: bad_request_field_validation: $ref: '#/components/examples/BadRequestFieldValidation' bad_request_malformed_json: $ref: '#/components/examples/BadRequestMalformedJSON' bad_request_wrong_type: $ref: '#/components/examples/BadRequestWrongType' invalid_auth_timestamp: $ref: '#/components/examples/InvalidAuthTimestamp' validation_error_field_violations: $ref: '#/components/examples/ValidationErrorFieldViolations' validation_error_problem: $ref: '#/components/examples/ValidationErrorProblem' schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- The request is invalid. Body and field checks in the handler answer with the envelope (BAD_REQUEST, details naming each field); checks in the service behind it answer with a Problem (VALIDATION_ERROR). headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' 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' 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: 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 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' 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 BadRequestFieldValidation: description: >- The handler's field checks: details maps each failing field to a message. summary: A field failed validation value: error: code: BAD_REQUEST details: customer_type: 'Customer type must be one of: individual business' email: Email must be a valid email address message: Validation failed request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' BadRequestMalformedJSON: summary: The body is not valid JSON value: error: code: BAD_REQUEST message: 'Invalid request body: malformed JSON at byte 42' request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' BadRequestWrongType: summary: A field has the wrong JSON type value: error: code: BAD_REQUEST details: field: amount message: 'Invalid request body: amount must be a string, got number' request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' InvalidAuthTimestamp: summary: X-Auth-Timestamp is not a number value: code: VALIDATION_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Invalid timestamp format 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 ValidationErrorFieldViolations: summary: A service rejected several fields value: code: VALIDATION_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: invalid request extensions: field_violations: - description: must be greater than zero field: amount - description: unsupported chain field: chain 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 ValidationErrorProblem: summary: A service rejected a field value: code: VALIDATION_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: phone_number is not a valid phone number for NG extensions: field: phone_number 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 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' 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' 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 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.