{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/legacy-api/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Banxa API Documentation","description":"Official Banxa API documentation – on-ramp and off-ramp transfers with identity verification and compliance.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If any request returns an error it will be in the following format:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Format"},"children":["Format"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["errors.status"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The HTTP Status code of the error"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["errrors.code"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["(optional) The internal code of the error. Use this to communicate with Banxa Support"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["errors.title"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The title of the error"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["errors.description"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["(optional) A more detailed description of the error"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"errors\": [\n    {\n      \"status\": \"40103\",\n      \"code\": \"401\",\n      \"title\": \"You are not authorized to access this resource.\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API uses the following HTTP Codes:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["200"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Successful -- Your request was successful"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Bad Request -- Your request is invalid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Unauthorized -- Your API key is incorrect or the packet was malformed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Forbidden -- The request is not allowed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Not Found -- The resource could not be found."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["405"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Method Not Allowed -- You tried to access an invalid method."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["406"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Not Acceptable -- You requested a format that isn't json."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["410"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Gone -- The requested resource has been removed from our servers."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["422"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Invalid request -- Something in the payload was either missing or malformed"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["429"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Too Many Requests -- You have hit your allowance for calling the API"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["500"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Internal Server Error -- We had a problem with our server. Try again later."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["503"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Service Unavailable -- We're temporarily offline for maintenance. Please try again later."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API uses the following Error Statuses:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["1"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Order not found"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["227"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Customer's account has temporarily been placed on hold"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["228"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Customer has reached their payment limit"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["305"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["We are waiting for funds to arrive for a customer from a previous order"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["999"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["System error"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["4002"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Validation error"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["4007"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The selected payment is not available"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["40001"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Hmac Error - Nonce must be a valid unix timestamp"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["40002"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Hmac Error - Nonce time is too different from our system. Please regenerate nonce using current UTC"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["40003"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Hmac Error - Nonce has been used before. Please regenerate the nonce and try again"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["40100"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Hmac Error - Merchant not found"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["40101"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Hmac Error - Auth digest is malformed"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["40102"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Hmac Error - Authentication header is missing"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["40103"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Hmac Error - Payload signature can not be authenticated"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["40104"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Hmac Error - Invalid API key"]}]}]}]}]}]},"headings":[],"frontmatter":{"title":"Errors","seo":{"title":""}},"lastModified":"2026-05-19T23:30:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/legacy-api/docs/resources/errors","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}