{"items":[{"type":"link","label":"Legacy API","link":"/products/legacy-api/openapi","routeSlug":"/products/legacy-api/openapi","content":{"contentType":"overview","meta":{"name":"Legacy API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/products/legacy-api/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/products/legacy-api/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Legacy API (1.3)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the complete documentation index, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.banxa.com/llms.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"llms.txt"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Append "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".md"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to any page URL for its markdown version."},"children":[]}]}]}]}]}],"sectionId":"/products/legacy-api/openapi"}],"sectionId":"/products/legacy-api/openapi"}]}]}},{"label":"Get Fiat Currencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/get-fiat-currencies","routeSlug":"/products/legacy-api/openapi/other/get-fiat-currencies","metadata":{"seo":{"title":"Get Fiat Currencies","description":"Retrieve all available fiat currencies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-fiat-currencies","name":"Get Fiat Currencies","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1fiats~1{orderType}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Fiat Currencies","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all available fiat currencies"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderType","in":"path","schemaId":"schema_100","description":"Determines availability for Buy or Sell orders","required":true}],"pointer":"/paths/~1api~1fiats~1{orderType}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102","description":"This is the correlation ID related to the request."}],"pointer":"/paths/~1api~1fiats~1{orderType}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/fiats/{orderType}","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[{"name":"orderType","in":"path","required":true,"schemaId":"schema_100"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102"}],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/fiats/{orderType}","href":"other/get-fiat-currencies","openApiOperationId":"get-fiat-currencies","summary":"Get Fiat Currencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103","exampleIds":["paths/~1api~1fiats~1{orderType}/get/responses/200/content/application~1json/examples/Result"]}},"schemaId":"schema_103","exampleIds":["paths/~1api~1fiats~1{orderType}/get/responses/200/content/application~1json/examples/Result"]}],"pointer":"/paths/~1api~1fiats~1{orderType}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_103","exampleIds":["paths/~1api~1fiats~1{orderType}/get/responses/200/content/application~1json/examples/Result"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103","exampleIds":["paths/~1api~1fiats~1{orderType}/get/responses/200/content/application~1json/examples/Result"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/get-fiat-currencies"}],"panels":[]}]},"httpPath":"/api/fiats/{orderType}"},{"label":"Get Cryptocurrencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/get-crypto-currencies","routeSlug":"/products/legacy-api/openapi/other/get-crypto-currencies","metadata":{"seo":{"title":"Get Cryptocurrencies","description":"Retrieve all available cryptocurrencies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-crypto-currencies","name":"Get Cryptocurrencies","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1coins~1{orderType}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cryptocurrencies","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all available cryptocurrencies"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderType","in":"path","schemaId":"schema_100","description":"Determines available cryptocurrencies for a Buy or a Sell order","required":true}],"pointer":"/paths/~1api~1coins~1{orderType}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102","description":"This is the correlation ID related to the request."}],"pointer":"/paths/~1api~1coins~1{orderType}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/coins/{orderType}","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[{"name":"orderType","in":"path","required":true,"schemaId":"schema_100"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102"}],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/coins/{orderType}","href":"other/get-crypto-currencies","openApiOperationId":"get-crypto-currencies","summary":"Get Cryptocurrencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1coins~1{orderType}/get/responses/200/content/application~1json/examples/Result"]}},"exampleIds":["paths/~1api~1coins~1{orderType}/get/responses/200/content/application~1json/examples/Result"]}],"pointer":"/paths/~1api~1coins~1{orderType}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1api~1coins~1{orderType}/get/responses/200/content/application~1json/examples/Result"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1coins~1{orderType}/get/responses/200/content/application~1json/examples/Result"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/get-crypto-currencies"}],"panels":[]}]},"httpPath":"/api/coins/{orderType}"},{"label":"Get Countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/get-countries","routeSlug":"/products/legacy-api/openapi/other/get-countries","metadata":{"seo":{"title":"Get Countries","description":"Retrieve all available countries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-countries","name":"Get Countries","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Countries","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all available countries"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102","description":"This is the correlation ID related to the request."}],"pointer":"/paths/~1api~1countries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/countries","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102"}],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/countries","href":"other/get-countries","openApiOperationId":"get-countries","summary":"Get Countries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104","exampleIds":["paths/~1api~1countries/get/responses/200/content/application~1json/examples/Result"]}},"schemaId":"schema_104","exampleIds":["paths/~1api~1countries/get/responses/200/content/application~1json/examples/Result"]}],"pointer":"/paths/~1api~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_104","exampleIds":["paths/~1api~1countries/get/responses/200/content/application~1json/examples/Result"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104","exampleIds":["paths/~1api~1countries/get/responses/200/content/application~1json/examples/Result"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/get-countries"}],"panels":[]}]},"httpPath":"/api/countries"},{"label":"Get US States","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/get-us-states","routeSlug":"/products/legacy-api/openapi/other/get-us-states","metadata":{"seo":{"title":"Get US States","description":"Retrieve all available US States"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-us-states","name":"Get US States","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1countries~1us~1states/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get US States","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all available US States"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102","description":"This is the correlation ID related to the request."}],"pointer":"/paths/~1api~1countries~1us~1states/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/countries/us/states","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102"}],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/countries/us/states","href":"other/get-us-states","openApiOperationId":"get-us-states","summary":"Get US States"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_105","exampleIds":["paths/~1api~1countries~1us~1states/get/responses/200/content/application~1json/examples/Result"]}},"schemaId":"schema_105","exampleIds":["paths/~1api~1countries~1us~1states/get/responses/200/content/application~1json/examples/Result"]}],"pointer":"/paths/~1api~1countries~1us~1states/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_105","exampleIds":["paths/~1api~1countries~1us~1states/get/responses/200/content/application~1json/examples/Result"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_105","exampleIds":["paths/~1api~1countries~1us~1states/get/responses/200/content/application~1json/examples/Result"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/get-us-states"}],"panels":[]}]},"httpPath":"/api/countries/us/states"},{"label":"Get Payment Methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/get-payment-methods","routeSlug":"/products/legacy-api/openapi/other/get-payment-methods","metadata":{"seo":{"title":"Get Payment Methods","description":"Retrieve all possible payment methods or filter the available by a fiat or coin code. The type of exchange is determined based on the codes provided to the source and target."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-payment-methods","name":"Get Payment Methods","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1payment-methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Payment Methods","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all possible payment methods or filter the available by a fiat or coin code. The type of exchange is determined based on the codes provided to the source and target."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the payment has a supported_agents field which is not null then there are limitations for accessing this payment by browser and operating system. To avoid the payment failing please block customers from accessing those payments from the wrong device"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"source","in":"query","schemaId":"schema_106","description":"Source currency or cryptocurrency code."},{"name":"target","in":"query","schemaId":"schema_107","description":"Source currency or cryptocurrency code."}],"pointer":"/paths/~1api~1payment-methods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102","description":"This is the correlation ID related to the request."}],"pointer":"/paths/~1api~1payment-methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/payment-methods","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[],"query":[{"name":"source","in":"query","schemaId":"schema_106"},{"name":"target","in":"query","schemaId":"schema_107"}],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102"}],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/payment-methods","href":"other/get-payment-methods","openApiOperationId":"get-payment-methods","summary":"Get Payment Methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108","exampleIds":["paths/~1api~1payment-methods/get/responses/200/content/application~1json/examples/Result"]}},"schemaId":"schema_108","exampleIds":["paths/~1api~1payment-methods/get/responses/200/content/application~1json/examples/Result"]}],"pointer":"/paths/~1api~1payment-methods/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_108","exampleIds":["paths/~1api~1payment-methods/get/responses/200/content/application~1json/examples/Result"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108","exampleIds":["paths/~1api~1payment-methods/get/responses/200/content/application~1json/examples/Result"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/get-payment-methods"}],"panels":[]}]},"httpPath":"/api/payment-methods"},{"label":"Get Prices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/get-prices","routeSlug":"/products/legacy-api/openapi/other/get-prices","metadata":{"seo":{"title":"Get Prices","description":"Get prices for all available payment methods or for a single payment method. Note that this endpoint should only be called when a user requests prices by providing the cryptocurrency, fiat and ideally amounts and payment method. This endpoint is for dynamic quotations and not to retrieve a list of static prices that can be cached. As a result, the endpoint is rate limited."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-prices","name":"Get Prices","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1prices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Prices","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get prices for all available payment methods or for a single payment method. Note that this endpoint should only be called when a user requests prices by providing the cryptocurrency, fiat and ideally amounts and payment method. This endpoint is for dynamic quotations and not to retrieve a list of static prices that can be cached. As a result, the endpoint is rate limited."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"source","in":"query","schemaId":"schema_102","description":"Source fiat or cryptocurrency code e.g. 'USD' for buy and 'BTC' for sell","required":true},{"name":"target","in":"query","schemaId":"schema_102","description":"Target fiat or cryptocurrency code e.g. 'BTC' for buy and 'USD' for sell","required":true},{"name":"source_amount","in":"query","schemaId":"schema_109","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of the source fiat or cryptocurrency that will be used to calculate the target amount. Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should not be sent."},"children":[]}]}]}]},{"name":"target_amount","in":"query","schemaId":"schema_109","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of the target fiat or cryptocurrency that will be used to calculate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should not be sent."},"children":[]}]}]}]},{"name":"payment_method_id","in":"query","schemaId":"schema_110","description":"Unique ID for the payment method that you want to get prices for."},{"name":"account_reference","in":"query","schemaId":"schema_102","description":"Unique customer reference provided by you."},{"name":"blockchain","in":"query","schemaId":"schema_111","description":"The blockchain that prices will be retrieved for. If this is not passed, then the default blockchain that has been configured for you will be used."},{"name":"discount_code","in":"query","schemaId":"schema_112","description":"(Beta) A code that can be passed to change your commission rate on this order. Please contact your account manager for code setup."}],"pointer":"/paths/~1api~1prices/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102","description":"This is the correlation ID related to the request."}],"pointer":"/paths/~1api~1prices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/prices","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[],"query":[{"name":"source","in":"query","required":true,"schemaId":"schema_102"},{"name":"target","in":"query","required":true,"schemaId":"schema_102"},{"name":"source_amount","in":"query","schemaId":"schema_109"},{"name":"target_amount","in":"query","schemaId":"schema_109"},{"name":"payment_method_id","in":"query","schemaId":"schema_110"},{"name":"account_reference","in":"query","schemaId":"schema_102"},{"name":"blockchain","in":"query","schemaId":"schema_111"},{"name":"discount_code","in":"query","schemaId":"schema_112"}],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102"}],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/prices","href":"other/get-prices","openApiOperationId":"get-prices","summary":"Get Prices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1prices/get/responses/200/content/application~1json/examples/Result","paths/~1api~1prices/get/responses/200/content/application~1json/examples/With Promotion"]}},"exampleIds":["paths/~1api~1prices/get/responses/200/content/application~1json/examples/Result","paths/~1api~1prices/get/responses/200/content/application~1json/examples/With Promotion"]}],"pointer":"/paths/~1api~1prices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1api~1prices/get/responses/200/content/application~1json/examples/Result","paths/~1api~1prices/get/responses/200/content/application~1json/examples/With Promotion"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1prices/get/responses/200/content/application~1json/examples/Result","paths/~1api~1prices/get/responses/200/content/application~1json/examples/With Promotion"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/get-prices"}],"panels":[]}]},"httpPath":"/api/prices"},{"label":"Create Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/create-order","routeSlug":"/products/legacy-api/openapi/other/create-order","metadata":{"seo":{"title":"Create Order","description":"Allows your customer to create a buy or sell crypto order with Banxa. Upon success, the response will contain a checkout URL which will be unique for the order. The customer will be redirected to this URL to complete the checkout process, which will expire after 1 minute if a redirect does not occur."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-order","name":"Create Order","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Order","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows your customer to create a buy or sell crypto order with Banxa. Upon success, the response will contain a checkout URL which will be unique for the order. The customer will  be redirected to this URL to complete the checkout process, which will expire after 1 minute if a redirect does not occur."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102","description":"This is the correlation ID related to the request."}],"pointer":"/paths/~1api~1orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_113"}},"schemaId":"schema_113","pointer":"/paths/~1api~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102"}],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_113"}},"responseCodes":["200","422"],"pointer":"/api/orders","href":"other/create-order","openApiOperationId":"create-order","summary":"Create Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"schemaId":"schema_113","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_113"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_114","exampleIds":["paths/~1api~1orders/post/responses/200/content/application~1json/examples/OK","paths/~1api~1orders/post/responses/200/content/application~1json/examples/With Promotion"]}},"schemaId":"schema_114","exampleIds":["paths/~1api~1orders/post/responses/200/content/application~1json/examples/OK","paths/~1api~1orders/post/responses/200/content/application~1json/examples/With Promotion"]},{"code":"422","description":"422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_115","exampleIds":["paths/~1api~1orders/post/responses/422/content/application~1json/examples/Invalid Wallet Address","paths/~1api~1orders/post/responses/422/content/application~1json/examples/Invalid payment method ID"]}},"schemaId":"schema_115","exampleIds":["paths/~1api~1orders/post/responses/422/content/application~1json/examples/Invalid Wallet Address","paths/~1api~1orders/post/responses/422/content/application~1json/examples/Invalid payment method ID"]}],"pointer":"/paths/~1api~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_114","exampleIds":["paths/~1api~1orders/post/responses/200/content/application~1json/examples/OK","paths/~1api~1orders/post/responses/200/content/application~1json/examples/With Promotion"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_114","exampleIds":["paths/~1api~1orders/post/responses/200/content/application~1json/examples/OK","paths/~1api~1orders/post/responses/200/content/application~1json/examples/With Promotion"]}}},{"code":"422","schemaId":"schema_115","exampleIds":["paths/~1api~1orders/post/responses/422/content/application~1json/examples/Invalid Wallet Address","paths/~1api~1orders/post/responses/422/content/application~1json/examples/Invalid payment method ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_115","exampleIds":["paths/~1api~1orders/post/responses/422/content/application~1json/examples/Invalid Wallet Address","paths/~1api~1orders/post/responses/422/content/application~1json/examples/Invalid payment method ID"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/create-order"}],"panels":[]}]},"httpPath":"/api/orders"},{"label":"Get Orders (Bulk Orders)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/get-orders","routeSlug":"/products/legacy-api/openapi/other/get-orders","metadata":{"seo":{"title":"Get Orders (Bulk Orders)","description":"Retrieves details for a bulk of orders that have been submitted within a given time range and optionally by order status or customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-orders","name":"Get Orders (Bulk Orders)","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Orders (Bulk Orders)","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves details for a bulk of orders that have been submitted within a given time range and optionally by order status or customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_116","description":"Start date used for filtering orders. Must be a date in the format YYYY-MM-DD.","required":true},{"name":"end_date","in":"query","schemaId":"schema_117","description":"End date used for filtering orders. Must be a date in the format YYYY-MM-DD.","required":true},{"name":"status","in":"query","schemaId":"schema_118","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of an order. Can be one or many order statuses which are comma separated.  Available order statuses can be found here: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"doc:order-status"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Status"},"children":[]}]}]}]}]},{"name":"per_page","in":"query","schemaId":"schema_119","description":"Number of orders returned in a single response. The maximum is 200."},{"name":"page","in":"query","schemaId":"schema_110","description":"Page to retrieve. The number of pages available is given in the meta object in the response."},{"name":"account_reference","in":"query","schemaId":"schema_102","description":"Customer reference that was passed as a parameter when creating an order. Used to retrieve all orders for a customer."}],"pointer":"/paths/~1api~1orders/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102","description":"This is the correlation ID related to the request."}],"pointer":"/paths/~1api~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[],"query":[{"name":"start_date","in":"query","required":true,"schemaId":"schema_116"},{"name":"end_date","in":"query","required":true,"schemaId":"schema_117"},{"name":"status","in":"query","schemaId":"schema_118"},{"name":"per_page","in":"query","schemaId":"schema_119"},{"name":"page","in":"query","schemaId":"schema_110"},{"name":"account_reference","in":"query","schemaId":"schema_102"}],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102"}],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/orders","href":"other/get-orders","openApiOperationId":"get-orders","summary":"Get Orders (Bulk Orders)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_120","exampleIds":["paths/~1api~1orders/get/responses/200/content/application~1json/examples/Result"]}},"schemaId":"schema_120","exampleIds":["paths/~1api~1orders/get/responses/200/content/application~1json/examples/Result"]},{"code":"422","description":"422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_121","exampleIds":["paths/~1api~1orders/get/responses/422/content/application~1json/examples/Invalid Order Status"]}},"schemaId":"schema_121","exampleIds":["paths/~1api~1orders/get/responses/422/content/application~1json/examples/Invalid Order Status"]}],"pointer":"/paths/~1api~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_120","exampleIds":["paths/~1api~1orders/get/responses/200/content/application~1json/examples/Result"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_120","exampleIds":["paths/~1api~1orders/get/responses/200/content/application~1json/examples/Result"]}}},{"code":"422","schemaId":"schema_121","exampleIds":["paths/~1api~1orders/get/responses/422/content/application~1json/examples/Invalid Order Status"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_121","exampleIds":["paths/~1api~1orders/get/responses/422/content/application~1json/examples/Invalid Order Status"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/get-orders"}],"panels":[]}]},"httpPath":"/api/orders"},{"label":"Create NFT Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/create-nft-order","routeSlug":"/products/legacy-api/openapi/other/create-nft-order","metadata":{"seo":{"title":"Create NFT Order","description":"Allows your customer to create a Fiat to NFT order with Banxa. Upon success, the response will contain a checkout URL which will be unique for the order. The customer will be redirected to this URL to complete the checkout process, which will expire after 1 minute if a redirect does not occur."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-nft-order","name":"Create NFT Order","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1orders~1nft~1buy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create NFT Order","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows your customer to create a Fiat to NFT order with Banxa. Upon success, the response will contain a checkout URL which will be unique for the order. The customer will  be redirected to this URL to complete the checkout process, which will expire after 1 minute if a redirect does not occur."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102","description":"This is the correlation ID related to the request."}],"pointer":"/paths/~1api~1orders~1nft~1buy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_122"}},"schemaId":"schema_122","pointer":"/paths/~1api~1orders~1nft~1buy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/nft/buy","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102"}],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_122"}},"responseCodes":["200","422"],"pointer":"/api/orders/nft/buy","href":"other/create-nft-order","openApiOperationId":"create-nft-order","summary":"Create NFT Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"schemaId":"schema_122","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_122"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123","exampleIds":["paths/~1api~1orders~1nft~1buy/post/responses/200/content/application~1json/examples/OK"]}},"schemaId":"schema_123","exampleIds":["paths/~1api~1orders~1nft~1buy/post/responses/200/content/application~1json/examples/OK"]},{"code":"422","description":"422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_115","exampleIds":["paths/~1api~1orders~1nft~1buy/post/responses/422/content/application~1json/examples/Invalid Wallet Address","paths/~1api~1orders~1nft~1buy/post/responses/422/content/application~1json/examples/Invalid payment method ID"]}},"schemaId":"schema_115","exampleIds":["paths/~1api~1orders~1nft~1buy/post/responses/422/content/application~1json/examples/Invalid Wallet Address","paths/~1api~1orders~1nft~1buy/post/responses/422/content/application~1json/examples/Invalid payment method ID"]}],"pointer":"/paths/~1api~1orders~1nft~1buy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_123","exampleIds":["paths/~1api~1orders~1nft~1buy/post/responses/200/content/application~1json/examples/OK"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123","exampleIds":["paths/~1api~1orders~1nft~1buy/post/responses/200/content/application~1json/examples/OK"]}}},{"code":"422","schemaId":"schema_115","exampleIds":["paths/~1api~1orders~1nft~1buy/post/responses/422/content/application~1json/examples/Invalid Wallet Address","paths/~1api~1orders~1nft~1buy/post/responses/422/content/application~1json/examples/Invalid payment method ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_115","exampleIds":["paths/~1api~1orders~1nft~1buy/post/responses/422/content/application~1json/examples/Invalid Wallet Address","paths/~1api~1orders~1nft~1buy/post/responses/422/content/application~1json/examples/Invalid payment method ID"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/create-nft-order"}],"panels":[]}]},"httpPath":"/api/orders/nft/buy"},{"label":"Get Order (Single Order)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/get-order","routeSlug":"/products/legacy-api/openapi/other/get-order","metadata":{"seo":{"title":"Get Order (Single Order)","description":"Retrieves details for single order that has been submitted"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-order","name":"Get Order (Single Order)","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1orders~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Order (Single Order)","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves details for single order that has been submitted"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_102","description":"The id of the order to get","required":true}],"pointer":"/paths/~1api~1orders~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fx_currency","in":"query","schemaId":"schema_102","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is passed then an additional object requested_fx is added to the response which contains the fiat_amount converted to this currency."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1orders~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102","description":"This is the correlation ID related to the request."}],"pointer":"/paths/~1api~1orders~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders/{order_id}","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"schemaId":"schema_102"}],"query":[{"name":"fx_currency","in":"query","schemaId":"schema_102"}],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102"}],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/orders/{order_id}","href":"other/get-order","openApiOperationId":"get-order","summary":"Get Order (Single Order)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124","exampleIds":["paths/~1api~1orders~1{order_id}/get/responses/200/content/application~1json/examples/Result","paths/~1api~1orders~1{order_id}/get/responses/200/content/application~1json/examples/With Promotion"]}},"schemaId":"schema_124","exampleIds":["paths/~1api~1orders~1{order_id}/get/responses/200/content/application~1json/examples/Result","paths/~1api~1orders~1{order_id}/get/responses/200/content/application~1json/examples/With Promotion"]}],"pointer":"/paths/~1api~1orders~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_124","exampleIds":["paths/~1api~1orders~1{order_id}/get/responses/200/content/application~1json/examples/Result","paths/~1api~1orders~1{order_id}/get/responses/200/content/application~1json/examples/With Promotion"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124","exampleIds":["paths/~1api~1orders~1{order_id}/get/responses/200/content/application~1json/examples/Result","paths/~1api~1orders~1{order_id}/get/responses/200/content/application~1json/examples/With Promotion"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/get-order"}],"panels":[]}]},"httpPath":"/api/orders/{order_id}"},{"label":"Confirm Sell Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/confirm-sell-order","routeSlug":"/products/legacy-api/openapi/other/confirm-sell-order","metadata":{"seo":{"title":"Confirm Sell Order","description":"Once the coin amount transfer for a Sell Order has been executed, Banxa must be notified by sending a request to this endpoint with transaction hash, source and destination wallet address details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"confirm-sell-order","name":"Confirm Sell Order","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1orders~1{order_id}~1confirm/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm Sell Order","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Once the coin amount transfer for a Sell Order has been executed, Banxa must be notified by sending a request to this endpoint with transaction hash, source and destination wallet address details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102","description":"This is the correlation ID related to the request."}],"pointer":"/paths/~1api~1orders~1{order_id}~1confirm/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_125"}},"schemaId":"schema_125","pointer":"/paths/~1api~1orders~1{order_id}~1confirm/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/{order_id}/confirm","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102"}],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_125"}},"responseCodes":["200"],"pointer":"/api/orders/{order_id}/confirm","href":"other/confirm-sell-order","openApiOperationId":"confirm-sell-order","summary":"Confirm Sell Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"schemaId":"schema_125","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_125"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126","exampleIds":["paths/~1api~1orders~1{order_id}~1confirm/post/responses/200/content/application~1json/examples/Result"]}},"schemaId":"schema_126","exampleIds":["paths/~1api~1orders~1{order_id}~1confirm/post/responses/200/content/application~1json/examples/Result"]}],"pointer":"/paths/~1api~1orders~1{order_id}~1confirm/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_126","exampleIds":["paths/~1api~1orders~1{order_id}~1confirm/post/responses/200/content/application~1json/examples/Result"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126","exampleIds":["paths/~1api~1orders~1{order_id}~1confirm/post/responses/200/content/application~1json/examples/Result"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/confirm-sell-order"}],"panels":[]}]},"httpPath":"/api/orders/{order_id}/confirm"},{"label":"KYC Sharing Customer Registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/create-identity","routeSlug":"/products/legacy-api/openapi/other/create-identity","metadata":{"seo":{"title":"KYC Sharing Customer Registration","description":"Allows you to share customer details with Banxa before an Order is created. This reduces the need for customers to re-submit personal details and upload KYC documentation during the Banxa checkout flow. Detailed guide on how to implement this API can be found here."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-identity","name":"KYC Sharing Customer Registration","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1identities/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC Sharing Customer Registration","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows you to share customer details with Banxa before an Order is created. This reduces the need for customers to re-submit personal details and upload KYC documentation during the Banxa checkout flow. Detailed guide on how to implement this API can be found "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.banxa.com/docs/identities-service","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is restricted and subject to Banxa approval."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102","description":"This is the correlation ID related to the request."}],"pointer":"/paths/~1api~1identities/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_127"}},"schemaId":"schema_127","pointer":"/paths/~1api~1identities/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/identities","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","schemaId":"schema_101"},{"name":"X-Request-Id","in":"header","schemaId":"schema_102"}],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_127"}},"responseCodes":["200","422"],"pointer":"/api/identities","href":"other/create-identity","openApiOperationId":"create-identity","summary":"KYC Sharing Customer Registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"schemaId":"schema_127","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_127"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128","exampleIds":["paths/~1api~1identities/post/responses/200/content/application~1json/examples/Result"]}},"schemaId":"schema_128","exampleIds":["paths/~1api~1identities/post/responses/200/content/application~1json/examples/Result"]},{"code":"422","description":"422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129","exampleIds":["paths/~1api~1identities/post/responses/422/content/application~1json/examples/Result"]}},"schemaId":"schema_129","exampleIds":["paths/~1api~1identities/post/responses/422/content/application~1json/examples/Result"]}],"pointer":"/paths/~1api~1identities/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_128","exampleIds":["paths/~1api~1identities/post/responses/200/content/application~1json/examples/Result"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128","exampleIds":["paths/~1api~1identities/post/responses/200/content/application~1json/examples/Result"]}}},{"code":"422","schemaId":"schema_129","exampleIds":["paths/~1api~1identities/post/responses/422/content/application~1json/examples/Result"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129","exampleIds":["paths/~1api~1identities/post/responses/422/content/application~1json/examples/Result"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/create-identity"}],"panels":[]}]},"httpPath":"/api/identities"},{"label":"KYC Reliance Customer Registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/legacy-api/openapi/other/kyc-reliance-customer-registration-1","routeSlug":"/products/legacy-api/openapi/other/kyc-reliance-customer-registration-1","metadata":{"seo":{"title":"KYC Reliance Customer Registration","description":"Allows you to register customer details with Banxa before an Order is created. This reduces the need for customers to re-submit personal details and perform KYC during the Banxa checkout flow. Detailed guide on how to implement this API can be found here."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kyc-reliance-customer-registration-1","name":"KYC Reliance Customer Registration","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1identities~1reliance/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC Reliance Customer Registration","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows you to register customer details with Banxa before an Order is created. This reduces the need for customers to re-submit personal details and perform KYC during the Banxa checkout flow. Detailed guide on how to implement this API can be found "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.banxa.com/docs/kyc-reliance-customer-registration","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is restricted and subject to Banxa approval."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sec0","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_130"}},"schemaId":"schema_130","pointer":"/paths/~1api~1identities~1reliance/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/identities/reliance","servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sec0","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_130"}},"responseCodes":["200","422"],"pointer":"/api/identities/reliance","href":"other/kyc-reliance-customer-registration-1","openApiOperationId":"kyc-reliance-customer-registration-1","summary":"KYC Reliance Customer Registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/legacy-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.banxa.com"}],"schemaId":"schema_130","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_130"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128","exampleIds":["paths/~1api~1identities~1reliance/post/responses/200/content/application~1json/examples/Result"]}},"schemaId":"schema_128","exampleIds":["paths/~1api~1identities~1reliance/post/responses/200/content/application~1json/examples/Result"]},{"code":"422","description":"422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_131","exampleIds":["paths/~1api~1identities~1reliance/post/responses/422/content/application~1json/examples/Result"]}},"schemaId":"schema_131","exampleIds":["paths/~1api~1identities~1reliance/post/responses/422/content/application~1json/examples/Result"]}],"pointer":"/paths/~1api~1identities~1reliance/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_128","exampleIds":["paths/~1api~1identities~1reliance/post/responses/200/content/application~1json/examples/Result"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128","exampleIds":["paths/~1api~1identities~1reliance/post/responses/200/content/application~1json/examples/Result"]}}},{"code":"422","schemaId":"schema_131","exampleIds":["paths/~1api~1identities~1reliance/post/responses/422/content/application~1json/examples/Result"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_131","exampleIds":["paths/~1api~1identities~1reliance/post/responses/422/content/application~1json/examples/Result"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/kyc-reliance-customer-registration-1"}],"panels":[]}]},"httpPath":"/api/identities/reliance"}],"store":{"schemaStore":{"schema_100":{"kind":"json-schema","data":{"type":"string","default":"buy"},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"type":"string","default":"application/json"},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"type":"string"},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"fiats":{"type":"array","items":{"type":"object","properties":{"fiat_code":{"type":"string","example":"AUD"},"fiat_name":{"type":"string","example":"Australian Dollar"},"fiat_symbol":{"type":"string","example":"A$"}}}}}}}},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"countries":{"type":"array","items":{"type":"object","properties":{"country_code":{"type":"string","example":"AU"},"country_name":{"type":"string","example":"Australia"}}}}}}}},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"states":{"type":"array","items":{"type":"object","properties":{"state_code":{"type":"string","example":"AL"},"state_name":{"type":"string","example":"Alabama"}}}}}}}},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"type":"string","default":"ETH"},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"type":"string","default":"USD"},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"payment_methods":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"POLi"},"description":{"type":"string","example":"POLi is an online payment option that allows you to use your internet banking system to securely buy crypto currency"},"logo_url":{"type":"string","example":"https://banxa.com/img/poli.png"},"status":{"type":"string","example":"ACTIVE"},"type":{"type":"string","example":"FIAT_TO_CRYPTO"},"supported_agents":{},"supported_fiat":{"type":"array","items":{"type":"string","example":"AUD"}},"supported_coin":{"type":"array","items":{"type":"string","example":"BTC"}},"transaction_fees":{"type":"array","items":{"type":"object","properties":{"fiat_code":{"type":"string","example":"AUD"},"coin_code":{"type":"string","example":"BTC"},"fees":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"surcharge"},"amount":{"type":"integer","example":2,"default":0},"type":{"type":"string","example":"percentage"}}}}}}},"transaction_limits":{"type":"array","items":{"type":"object","properties":{"fiat_code":{"type":"string","example":"AUD"},"min":{"type":"integer","example":100,"default":0},"max":{"type":"integer","example":2000,"default":0}}}}}}}}}}},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"type":"number","format":"float"},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"string","default":"TRON"},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"string","default":"VIP"},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"object","required":["account_reference","source","target","wallet_address","wallet_address_tag","return_url_on_success","refund_address"],"properties":{"account_reference":{"type":"string","description":"Unique customer reference provided by you. Used to check whether customer has completed KYC."},"payment_method_id":{"type":"integer","description":"Payment method ID associated with the order.","format":"int32"},"source":{"type":"string","description":"Source currency or cryptocurrency code. This parameter indicates whether the order is a buy or a sell cryptocurrency order."},"source_amount":{"type":"string","description":"Source amount"},"target":{"type":"string","description":"Target currency or cryptocurrency code. This parameter indicates whether the order is a buy or a sell cryptocurrency order."},"target_amount":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target amount. This will be overridden if a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also passed."},"children":[]}]}]}]},"wallet_address":{"type":"string","description":"Wallet address to receive cryptocurrency. Should be sent for buy cryptocurrency orders only."},"wallet_address_tag":{"type":"string","description":"Wallet tag or memo associated with the wallet address. Should be sent for buy cryptocurrency orders only. This is required when the Customer's wallet address has a Memo or Tag such as BNB (Memo) and XRP (Tag)."},"blockchain":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blockchain network code. If not provided, the default blockchain configured for the cryptocurrency will be used. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"ref:get-crypto-currencies"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Crypto Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to retrieve a list of supported blockchain network codes."},"children":[]}]}]}]},"return_url_on_success":{"type":"string","description":"Return URL when the customer has completed the checkout process."},"return_url_on_cancelled":{"type":"string","description":"Return URL when the customer cancels the checkout process."},"return_url_on_failure":{"type":"string","description":"Return URL when the customer fails to complete the checkout process."},"meta_data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free form string that you can use to send us any information that will be returned in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"ref:get-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]},"refund_address":{"type":"string","description":"Refund wallet address. Should be sent for sell cryptocurrency orders only. Used in the event in the event that a refund is necessary and the transferred coins need to be returned."},"refund_address_tag":{"type":"string","description":"Refund wallet address tag or memo. Should be sent for sell cryptocurrency orders only. This is required when the Customer's wallet address has a Memo or Tag such as BNB (Memo) and XRP (Tag)."},"source_address":{"type":"string","description":"Source wallet address. Should be sent for sell cryptocurrency orders only."},"source_address_tag":{"type":"string","description":"Source wallet address tag or memo. Should be sent for sell cryptocurrency orders only. Required when source wallet address for BNB (Memo) or XRP (Tag)."},"email":{"type":"string","description":"Customer's email address. This will pre-populate the customers' email address field when they are redirected to Banxa checkout"},"mobile":{"type":"string","description":"Customer's mobile number. This will pre-populate the customers' mobile number field when they are redirected to Banxa checkout"},"discount_code":{"type":"string","description":"(Beta) A code that can be passed to change your commission rate on this order. Please contact your account manager for code setup.","default":"VIP"}}},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"oneOf":[{"title":"OK","type":"object","properties":{"data":{"type":"object","properties":{"order":{"type":"object","properties":{"id":{"type":"string","example":"0164d962448fbd34f644ffd65624d8ef"},"account_id":{"type":"string","example":"098f6bcd4621d373cade4e832627b4f6"},"account_reference":{"type":"string","example":"098f6bcd4621d373cade4e832627b4f6"},"country":{"type":"string","example":"US"},"order_type":{"type":"string","example":"CRYPTO-BUY"},"fiat_code":{"type":"string","example":"AUD"},"coin_code":{"type":"string","example":"BTC"},"wallet_address":{"type":"string","example":"39Mn6uYF1C1ZHbi5KgmyAjrTPX5RCWThbp"},"blockchain":{"type":"object","properties":{"code":{"type":"string","example":"BTC"},"description":{"type":"string","example":"Bitcoin"}}},"created_at":{"type":"string","example":"16-May-2019 10:30:43"},"checkout_url":{"type":"string","example":"https://[merchant].banxa.com/portal?expires=xxx&oid=xxx&signature=xxx"}}}}}}},{"title":"With Promotion","type":"object","properties":{"data":{"type":"object","properties":{"order":{"type":"object","properties":{"id":{"type":"string","example":"ff4194708d6c34cc3rgffdd17b7583be5"},"account_id":{"type":"string","example":"537c1d49863ffsfdf14520540e16d"},"account_reference":{"type":"string","example":"test001"},"country":{"type":"string","example":"AU"},"order_type":{"type":"string","example":"CRYPTO-BUY"},"fiat_code":{"type":"string","example":"AUD"},"fiat_amount":{"type":"integer","example":75,"default":0},"coin_code":{"type":"string","example":"BTC"},"wallet_address":{"type":"string","example":"1LbQ1WNTsm1NzergregfCbEim1oUg5rfi"},"blockchain":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"code":{"type":"string","example":"BTC"},"description":{"type":"string","example":"Bitcoin"}}},"discount_code":{"type":"string","example":"BLACKFRIDAY"},"created_at":{"type":"string","example":"23-Jan-2024 23:39:12"},"checkout_url":{"type":"string","example":"https://example.banxa.com"}}}}}}}]},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"oneOf":[{"title":"Invalid Wallet Address","type":"object","properties":{"errors":{"type":"object","properties":{"status":{"type":"integer","example":422,"default":0},"code":{"type":"integer","example":422,"default":0},"title":{"type":"string","example":"An invalid wallet address was entered."}}}}},{"title":"Invalid payment method ID","type":"object","properties":{"errors":{"type":"object","properties":{"status":{"type":"integer","example":422,"default":0},"code":{"type":"integer","example":422,"default":0},"title":{"type":"string","example":"Invalid payment method ID."}}}}}]},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"type":"string","format":"date","default":"2021-01-18"},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"type":"string","format":"date","default":"2021-01-19"},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"string","default":"inProgress,coinTransferred,declined"},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":100},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"orders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"7f954c2eaea52db2d7e57d839620a764"},"account_id":{"type":"string","example":"564d914ba50d51d67095817f1559e0a7"},"account_reference":{"type":"string","example":"098f6bcd4621d373cade4e832627b4f6"},"order_type":{"type":"string","example":"CRYPTO-BUY"},"payment_type":{"type":"string","example":"POLI"},"ref":{"type":"integer","example":1,"default":0},"fiat_code":{"type":"string","example":"AUD"},"fiat_amount":{"type":"integer","example":200,"default":0},"coin_code":{"type":"string","example":"BTC"},"coin_amount":{"type":"number","example":0.015,"default":0},"wallet_address":{"type":"string","example":"1LbQ1WNTsm1Nzj1hbh3WDCbEim1oUg5rfi"},"blockchain":{"type":"object","properties":{"code":{"type":"string","example":"BTC"},"description":{"type":"string","example":"Bitcoin"},"contract_id":{},"network_id":{}}},"fee":{"type":"number","example":4.3,"default":0},"payment_fee":{"type":"integer","example":0,"default":0},"commission":{"type":"number","example":0.03,"default":0},"tx_hash":{"type":"string","example":"323bf75d66fd5a4fe8c903f950d81c5f0170bacd0f872cde8f4f3d6e7c94db35"},"created_at":{"type":"string","example":"2020-06-01 00:20:51"},"status":{"type":"string","example":"complete"},"meta_data":{"type":"string","example":"{'tracking_id': 'HSKJDGHKSJG0393LJKJF'}"}}}}}},"meta":{"type":"object","properties":{"current_page":{"type":"integer","example":1,"default":0},"from":{"type":"integer","example":1,"default":0},"last_page":{"type":"integer","example":1,"default":0},"per_page":{"type":"integer","example":50,"default":0},"to":{"type":"integer","example":1,"default":0},"total":{"type":"integer","example":1,"default":0}}}}},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","example":"422"},"title":{"type":"string","example":"Invalid Parameters"},"detail":{"type":"string","example":"Invalid order status: pending. Valid options are: pendingPayment, waitingPayment, paymentReceived, inProgress, coinTransferred, cancelled, declined, expired, complete, refunded"}}}}}},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"object","required":["account_reference","source","target","wallet_address","blockchain","return_url_on_success"],"properties":{"account_reference":{"type":"string","description":"Unique customer reference provided by you to identify the order in our system"},"payment_method_id":{"type":"integer","description":"Payment method ID associated with the order.","format":"int32"},"source":{"type":"string","description":"Source currency code. i.e. USD, CAD etc."},"source_amount":{"type":"string","description":"Source amount"},"target":{"type":"string","description":"Target cryptocurrency code. The cryptocurrency the NFT is listed in."},"target_amount":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target amount. This will be overridden if a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also passed."},"children":[]}]}]}]},"wallet_address":{"type":"string","description":"Wallet address to receive NFT."},"blockchain":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blockchain network code. If not provided, the default blockchain configured for the cryptocurrency will be used. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"ref:get-crypto-currencies"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Crypto Currencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to retrieve a list of supported blockchain network codes."},"children":[]}]}]}]},"return_url_on_success":{"type":"string","description":"Return URL when the customer has completed the checkout process."},"return_url_on_cancelled":{"type":"string","description":"Return URL when the customer cancels the checkout process."},"return_url_on_failure":{"type":"string","description":"Return URL when the customer fails to complete the checkout process."},"iframe_domain":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used if you are embedding an iFrame. This must be the exact domain where the iFrame will be hosted. e.g. [yourCompany].com. Do not include https:// in front of the domain."},"children":[]}]}]}]},"meta_data":{"properties":{"purchase_reference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please return us the purchase_reference and NFT meta data which includes the contract address and token ID. The other fields are optional."},"children":[]}]}]}]},"nft":{"properties":{"name":{"type":"string","description":"NFT name"},"collection":{"type":"string","description":"NFT Collection name"},"media":{"properties":{"type":{"type":"string","description":"\"image\" or \"video\""},"link":{"type":"string","description":"NFT link"}},"required":["type","link"],"type":"object"}},"required":["name","collection"],"type":"object"}},"required":["purchase_reference"],"type":"object"}}},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"order":{"type":"object","properties":{"id":{"type":"string","example":"0164d962448fbd34f644ffd65624d8ef"},"account_id":{"type":"string","example":"098f6bcd4621d373cade4e832627b4f6"},"account_reference":{"type":"string","example":"098f6bcd4621d373cade4e832627b4f6"},"order_type":{"type":"string","example":"NFT-BUY"},"fiat_code":{"type":"string","example":"USD"},"coin_code":{"type":"string","example":"ETH"},"wallet_address":{"type":"string","example":"xxxxxx360"},"blockchain":{"type":"object","properties":{"code":{"type":"string","example":"ERC20"},"description":{"type":"string","example":"Ethereum"}}},"created_at":{"type":"string","example":"16-May-2022 10:30:43"},"checkout_url":{"type":"string","example":"https://[merchant].banxa.com/portal?expires=xxx&oid=xxx&signature=xxx"}}}}}}},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"order":{"type":"object","properties":{"id":{"type":"string","example":"7f954c2eaea52db2d7e57d839620a764"},"account_id":{"type":"string","example":"564d914ba50d51d67095817f1559e0a7"},"account_reference":{"type":"string","example":"098f6bcd4621d373cade4e832627b4f6"},"order_type":{"type":"string","example":"CRYPTO-BUY"},"payment_type":{"type":"string","example":"POLI"},"ref":{"type":"integer","example":1,"default":0},"fiat_code":{"type":"string","example":"AUD"},"fiat_amount":{"type":"integer","example":200,"default":0},"coin_code":{"type":"string","example":"BTC"},"coin_amount":{"type":"number","example":0.015,"default":0},"wallet_address":{"type":"string","example":"1LbQ1WNTsm1Nzj1hbh3WDCbEim1oUg5rfi"},"blockchain":{"type":"object","properties":{"code":{"type":"string","example":"BTC"},"description":{"type":"string","example":"Bitcoin"},"contract_id":{},"network_id":{}}},"fee":{"type":"number","example":4.3,"default":0},"payment_fee":{"type":"integer","example":0,"default":0},"commission":{"type":"number","example":0.03,"default":0},"tx_hash":{"type":"string","example":"323bf75d66fd5a4fe8c903f950d81c5f0170bacd0f872cde8f4f3d6e7c94db35"},"created_at":{"type":"string","example":"2020-06-01 00:20:51"},"status":{"type":"string","example":"complete"},"meta_data":{"type":"string","example":"{'tracking_id': 'HSKJDGHKSJG0393LJKJF'}"}}}}}}},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"object","required":["tx_hash","source_address","destination_address"],"properties":{"tx_hash":{"type":"string","description":"Blockchain transaction hash of the order"},"source_address":{"type":"string","description":"The provided customer's source wallet address"},"source_address_tag":{"type":"string","description":"The customer's source wallet address tag if the provided source wallet address requires it"},"destination_address":{"type":"string","description":"The wallet address provided to merchants to transact to"},"destination_address_tag":{"type":"string","description":"The wallet address tag provided to merchants if the provided destination wallet address requires it"}}},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"order":{"type":"object","properties":{"id":{"type":"string","example":"21bbacbe9655f4c6fa3d696bed14f974"},"account_id":{"type":"string","example":"7cd01995c81658527cf38af0cad523a3"},"account_reference":{"type":"string","example":"test000101"},"order_type":{"type":"string","example":"CRYPTO-SELL"},"payment_type":{"type":"string","example":"DIRECTCREDIT"},"ref":{"type":"integer","example":103993,"default":0},"fiat_code":{"type":"string","example":"AUD"},"fiat_amount":{"type":"integer","example":100,"default":0},"coin_code":{"type":"string","example":"BTC"},"coin_amount":{"type":"number","example":0.00159514,"default":0},"wallet_address":{"type":"string","example":"2NBK1YYH7Uaj1TA94LzUcLtApb4vMpxSTeb"},"fee":{"type":"integer","example":0,"default":0},"payment_fee":{"type":"integer","example":0,"default":0},"commission":{"type":"integer","example":0,"default":0},"tx_hash":{},"created_at":{"type":"string","example":"15-Jul-2021 00:37:51"},"status":{"type":"string","example":"coinTransferReady"},"completed_at":{},"merchant_fee":{"type":"integer","example":0,"default":0},"meta_data":{},"blockchain":{"type":"object","properties":{"code":{"type":"string","example":"BTC"},"description":{"type":"string","example":"Bitcoin"}}}}}}}}},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"object","required":["account_reference","email"],"properties":{"account_reference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique customer reference provided by you. This should be the same value that is passed when calling the calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"ref:create-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},"email":{"type":"string","description":"Customer's email address. Must be a valid email address."},"mobile_number":{"type":"string","description":"Customer's contact number. Must be a valid mobile number and must include the country code."},"customer_identity":{"properties":{"given_name":{"type":"string","description":"Customer's given / first name."},"surname":{"type":"string","description":"Customer's surname / last name."},"dob":{"type":"string","description":"Customer's date of birth (e.g. \"1985-01-31\"). Required to format as ISO 8601 Date format : YYYY-MM-DD."},"taxId":{"type":"string","description":"This is the national identifier for the customer, for example, the customer's Social Security number (SSN) in the US. Must be a nine-digit number in the format \"AAA-GG-SSSS\".","default":"456-44-4564"},"taxState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the tax state that is associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. Required format as two characters. Note that there is validation as we do not accept any states where Banxa is not licensed to service per the Get States API call."},"children":[]}]}]}],"default":"CA"},"residential_address":{"properties":{"address_line_1":{"type":"string","description":"Street number, street name and street type/suffix."},"suburb":{"type":"string","description":"Address city or suburb. E.g. \"2 Abbey Road\"."},"post_code":{"type":"string","description":"Address postal / PIN / ZIP code."},"state":{"type":"string","description":"Address state / region."},"country":{"type":"string","description":"Customer's country of residence. Required to be formatted using ISO 3166 two-letter country code e.g. \"US\" or \"AU\".","default":"GB"}},"required":[],"type":"object"}},"required":[],"type":"object","description":"An array of fields containing the customer's personal details."},"identity_documents":{"type":"array","description":"An array of objects containing a type, data and links to the location of the customer's KYC documents.","items":{"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRIVING_LICENSE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELFIE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"images":{"type":"object","description":"URL link to where the identity image is stored. One or several image links must be passed if the image object passed, i.e. for a Driver's License an image of the front and back of the document should be passed. The link must be an encrypted https:// request. Acceptable formats are JPEG, JPG, PNG and PDF. The minimum file size is 32KB and the maximum file size is 10MB.","properties":{"link":{"type":"string","description":"Image URL (e.g. \"https://www.orimi.com/pdf-test.pdf\"). This should ideally be a one time link to download the document that shows the information captured, to ensure it will not be downloaded by any other party. The image link should point to where the image is stored, and all the information we need to retrieve the image should be contained in the link."},"base64":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image encoded as a base64 blob. e.g. VGhpcyBpcyBhbiBlbmNvZGVkIHN0cmluZw==. This is can be used instead of a link."},"children":[]}]}]}]},"mimetype":{"type":"string","description":"MIME type related to base64 passed, and will be mandatory if base64 is used.","default":"image/jpeg"}}},"data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the document \"type\" is \"PASSPORT\" , \"DRIVING_LICENSE\" or \"IDENTIFICATION\", then we request you send the \"data\" field to provide the document information. These are not required for other document types."},"children":[]}]}]}],"properties":{"number":{"type":"string","description":"The unique document number."}}}},"required":["type"],"type":"object"}},"identity_sharing":{"type":"array","description":"An array of objects containing KYC outcomes. Required for Sumsub only.","items":{"properties":{"provider":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC provider that you have used, currently "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sumsub"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only supported value. Required for Sumsub only."},"children":[]}]}]}],"default":"sumsub"},"token":{"type":"string","description":"Customer token ID that is supplied by the KYC provider that will be used by Banxa to retrieve customer KYC details. Required for Sumsub only."}},"required":["provider","token"],"type":"object"}},"occupation_industry":{"type":"string","description":"Customer's occupation industry. Please contact Banxa for a list of accepted values."},"occupation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's occupation, which must be associated to the Customer's 'occupation_industry'. Please contact Banxa for a list of accepted values. Required if 'occupation_primary' is passed."},"children":[]}]}]}]},"purpose_of_tx":{"type":"string","description":"Customer's Purpose of Transaction. Please contact Banxa for a list of accepted values."}}},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"account":{"type":"object","properties":{"account_id":{"type":"string","example":"d3be8dfe1eea6f55725d5784a83d4ce9"},"account_reference":{"type":"string","example":"test001001"}}}}}}},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","example":"The given data was invalid."},"errors":{"type":"object","properties":{"account_reference":{"type":"array","items":{"type":"string","example":"The account reference field is required when mobile number is not present."}},"mobile_number":{"type":"array","items":{"type":"string","example":"The mobile number field is required when account reference is not present."}}}}}},{"type":"object","properties":{"message":{"type":"string","example":"The given data was invalid."},"errors":{"type":"object","properties":{"customer_identity.dob":{"type":"array","items":{"type":"string","example":"The customer identity.dob does not match the format Y-m-d."}}}}}}]},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"object","required":["account_reference","email","given_name","surname","dob","address_line_1","suburb","post_code","state","country","document_type","document_number"],"properties":{"account_reference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique customer reference provided by you. This should be the same value that is passed when calling the calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"ref:create-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"default":"test001001"},"email":{"type":"string","description":"Customer's email address. Must be a valid email address, and the Customer must have access to this email address to perform OTP verification if required.","default":"test@bitcoin.com"},"mobile_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer's contact number. Must be a valid mobile number and can support a value with or without \"+\" in the input."},"children":[]}]}]}],"default":"+16102458680"},"given_name":{"type":"string","description":"Customer's given / first name.","default":"Joe"},"middle_name":{"type":"string","description":"Customer's second / middle name/s","default":"Winter"},"surname":{"type":"string","description":"Customer's surname / last name.","default":"Bloggs"},"dob":{"type":"string","description":"Customer's date of birth (e.g. \"1985-01-31\"). Required to format as ISO 8601 Date format : YYYY-MM-DD.","default":"1990-01-31"},"address_line_1":{"type":"string","description":"Customer's residential address: Street number, street name and street type/suffix. E.g. \"2 Abbey Road\".","default":"1 East Liberty Street"},"suburb":{"type":"string","description":"Address city or suburb.","default":"Reno"},"post_code":{"type":"string","description":"Address postal / PIN / ZIP code.","default":"89501"},"state":{"type":"string","description":"Address state / region. The 2-letter abbreviation for US States must be used.","default":"NV"},"country":{"type":"string","description":"Customer's country of residence. Required to be formatted using ISO 3166 two-letter country code e.g. \"US\" or \"AU\".","default":"US"},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DRIVING_LICENSE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]}],"default":"PASSPORT"},"document_number":{"type":"string","description":"The unique identity document number. For example a Passport number.","default":"530000000"},"ssn":{"type":"string","description":"Customer's Social Security Number. Required if the Customer's Country of Residence is United States (e.g. the 'country' parameter contains a value of \"US\"). Must be submitted in the following format: \"XXX-XX-XXXX\".","default":"530-42-3010"},"screening_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The most recent date on which a PEP & Sanction screening check was conducted for the Customer. Required to format as ISO 8601 Date format : YYYY-MM-DD , date must be today or before."},"children":[]}]}]}],"default":"2022-05-01"},"screening_sanctions_result":{"type":"boolean","description":"If the Sanctions screening scan revealed the Customer is Sanctioned, then return a value of TRUE, otherwise return a value of FALSE.","default":false},"screening_pep_result":{"type":"boolean","description":"If the PEP screening scan revealed the Customer is a PEP, then return a value of TRUE otherwise return a value of FALSE.","default":false}}},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","example":"422"},"title":{"type":"string","example":"Invalid Parameters"},"detail":{"type":"object","properties":{"account_reference":{"type":"string","example":"The account reference field is required when mobile is not present."},"mobile":{"type":"string","example":"The mobile field is required when account reference is not present."}}}}}}}},"id":"schema_131"}},"exampleStore":{"paths/~1api~1fiats~1{orderType}/get/responses/200/content/application~1json/examples/Result":{"value":"{\n  \"data\" : {\n    \"fiats\": [\n      {\n        \"fiat_code\": \"AUD\",\n        \"fiat_name\": \"Australian Dollar\",\n        \"fiat_symbol\": \"A$\"\n      }\n    ]  \n  }\n}","key":"Result","summary":"Result","id":"paths/~1api~1fiats~1{orderType}/get/responses/200/content/application~1json/examples/Result"},"paths/~1api~1coins~1{orderType}/get/responses/200/content/application~1json/examples/Result":{"value":"{\n    \"data\": {\n        \"coins\": [\n            {\n                \"coin_code\": \"BTC\",\n                \"coin_name\": \"Bitcoin\",\n                \"blockchains\": [\n                    {\n                        \"code\": \"BTC\",\n                        \"description\": \"Bitcoin\",\n                        \"is_default\": true,\n                        \"min_value\": 0.0005,\n                        \"address_tag\": {\n                            \"regex\": null,\n                            \"required\": null,\n                            \"name\": null\n                    }\n                ]\n            },\n            {\n                \"coin_code\": \"ETH\",\n                \"coin_name\": \"Ethereum\",\n                \"blockchains\": [\n                    {\n                        \"code\": \"ETH\",\n                        \"description\": \"Ethereum (ERC-20)\",\n                        \"is_default\": true,\n                        \"min_value\": 0.01,\n                        \"address_tag\": {\n                            \"regex\": null,\n                            \"required\": null,\n                            \"name\": null\n                    }\n                ]\n            },\n{\n                \"coin_code\": \"BNB\",\n                \"coin_name\": \"Binance Coin\",\n                \"blockchains\": [\n                    {\n                        \"code\": \"BNB\",\n                        \"description\": \"Binance Chain (BEP2)\",\n                        \"contract_id\": \"0x242a1ff6ee06f2131b7924cacb74c7f9e3a5edc9\",\n                        \"is_default\": false,\n                        \"min_value\": 0.01,\n                        \"address_tag\": {\n                            \"regex\": \"^[0-9]{1,100}$\",\n                            \"required\": false,\n                            \"name\": \"Memo\"\n                        }\n                ]\n            }\n        ]\n    }\n}","key":"Result","summary":"Result","id":"paths/~1api~1coins~1{orderType}/get/responses/200/content/application~1json/examples/Result"},"paths/~1api~1countries/get/responses/200/content/application~1json/examples/Result":{"value":"{\n  \"data\" : {\n    \"countries\": [\n      {\n        \"country_code\": \"AU\",\n        \"country_name\": \"Australia\"\n      }\n    ]  \n  }\n}","key":"Result","summary":"Result","id":"paths/~1api~1countries/get/responses/200/content/application~1json/examples/Result"},"paths/~1api~1countries~1us~1states/get/responses/200/content/application~1json/examples/Result":{"value":"{\n  \"data\": {  \n    \"states\": [\n      {\n        \"state_code\": \"AL\",\n        \"state_name\": \"Alabama\"\n      },\n      {\n        \"state_code\": \"AK\",\n        \"state_name\": \"Alaska\"\n      }\n    ]\n  }\n}","key":"Result","summary":"Result","id":"paths/~1api~1countries~1us~1states/get/responses/200/content/application~1json/examples/Result"},"paths/~1api~1payment-methods/get/responses/200/content/application~1json/examples/Result":{"value":"{\n  \"data\": {\n    \"payment_methods\": [\n      {\n        \"id\": 1,\n        \"name\": \"POLi\",\n        \"description\": \"POLi is an online payment option that allows you to use your internet banking system to securely buy crypto currency\",\n        \"logo_url\": \"https://banxa.com/img/poli.png\",\n        \"status\": \"ACTIVE\",\n        \"type\": \"FIAT_TO_CRYPTO\",\n        \"supported_agents\": null,\n        \"supported_fiat\": [\"AUD\"],\n        \"supported_coin\": [\"BTC\", \"ETH\"],\n        \"transaction_fees\": [\n          {\n            \"fiat_code\": \"AUD\",\n            \"coin_code\": \"BTC\",\n            \"fees\": [\n              {\n                \"name\": \"surcharge\",\n                \"amount\": 2,\n                \"type\": \"percentage\"\n              }\n            ]\n          }\n        ],\n        \"transaction_limits\": [\n            {\n              \"fiat_code\": \"AUD\",\n              \"min\": 100,\n              \"max\": 2000\n            }\n        ]\n      },\n      {\n        \"id\": 2,\n        \"name\": \"WORLDPAYAPPLE\",\n        \"description\": \"Apple Pay\",\n        \"logo_url\": \"https://banxa.com/img/apple-pay.png\",\n        \"status\": \"ACTIVE\",\n        \"type\": \"FIAT_TO_CRYPTO\",\n        \"supported_agents\": [\n          {\n            \"os\": \"ios\",\n            \"browser\": \"safari\"\n          },\n          {\n            \"os\": \"macos\",\n            \"browser\": \"safari\"\n          },\n          {\n            \"os\": \"ipados\",\n            \"browser\": \"safari\"\n          }\n        ],\n        \"supported_fiat\": [\"AUD\"],\n        \"supported_coin\": [\"BTC\", \"ETH\"],\n        \"transaction_fees\": [\n          {\n            \"fiat_code\": \"AUD\",\n            \"coin_code\": \"BTC\",\n            \"fees\": [\n              {\n                \"name\": \"surcharge\",\n                \"amount\": 1,\n                \"type\": \"percentage\"\n              }\n            ]\n          }\n        ],\n        \"transaction_limits\": [\n            {\n              \"fiat_code\": \"AUD\",\n              \"min\": 100,\n              \"max\": 9000\n            }\n        ]\n      }\n    ]\n  }\n}","key":"Result","summary":"Result","id":"paths/~1api~1payment-methods/get/responses/200/content/application~1json/examples/Result"},"paths/~1api~1prices/get/responses/200/content/application~1json/examples/Result":{"value":"{\n    \"data\": {\n        \"spot_price\": \"0.92\",\n        \"prices\": [\n            {\n                \"payment_method_id\": 1,\n                \"type\": \"FIAT_TO_CRYPTO\",\n                \"spot_price_fee\": \"0.02\",\n                \"spot_price_including_fee\": \"0.94\",\n                \"coin_amount\": \"104.43000000\",\n                \"coin_code\": \"USDT\",\n                \"fiat_amount\": \"100.30\",\n                \"fiat_code\": \"EUR\",\n                \"fee_amount\": \"1.96\",\n                \"network_fee\": \"0.00\n            },\n            {\n                \"payment_method_id\": 2,\n                \"type\": \"FIAT_TO_CRYPTO\",\n                \"spot_price_fee\": \"0.00\",\n                \"spot_price_including_fee\": \"0.95\",\n                \"coin_amount\": \"105.17000000\",\n                \"coin_code\": \"USDT\",\n                \"fiat_amount\": \"100.30\",\n                \"fiat_code\": \"EUR\",\n                \"fee_amount\": \"0.00\",\n                \"network_fee\": \"0.00\"\n                    }\n                }\n            }\n        ]\n    }\n}","key":"Result","summary":"Result","id":"paths/~1api~1prices/get/responses/200/content/application~1json/examples/Result"},"paths/~1api~1prices/get/responses/200/content/application~1json/examples/With Promotion":{"value":"{\n    \"data\": {\n        \"spot_price\": \"0.92\",\n        \"prices\": [\n            {\n                \"payment_method_id\": 1,\n                \"type\": \"FIAT_TO_CRYPTO\",\n                \"spot_price_fee\": \"0.02\",\n                \"spot_price_including_fee\": \"0.94\",\n                \"coin_amount\": \"104.43000000\",\n                \"coin_code\": \"USDT\",\n                \"fiat_amount\": \"100.30\",\n                \"fiat_code\": \"EUR\",\n                \"fee_amount\": \"1.96\",\n                \"network_fee\": \"0.00\",\n                \"discount\": {\n                    \"original_quote\": {\n                        \"original_coin_amount\": \"102.42\",\n                        \"original_network_fee\": \"0.00\",\n                        \"original_fee_amount\": \"1.96\",\n                        \"original_fiat_amount\": \"100.30\"\n                    }\n                }\n            },\n            {\n                \"payment_method_id\": 2,\n                \"type\": \"FIAT_TO_CRYPTO\",\n                \"spot_price_fee\": \"0.00\",\n                \"spot_price_including_fee\": \"0.95\",\n                \"coin_amount\": \"105.17000000\",\n                \"coin_code\": \"USDT\",\n                \"fiat_amount\": \"100.30\",\n                \"fiat_code\": \"EUR\",\n                \"fee_amount\": \"0.00\",\n                \"network_fee\": \"0.00\"\n                    }\n                }\n            }\n        ]\n    }\n}","key":"With Promotion","summary":"With Promotion","id":"paths/~1api~1prices/get/responses/200/content/application~1json/examples/With Promotion"},"paths/~1api~1orders/post/responses/200/content/application~1json/examples/OK":{"value":"{\n  \"data\": {\n    \"order\": {\n      \"id\": \"0164d962448fbd34f644ffd65624d8ef\",\n      \"account_id\": \"098f6bcd4621d373cade4e832627b4f6\",\n      \"account_reference\": \"098f6bcd4621d373cade4e832627b4f6\",\n      \"country\": \"US\",\n      \"order_type\": \"CRYPTO-BUY\",\n      \"fiat_code\": \"AUD\",\n      \"coin_code\": \"BTC\",\n      \"wallet_address\": \"39Mn6uYF1C1ZHbi5KgmyAjrTPX5RCWThbp\",\n      \"blockchain\": {\n          \"code\": \"BTC\",\n          \"description\": \"Bitcoin\"\n      },  \n      \"created_at\": \"16-May-2019 10:30:43\",\n      \"checkout_url\": \"https://[merchant].banxa.com/portal?expires=xxx&oid=xxx&signature=xxx\"\n    }\n  }\n}","key":"OK","summary":"OK","id":"paths/~1api~1orders/post/responses/200/content/application~1json/examples/OK"},"paths/~1api~1orders/post/responses/200/content/application~1json/examples/With Promotion":{"value":"{\n    \"data\": {\n        \"order\": {\n            \"id\": \"ff4194708d6c34cc3rgffdd17b7583be5\",\n            \"account_id\": \"537c1d49863ffsfdf14520540e16d\",\n            \"account_reference\": \"test001\",\n            \"country\": \"AU\",\n            \"order_type\": \"CRYPTO-BUY\",\n            \"fiat_code\": \"AUD\",\n            \"fiat_amount\": 75,\n            \"coin_code\": \"BTC\",\n            \"wallet_address\": \"1LbQ1WNTsm1NzergregfCbEim1oUg5rfi\",\n            \"blockchain\": {\n                \"id\": 1,\n                \"code\": \"BTC\",\n                \"description\": \"Bitcoin\"\n            },\n            \"discount_code\": \"BLACKFRIDAY\",\n            \"created_at\": \"23-Jan-2024 23:39:12\",\n            \"checkout_url\": \"https://example.banxa.com\"\n        }\n    }\n}","key":"With Promotion","summary":"With Promotion","id":"paths/~1api~1orders/post/responses/200/content/application~1json/examples/With Promotion"},"paths/~1api~1orders/post/responses/422/content/application~1json/examples/Invalid Wallet Address":{"value":"{\n    \"errors\": {\n        \"status\": 422,\n        \"code\": 422,\n        \"title\": \"An invalid wallet address was entered.\"\n    }\n}","key":"Invalid Wallet Address","summary":"Invalid Wallet Address","id":"paths/~1api~1orders/post/responses/422/content/application~1json/examples/Invalid Wallet Address"},"paths/~1api~1orders/post/responses/422/content/application~1json/examples/Invalid payment method ID":{"value":"{\n    \"errors\": {\n        \"status\": 422,\n        \"code\": 422,\n        \"title\": \"Invalid payment method ID.\"\n    }\n}","key":"Invalid payment method ID","summary":"Invalid payment method ID","id":"paths/~1api~1orders/post/responses/422/content/application~1json/examples/Invalid payment method ID"},"paths/~1api~1orders/get/responses/200/content/application~1json/examples/Result":{"value":"{\n  \"data\": {\n    \"orders\": [\n      {\n          \"id\": \"7f954c2eaea52db2d7e57d839620a764\",\n          \"account_id\": \"564d914ba50d51d67095817f1559e0a7\",\n          \"account_reference\": \"098f6bcd4621d373cade4e832627b4f6\",\n          \"order_type\": \"CRYPTO-BUY\",\n          \"payment_type\": \"POLI\",\n          \"ref\": 1,\n          \"fiat_code\": \"AUD\",\n          \"fiat_amount\": 200,\n          \"coin_code\": \"BTC\",\n          \"coin_amount\": 0.015,\n          \"wallet_address\": \"1LbQ1WNTsm1Nzj1hbh3WDCbEim1oUg5rfi\",\n      \t\t\"blockchain\": {\n           \t\"code\": \"BTC\",\n           \t\"description\": \"Bitcoin\",\n            \"contract_id\": null,\n            \"network_id\": null\n      \t\t },         \n          \"fee\": 4.3,\n          \"payment_fee\": 0,\n          \"commission\": 0.03,\n          \"tx_hash\": \"323bf75d66fd5a4fe8c903f950d81c5f0170bacd0f872cde8f4f3d6e7c94db35\",\n          \"created_at\": \"2020-06-01 00:20:51\",\n          \"status\": \"complete\",\n          \"meta_data\": \"{'tracking_id': 'HSKJDGHKSJG0393LJKJF'}\"\n      }\n    ]\n  },\n  \"meta\": {\n    \"current_page\": 1,\n    \"from\": 1,\n    \"last_page\": 1,\n    \"per_page\": 50,\n    \"to\": 1,\n    \"total\": 1\n  }\n}","key":"Result","summary":"Result","id":"paths/~1api~1orders/get/responses/200/content/application~1json/examples/Result"},"paths/~1api~1orders/get/responses/422/content/application~1json/examples/Invalid Order Status":{"value":"{\n    \"errors\": [\n        {\n            \"status\": \"422\",\n            \"title\": \"Invalid Parameters\",\n            \"detail\": \"Invalid order status: pending. Valid options are: pendingPayment, waitingPayment, paymentReceived, inProgress, coinTransferred, cancelled, declined, expired, complete, refunded\"\n        }\n    ]\n}","key":"Invalid Order Status","summary":"Invalid Order Status","id":"paths/~1api~1orders/get/responses/422/content/application~1json/examples/Invalid Order Status"},"paths/~1api~1orders~1nft~1buy/post/responses/200/content/application~1json/examples/OK":{"value":"{\n  \"data\": {\n    \"order\": {\n      \"id\": \"0164d962448fbd34f644ffd65624d8ef\",\n      \"account_id\": \"098f6bcd4621d373cade4e832627b4f6\",\n      \"account_reference\": \"098f6bcd4621d373cade4e832627b4f6\",\n      \"order_type\": \"NFT-BUY\",\n      \"fiat_code\": \"USD\",\n      \"coin_code\": \"ETH\",\n      \"wallet_address\": \"xxxxxx360\",\n      \"blockchain\": {\n          \"code\": \"ERC20\",\n          \"description\": \"Ethereum\"\n      },  \n      \"created_at\": \"16-May-2022 10:30:43\",\n      \"checkout_url\": \"https://[merchant].banxa.com/portal?expires=xxx&oid=xxx&signature=xxx\"\n    }\n  }\n}\n\n","key":"OK","summary":"OK","id":"paths/~1api~1orders~1nft~1buy/post/responses/200/content/application~1json/examples/OK"},"paths/~1api~1orders~1nft~1buy/post/responses/422/content/application~1json/examples/Invalid Wallet Address":{"value":"{\n    \"errors\": {\n        \"status\": 422,\n        \"code\": 422,\n        \"title\": \"An invalid wallet address was entered.\"\n    }\n}","key":"Invalid Wallet Address","summary":"Invalid Wallet Address","id":"paths/~1api~1orders~1nft~1buy/post/responses/422/content/application~1json/examples/Invalid Wallet Address"},"paths/~1api~1orders~1nft~1buy/post/responses/422/content/application~1json/examples/Invalid payment method ID":{"value":"{\n    \"errors\": {\n        \"status\": 422,\n        \"code\": 422,\n        \"title\": \"Invalid payment method ID.\"\n    }\n}","key":"Invalid payment method ID","summary":"Invalid payment method ID","id":"paths/~1api~1orders~1nft~1buy/post/responses/422/content/application~1json/examples/Invalid payment method ID"},"paths/~1api~1orders~1{order_id}/get/responses/200/content/application~1json/examples/Result":{"value":"{\n  \"data\": {\n    \"order\": {\n      \"id\": \"7f954c2eaea52db2d7e57d839620a764\",\n      \"account_id\": \"564d914ba50d51d67095817f1559e0a7\",\n      \"account_reference\": \"098f6bcd4621d373cade4e832627b4f6\",\n      \"order_type\": \"CRYPTO-BUY\",\n      \"payment_type\": \"POLI\",\n      \"ref\": 1,\n      \"fiat_code\": \"AUD\",\n      \"fiat_amount\": 200,\n      \"coin_code\": \"BTC\",\n      \"coin_amount\": 0.015,\n      \"wallet_address\": \"1LbQ1WNTsm1Nzj1hbh3WDCbEim1oUg5rfi\",\n      \"blockchain\": {\n           \"code\": \"BTC\",\n           \"description\": \"Bitcoin\",\n           \"contract_id\": null,\n           \"network_id\": null\n       },  \n      \"fee\": 4.3,\n      \"payment_fee\": 0,\n      \"commission\": 0.03,\n      \"tx_hash\": \"323bf75d66fd5a4fe8c903f950d81c5f0170bacd0f872cde8f4f3d6e7c94db35\",\n      \"created_at\": \"2020-06-01 00:20:51\",\n      \"status\": \"complete\",\n      \"meta_data\": \"{'tracking_id': 'HSKJDGHKSJG0393LJKJF'}\"\n    }\n  }\n}","key":"Result","summary":"Result","id":"paths/~1api~1orders~1{order_id}/get/responses/200/content/application~1json/examples/Result"},"paths/~1api~1orders~1{order_id}/get/responses/200/content/application~1json/examples/With Promotion":{"value":"{\n  \"data\": {\n    \"orders\": [\n      {\n        \"id\": \"324b04c9wertewrt373904a1f3040\",\n        \"account_id\": \"deb9ffawertwret82b38af392c53\",\n        \"account_reference\": \"test001\",\n        \"order_type\": \"CRYPTO-BUY\",\n        \"ref\": 127079,\n        \"country\": \"AU\",\n        \"fiat_code\": \"EUR\",\n        \"fiat_amount\": 90,\n        \"coin_code\": \"BTC\",\n        \"coin_amount\": 0.00218361,\n        \"wallet_address\": \"1LfNoQ6a71YH1ertwer3rBeiYSvZAuK\",\n        \"wallet_address_tag\": null,\n        \"fee\": 0,\n        \"fee_tax\": 0,\n        \"payment_fee\": 0,\n        \"payment_fee_tax\": 0,\n        \"commission\": 0,\n        \"tx_hash\": null,\n        \"tx_confirms\": 0,\n        \"created_date\": \"04-Dec-2023\",\n        \"created_at\": \"04-Dec-2023 09:40:51\",\n        \"payment_type\": \"Checkout Credit Card\",\n        \"status\": \"paymentReceived\",\n        \"completed_at\": null,\n        \"merchant_fee\": 3.46,\n        \"merchant_commission\": 0,\n        \"meta_data\": null,\n        \"blockchain\": {\n          \"code\": \"BTC\",\n          \"description\": \"Bitcoin\",\n          \"contract_id\": null,\n          \"network_id: null\n        },\n        \"network_fee\": 0,\n        \"discount\": {\n          \"before_crypto_amount\": 0.00194295,\n          \"after_crypto_amount\": 0.00218361,\n          \"before_network_fee\": 4.69,\n          \"after_network_fee\": 0,\n          \"before_gateway_fee\": 1.76,\n          \"after_gateway_fee\": 0,\n          \"before_fiat_amount\": 90,\n          \"after_fiat_amount\": 90\n        }\n      }\n    ]\n  }\n}\n","key":"With Promotion","summary":"With Promotion","id":"paths/~1api~1orders~1{order_id}/get/responses/200/content/application~1json/examples/With Promotion"},"paths/~1api~1orders~1{order_id}~1confirm/post/responses/200/content/application~1json/examples/Result":{"value":"{\n    \"data\": {\n        \"order\": {\n            \"id\": \"21bbacbe9655f4c6fa3d696bed14f974\",\n            \"account_id\": \"7cd01995c81658527cf38af0cad523a3\",\n            \"account_reference\": \"test000101\",\n            \"order_type\": \"CRYPTO-SELL\",\n            \"payment_type\": \"DIRECTCREDIT\",\n            \"ref\": 103993,\n            \"fiat_code\": \"AUD\",\n            \"fiat_amount\": 100,\n            \"coin_code\": \"BTC\",\n            \"coin_amount\": 0.00159514,\n            \"wallet_address\": \"2NBK1YYH7Uaj1TA94LzUcLtApb4vMpxSTeb\",\n            \"fee\": 0,\n            \"payment_fee\": 0,\n            \"commission\": 0,\n            \"tx_hash\": null,\n            \"created_at\": \"15-Jul-2021 00:37:51\",\n            \"status\": \"coinTransferReady\",\n            \"completed_at\": null,\n            \"merchant_fee\": 0,\n            \"meta_data\": null,\n      \t\t\t\"blockchain\": {\n        \t\t\t\t\"code\": \"BTC\",\n        \t\t\t\t\"description\": \"Bitcoin\"\n     \t\t\t\t }\n        }\n    }\n}","key":"Result","summary":"Result","id":"paths/~1api~1orders~1{order_id}~1confirm/post/responses/200/content/application~1json/examples/Result"},"paths/~1api~1identities/post/responses/200/content/application~1json/examples/Result":{"value":"{\n    \"data\": {\n        \"account\": {\n            \"account_id\": \"d3be8dfe1eea6f55725d5784a83d4ce9\",\n            \"account_reference\": \"test001001\"\n        }\n    }\n}","key":"Result","summary":"Result","id":"paths/~1api~1identities/post/responses/200/content/application~1json/examples/Result"},"paths/~1api~1identities/post/responses/422/content/application~1json/examples/Result":{"value":"{\n    \"message\": \"The given data was invalid.\",\n    \"errors\": {\n        \"customer_identity.dob\": [\n            \"The customer identity.dob does not match the format Y-m-d.\"\n        ]\n    }\n}","key":"Result","summary":"Result","id":"paths/~1api~1identities/post/responses/422/content/application~1json/examples/Result"},"paths/~1api~1identities~1reliance/post/responses/200/content/application~1json/examples/Result":{"value":"{\n    \"data\": {\n        \"account\": {\n            \"account_id\": \"d3be8dfe1eea6f55725d5784a83d4ce9\",\n            \"account_reference\": \"test001001\"\n        }\n    }\n}","key":"Result","summary":"Result","id":"paths/~1api~1identities~1reliance/post/responses/200/content/application~1json/examples/Result"},"paths/~1api~1identities~1reliance/post/responses/422/content/application~1json/examples/Result":{"value":"{\n    \"errors\": [\n        {\n            \"status\": \"422\",\n            \"title\": \"Invalid Parameters\",\n            \"detail\": {\n                \"account_reference\": \"The account reference field is required when mobile is not present.\",\n                \"mobile\": \"The mobile field is required when account reference is not present.\"\n            }\n        }\n    ]\n}","key":"Result","summary":"Result","id":"paths/~1api~1identities~1reliance/post/responses/422/content/application~1json/examples/Result"}},"securitySchemeStore":{"sec0":{"id":"sec0","type":"apiKey","in":"header","paramName":"Authorization"}},"servers":[{"url":"/_mock/products/legacy-api/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://api.banxa.com"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/products/legacy-api/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/legacy-api/openapi.json?download"},{"url":"/_bundle/products/legacy-api/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Legacy API","description":"> For the complete documentation index, see [llms.txt](https://docs.banxa.com/llms.txt). Append `.md` to any page URL for its markdown version."}},"baseSlug":"/products/legacy-api/openapi","routesMapping":{}}