{"_id":"@banxa-global/js-sdk","_rev":"6-88becaf9899df34cfa61d8a4a74c1994","time":{"created":"2023-02-15T01:21:41.425Z","1.0.0":"2023-02-15T00:54:34.774Z","modified":"2023-12-12T06:16:20.414Z","1.0.1":"2023-02-15T01:21:41.736Z","1.0.2":"2023-03-17T05:39:08.081Z","1.0.3":"2023-10-06T04:14:11.298Z","1.0.4":"2023-12-12T06:16:20.239Z"},"name":"@banxa-global/js-sdk","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.1":{"name":"@banxa-global/js-sdk","version":"1.0.1","description":"## Table of Contents","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"prepare":"npm run build","build":"tsc","test":"mocha --require ts-node/register **/*.spec.ts"},"keywords":[],"author":"","license":"ISC","devDependencies":{"@types/chai":"^4.3.3","@types/mocha":"^9.1.1","@types/node":"^16.11.10","@typescript-eslint/eslint-plugin":"^5.4.0","@typescript-eslint/parser":"^5.4.0","chai":"^4.3.6","eslint":"^8.3.0","eslint-config-airbnb-base":"^15.0.0","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.3","eslint-plugin-prettier":"^4.0.0","mocha":"^10.0.0","nock":"^13.2.9","prettier":"^2.4.1","ts-node":"^10.9.1","typescript":"^4.5.2"},"dependencies":{"axios":"^0.24.0"},"gitHead":"869420dd6c3cb3f4356d14a0981942d66241cfe6","_id":"@banxa-global/js-sdk@1.0.1","_nodeVersion":"16.19.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-sfFmHlgyE7N9UsG5SlS5imtxQEXHZ0oiYFe5/+kRLeKXcdqUduQ5m4yAbpiy4GoTkLR/uS0hRlB7mfv4b8iRHA==","shasum":"698bcc71af7deada272fb578eb4c9558bcc51421","tarball":"https://registry.npmjs.org/@banxa-global/js-sdk/-/js-sdk-1.0.1.tgz","fileCount":186,"unpackedSize":333486,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIE4vLq+8wfSobD2er2htrWlJQM9Kolbb+fbCtQYhHKRmAiAYX6cpqqoek+RIz9XUUMS/FLPzZ2h6JGAT4g0FZyrSag=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj7DOlACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq6qA//UdaG1i6gvEzVk8AOiEEJk7kkciNHyNAI2y/waCdWo75CF4gy\r\n2Xr7wHhElAM4nPV/VDisw7MfWRWFlFBYU+kN4f2731qNneYFe9BTyxd7vS/u\r\nWZZlbCa0AQKJLBD1t98OmEsYHJ6iw5QqGcQLqlGqxZ6fFWf9vdqlmL4KHDza\r\nK7h697g/mhx17XfWP1/Zqh7NVFLWyMUAiNjuwyYEt/VviVwytCuJYZGClYc1\r\ns/Zf8Y61c+sOwJwAFa9s2nVvSJUMywqC9syC35+FcK1mGcY9TpDMU/xlWDiT\r\ncwA8BVqCR51iPcHtPTDqqr3u90j3dZ0NseEu8T0eJtie0zaqQRTcI52R65nC\r\nevKl3pp0voZJh5eW7L80n1JUWjdxrSLceXLxkAFn+Sy0OQ1mezbGF4NuvW2h\r\n681hsHEc0pEXeTxrABeMobnteSmzupJqmduysEKzx/MJ6CcIGmxMQTm2Hae0\r\nULwcEcmaicU0tqxA8kjMbild1sk0mnBG3LS/v5gKSpBbDpVeVMA70gVy8wmP\r\ndN6OQxrvKV+nGPchho9+5MtiUbczSreI/5CYdkRsQMURaNLbM/mf6rI5OEbD\r\nmGcmM5D2NjuRLopgmkBp8kNtf04a2tj+iepX1jC4mjFvXnxc529d104BPvZ+\r\nqQ09/DHF7RipWwGMmlj5K97Xz3rRlMmh4xU=\r\n=rE5a\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"banxa-global","email":"johnpaul@banxa.com"},"directories":{},"maintainers":[{"name":"banxa-global","email":"johnpaul@banxa.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/js-sdk_1.0.1_1676424101519_0.46182368418526276"},"_hasShrinkwrap":false},"1.0.2":{"name":"@banxa-global/js-sdk","version":"1.0.2","description":"## Table of Contents","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"prepare":"npm run build","build":"tsc","test":"mocha --require ts-node/register **/*.spec.ts"},"keywords":[],"author":"","license":"ISC","devDependencies":{"@types/chai":"^4.3.3","@types/mocha":"^9.1.1","@types/node":"^16.11.10","@typescript-eslint/eslint-plugin":"^5.4.0","@typescript-eslint/parser":"^5.4.0","chai":"^4.3.6","eslint":"^8.3.0","eslint-config-airbnb-base":"^15.0.0","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.3","eslint-plugin-prettier":"^4.0.0","mocha":"^10.0.0","nock":"^13.2.9","prettier":"^2.4.1","ts-node":"^10.9.1","typescript":"^4.5.2"},"dependencies":{"axios":"^0.24.0"},"gitHead":"586abd794e31667e51efb0925467573a8966b500","_id":"@banxa-global/js-sdk@1.0.2","_nodeVersion":"16.19.1","_npmVersion":"8.19.3","dist":{"integrity":"sha512-BDBwFPCHlaD23XFxv9N2g2Cvy2czU4w9s+IxlHu3hTQE/PS5wncpmhiJuJVN8yxy+uivPWZtaXl2cKC9CTFx6g==","shasum":"d9e1657fcb110e633d796a377b1e7373696e4c54","tarball":"https://registry.npmjs.org/@banxa-global/js-sdk/-/js-sdk-1.0.2.tgz","fileCount":148,"unpackedSize":268356,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEXfZQuANB7+CPsZNVHpr1ZvFHwigsYWIXyxl8FW5YLtAiB7WSE7hjlBQThBgXMIMjZU5UsqmP/2DAdDdj+jQ8B2PA=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkE/z8ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp3HRAAkysl0bxQPvOX+BzKpm6FJOKp6g7KTDfPo6ErchOzz+pSrpL3\r\nvU56S2OMHVRltuYVI37wXl41z8hQsih6ZaChLlB4JTHMqKjMCMP0wcQpq6+K\r\nBUBB33PcRuGFxjU/XNMt1TnXk67DXlfId+39+2ckUTL27X82I4W21iaGaDNw\r\n+jLvqlIBJO/eX0cSJDF+hqsIO7HQXbGdPjNiR1gsQFcc/e0sixkKO5pZgYUi\r\nuW4dKgyhYo0vzrDCK6MxGUAiGoIqjUg/kMotrKHkg0CqTEq3K8iu58yQvTB7\r\nNJZv9aTI2/kLqXZdrDup89jAP9BbWfcoux7KkGK/G5S48IwR2ojKJGITXzrq\r\ndKWfUkq3ihgSbdZNHzemgXiLjwqPeTEmt1lRlhSb/1mxWn5cfgTMjcpOip86\r\nG/Ud8ZDGuUFDCUm1HulH6kO5QZLien3Ih9o3Z4bYw/CLnEySsChvWmrXUlYj\r\nM8wBQwpUnZtoghB5qh5ux/Y6FxEgRErg6h1itm7X5yIcDM8xNDnl8HBvONLf\r\nTlvCVtIGKNrTtKA5lDWejJyOqhIE8o75UXAtNweiGVfDMC9ncWs0vVVqYPXh\r\n1b/1VIRj0gTNuG9guGcuNG34P/iHt5+wNaGPTSlwiBHKmM++vSZuhGO0rTI1\r\nkS134c0N2HJ5jVgA/NNBqDzCmXGvFc93UkY=\r\n=a1E7\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"banxa-global","email":"johnpaul@banxa.com"},"directories":{},"maintainers":[{"name":"banxa-global","email":"johnpaul@banxa.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/js-sdk_1.0.2_1679031547903_0.46131907368714"},"_hasShrinkwrap":false},"1.0.3":{"name":"@banxa-global/js-sdk","version":"1.0.3","description":"## Table of Contents","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"prepare":"npm run build","build":"tsc","test":"mocha --require ts-node/register **/*.spec.ts"},"keywords":[],"author":"","license":"ISC","devDependencies":{"@types/chai":"^4.3.3","@types/mocha":"^9.1.1","@types/node":"^16.11.10","@typescript-eslint/eslint-plugin":"^5.4.0","@typescript-eslint/parser":"^5.4.0","chai":"^4.3.6","eslint":"^8.3.0","eslint-config-airbnb-base":"^15.0.0","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.3","eslint-plugin-prettier":"^4.0.0","mocha":"^10.0.0","nock":"^13.2.9","prettier":"^2.4.1","ts-node":"^10.9.1","typescript":"^4.5.2"},"dependencies":{"axios":"^0.24.0"},"gitHead":"e9d0e543f0044c9b2040d05d565b014b6737fffb","_id":"@banxa-global/js-sdk@1.0.3","_nodeVersion":"16.20.2","_npmVersion":"8.19.4","dist":{"integrity":"sha512-8k/zvjmPn1KBfvW6MwuiOHlMjtCMl0gisOhMAwXW90HVhyKDwAgziwJEb569zxCBgIwjSmpGztrZccGjBsfidA==","shasum":"7ed0db3855e02678a5b0562bffc1947a2ed52e49","tarball":"https://registry.npmjs.org/@banxa-global/js-sdk/-/js-sdk-1.0.3.tgz","fileCount":149,"unpackedSize":279864,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD+fkJek57AQ0/d8x1xWK15KQgb7N0o2DhFGjhwHHb6xAIhANAvocBsuutXOKkEtbUZMC1BbsY1sDBdt8L87q2kOzQ9"}]},"_npmUser":{"name":"banxa-global","email":"johnpaul@banxa.com"},"directories":{},"maintainers":[{"name":"banxa-global","email":"johnpaul@banxa.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/js-sdk_1.0.3_1696565651044_0.38004849375154315"},"_hasShrinkwrap":false},"1.0.4":{"name":"@banxa-global/js-sdk","version":"1.0.4","description":"## Table of Contents","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"prepare":"npm run build","build":"tsc","test":"mocha --require ts-node/register **/*.spec.ts"},"keywords":[],"author":"","license":"ISC","devDependencies":{"@types/chai":"^4.3.3","@types/mocha":"^9.1.1","@types/node":"^16.11.10","@typescript-eslint/eslint-plugin":"^5.4.0","@typescript-eslint/parser":"^5.4.0","chai":"^4.3.6","eslint":"^8.3.0","eslint-config-airbnb-base":"^15.0.0","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.3","eslint-plugin-prettier":"^4.0.0","mocha":"^10.0.0","nock":"^13.2.9","prettier":"^2.4.1","ts-node":"^10.9.1","typescript":"^4.5.2"},"dependencies":{"axios":"^0.24.0"},"gitHead":"47b073d8c4f9a3a091f0c608bcd8dd18fb62fb24","_id":"@banxa-global/js-sdk@1.0.4","_nodeVersion":"16.20.2","_npmVersion":"8.19.4","dist":{"integrity":"sha512-Caw/jKBYEGOp4ZjW8gcfu2/DykusOtBK0rOnMtUIV1d9/xnWAI0MHYcwDAwXN1eCdWi+peT1MSNZ3mRxZHdKDg==","shasum":"dd9a680d2e3d6b9688cfb9820bb48b68ad3074be","tarball":"https://registry.npmjs.org/@banxa-global/js-sdk/-/js-sdk-1.0.4.tgz","fileCount":149,"unpackedSize":279902,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFU5vGKdi8tYw7oxDu8bnPUzw0NzyGiiEnpd73mSNxc5AiEAsr3LdepJ7Nj2eOWMKpxZ+9GqbSa0wgKv26SdTGgr8Tc="}]},"_npmUser":{"name":"banxa-global","email":"johnpaul@banxa.com"},"directories":{},"maintainers":[{"name":"banxa-global","email":"johnpaul@banxa.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/js-sdk_1.0.4_1702361780010_0.7278899997453949"},"_hasShrinkwrap":false}},"maintainers":[{"name":"banxa-global","email":"johnpaul@banxa.com"}],"description":"## Table of Contents","keywords":[],"license":"ISC","readme":"## Banxa official js SDK\n\n## Table of Contents\n\n<!-- TOC -->\n\n* [General info](#general-info)\n    * [Installation](#installation)\n    * [Authentication](#authentication)\n        * [Domain, ApiKey and ApiSecret](#apikey-and-apisecret)\n    * [Dependencies](#dependencies)\n    * [Usage](#usage)\n        * [Sandbox](#sandbox)\n        * [Production](#production)\n* [Localisation](#localisation)\n    * [Countries](#countries)\n    * [US States](#us-states)\n* [Currencies](#currencies)\n    * [Fiat](#fiat)\n    * [Crypto](#crypto)\n* [Payment Methods](#payment-methods)\n    * [Buy & Sell order type](#buy--sell-order-type-payment-methods)\n    * [Buy order type](#buy-order-type-payment-methods)\n    * [Sell order type](#sell-order-type-payment-methods)\n* [Prices](#prices)\n    * [Buy order types](#buy-order-types-pricing)\n    * [Buy order type](#buy-order-type-pricing)\n    * [Sell order types](#sell-order-types-pricing)\n    * [Sell order type](#sell-order-type-pricing)\n* [Orders](#orders)\n    * [Retrieving Order(s)](#retrieving-orders)\n        * [Fetch orders](#fetch-orders)\n        * [Fetch order](#fetch-order)\n    * [Order creation](#creating-orders)\n        * [Creating a buy order](#creating-a-buy-order)\n        * [Creating a NFT buy order](#creating-a-nft-buy-order)\n        * [Creating a sell order](#creating-a-sell-order)\n    * [Confirm sell order](#confirm-sell-order)\n* [Identity](#identity)\n    * [Create Identity](#create-identity)\n\n<!-- TOC -->\n\n# General info\n\nThe Banxa SDK is a plug and play ready to go implementation to access our services.   \nIt allows for a simple and fast integration.\n\n# Installation\n\nInstall the package via [npm](https://npmjs.com/)\n\n```\nnpm i @banxa-global/js-sdk \n```\n\n# Authentication\n\n## ApiKey and ApiSecret\n\nWhile on-boarding with banxa, you will be provided with API keys and a subdomain ([partnername].banxa.com),   \ninitially these will be for the sandbox\nenvironment.\nOnce you are done testing the implementation, you will receive the credentials to use the production environment.\n\n# Usage\n\n```js\nBanxa.create(subdomain, apiKey, apiSecret, testMode)\n```\n\n| Property     | type     | required | description                                                         |\n|--------------|----------|----------|---------------------------------------------------------------------|\n| `subdomain` | `string` | `true`   | The subdomain provided by banxa. ([partnername].banxa.com)          |\n| `apiKey`    | `string` | `true`   | Given API key                                                       |\n| `apiSecret` | `string` | `true`   | Given API Secret                                                    |\n| `testMode`  | `bool`   | `false`  | Enable if testing, and provide sandbox api key and secret to method |\n\n###### Sandbox\n\n```js\nconst subdomain = 'partner';\nconst sandboxApiKey = 'xxx-xxx-xxx-xxx-xxx';\nconst sandboxApiSecret = 'xxxx-xxxx-xxxx-xxxx';\nconst testMode = true;\nBanxa.create(subdomain, sandboxApiKey, sandboxApiSecret, testMode)\n ````\n\n###### Production\n\n```js\nconst subdomain = 'partner';\nconst apiKey = 'xxx-xxx-xxx-xxx-xxx';\nconst apiSecret = 'xxxx-xxxx-xxxx-xxxx';\nBanxa.create(subdomain, apiKey, apiSecret)\n````\n\n---\n\n# Localisation\n\n## Countries\n\n> ### Global\n> **Fetch all available countries**\n>```js\n> banxa.getCountries()\n>```\n\n**Result Example**\n\n ```json\n[\n    {\n        \"country_code\" : \"AD\",\n        \"country_name\" : \"Andora\"\n    },\n    {\n        \"country_code\" : \"AE\",\n        \"country_name\" : \"United Arab Emirates\"\n    }\n]\n ```\n\n### US States\n\n> **Fetch all available US States**\n> ```js\n> banxa.getUsStates()\n>```\n\n**Result Example**\n\n ```json\n[\n    {\n        \"state_code\" : \"AL\",\n        \"state_name\" : \"Alabama\"\n    },\n    {\n        \"state_code\" : \"AK\",\n        \"state_name\" : \"Alaska\"\n    }\n]\n ```\n\n---\n\n# Currencies\n\n## Fiat\n\n> ### Buy order type\n> **Fetch all available fiat currencies for buy order type.**\n>\n>```js\n> banxa.getBuyFiatCurrencies()\n>```\n> ### Sell order type\n> **Fetch all available fiat currencies for sell order type.**\n>```js\n> banxa.getSellFiatCurrencies()\n>```\n\n**Result Example**\n\n ```json\n[\n   {\n       \"fiat_code\"   : \"EUR\",\n       \"fiat_name\"   : \"Euro\",\n       \"fiat_symbol\" : \"€\"\n   },\n   {\n       \"fiat_code\"   : \"GBP\",\n       \"fiat_name\"   : \"British Pound Sterling\",\n       \"fiat_symbol\" : \"£\"\n   }\n ]\n        \n ```\n\n---\n\n## Crypto\n\n> ### Buy order type\n> **Fetch all cryptocurrencies for buy order type.**\n>\n>```js\n> banxa.getBuyCryptoCurrencies()\n>```\n> ### Sell order type\n> **Fetch all cryptocurrencies for sell-order type.**\n>```js\n> banxa.getSellCryptoCurrencies()\n>```\n\n**Result Example**\n\n ```json\n[\n    {\n        \"coin_code\": \"BTC\",\n        \"coin_name\": \"Bitcoin\",\n        \"blockchains\": [\n            {\n                \"code\": \"BTC\",\n                \"description\": \"Bitcoin\",\n                \"is_default\": true\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            },\n            {\n                \"code\": \"MATIC\",\n                \"description\": \"Polygon\",\n                \"is_default\": false\n            }\n        ]\n    }\n]\n ```\n\n---\n\n# Payment Methods\n\n### Buy & Sell order type payment methods\n\n> **Fetch all available payment providers for buy and sell order type**\n>```js\n> banxa.getAllPaymentMethods()\n>```\n\n**Result Example**\n\n ```json\n[\n   {\n        \"id\"               : 6036,\n        \"paymentType\"      : \"WORLDPAYCREDIT\",\n        \"name\"             : \"Visa/Mastercard\",\n        \"description\"      : \"Conveniently buy digital currency using your personal VISA or MasterCard.\",\n        \"logo_url\"         : \"https://cremorne.1cart.test/images/payment-providers/worldpaycredit.png\",\n        \"status\"           : \"ACTIVE\",\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        \"type\"             : \"FIAT_TO_CRYPTO\",\n        \"supported_fiat\"   : [\n            \"AED\"\n        ],\n        \"transaction_fees\" : [\n            {\n                \"fiat_code\" : \"AED\",\n                \"coin_code\" : \"BTC\",\n                \"fees\"      : [\n                    {\n                        \"name\"   : \"surcharge\",\n                        \"amount\" : 3,\n                        \"type\"   : \"fixed\"\n                    }\n                ]\n            }\n        ]\n    },\n    {\n        \"id\"               : 6036,\n        \"paymentType\"      : \"WORLDPAYAPPLE\",\n        \"name\"             : \"Apple Pay\",\n        \"description\"      : \"Conveniently buy digital currency using your Apple Pay wallet.\",\n        \"logo_url\"         : \"https://cremorne.1cart.test/images/payment-providers/apple-pay.png\",\n        \"status\"           : \"ACTIVE\",\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        \"type\"             : \"CRYPTO_TO_FIAT\",\n        \"supported_fiat\"   : [\n            \"AED\"\n        ],\n        \"transaction_fees\" : [\n            {\n                \"fiat_code\" : \"AED\",\n                \"coin_code\" : \"BTC\",\n                \"fees\"      : [\n                    {\n                        \"name\"   : \"surcharge\",\n                        \"amount\" : 3,\n                        \"type\"   : \"fixed\"\n                    }\n                ]\n            }\n        ]\n    }\n]\n ```\n\n### Buy order type payment methods\n\n> **Fetch all available payment providers for buy order type**\n>```js\n> banxa.getBuyPaymentMethods(fiatCode, coinCode)\n>```\n\n| Property    | type     | required | description                                                                            |\n|-------------|----------|----------|----------------------------------------------------------------------------------------|\n| `fiatCode` | `string` | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats      |\n| `coinCode` | `string` | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto |\n\n**Result Example**\n\n ```json\n{\n    \"id\"               : 6036,\n    \"paymentType\"      : \"WORLDPAYAPPLE\",\n    \"name\"             : \"Apple Pay\",\n    \"description\"      : \"Conveniently buy digital currency using your Apple Pay wallet.\",\n    \"logo_url\"         : \"https://cremorne.1cart.test/images/payment-providers/apple-pay.png\",\n    \"status\"           : \"ACTIVE\",\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    \"type\"             : \"CRYPTO_TO_FIAT\",\n    \"supported_fiat\"   : [\n        \"AED\"\n    ],\n    \"transaction_fees\" : [\n        {\n            \"fiat_code\" : \"AED\",\n            \"coin_code\" : \"BTC\",\n            \"fees\"      : [\n                {\n                    \"name\"   : \"surcharge\",\n                    \"amount\" : 3,\n                    \"type\"   : \"fixed\"\n                }\n            ]\n        }\n    ]\n}\n\n ```\n\n### Sell order type payment methods\n\n> **Fetch all available payment methods for sell order type**\n>```js\n> banxa.getSellPaymentMethods(coinCode, fiatCode)\n>```\n\n| Property    | type     | required | description                                                                           |\n|-------------|----------|----------|---------------------------------------------------------------------------------------|\n| `coinCode` | `string` | `true`   | Coin code e.g. 'BTC' or 'ETH see [Crypto](#crypto) to get a list all available crypto |\n| `fiatCode` | `string` | `true`   | Fiat code e.g. 'USD' or 'EUR see [Fiat](#fiat) to get a list all available fiats      |\n\n**Result Example**\n\n ```json\n{\n    \"id\"               : 6036,\n    \"paymentType\"      : \"WORLDPAYCREDIT\",\n    \"name\"             : \"Visa/Mastercard\",\n    \"description\"      : \"Conveniently buy digital currency using your personal VISA or MasterCard.\",\n    \"logo_url\"         : \"https://cremorne.1cart.test/images/payment-providers/worldpaycredit.png\",\n    \"status\"           : \"ACTIVE\",\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    \"type\"             : \"FIAT_TO_CRYPTO\",\n    \"supported_fiat\"   : [\n        \"AED\"\n    ],\n    \"transaction_fees\" : [\n        {\n            \"fiat_code\" : \"AED\",\n            \"coin_code\" : \"BTC\",\n            \"fees\"      : [\n                {\n                    \"name\"   : \"surcharge\",\n                    \"amount\" : 3,\n                    \"type\"   : \"fixed\"\n                }\n            ]\n        }\n    ]\n}\n```\n\n--- \n\n# Prices\n\nGet prices for [Payment Methods](#payment-methods) to obtain a payment method id for each specific fiat and coin\ncombination. Should be called when a user requests prices by providing the cryptocurrency, fiat, and fiat amount.\n\n(Rate limited)\n\n### Buy order types pricing\n\n> **Fetch available price for buy order type for all payment method**\n>```js\n> banxa.getAllBuyPrices(\n>   fiatCode,\n>   coinCode,\n>   fiatAmount,\n>   blockchain\n> )\n>```\n\n| Property      | description        | required | description                                                                                                  |\n|:--------------|:-------------------|:---------|:-------------------------------------------------------------------------------------------------------------|\n| `fiatCode`   | `string`           | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats                            |\n| `coinCode`   | `string`           | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto                       |\n| `fiatAmount` | `string/number` | `true`   | Fiat amount                                                                                                  |\n| `blockchain` | `string`           | `false`  | Blockchain code e.g. 'ETH' or 'TRON' see [Crypto](#crypto) to get a list all available blockchains per coin. |\n\n> **Fetch available price for buy order type for all payment method with coin amount**\n>```js\n> banxa.getAllBuyPricesFromCoinAmount(\n>   fiatCode,\n>   coinCode,\n>   coinAmount,\n>   blockchain\n> )\n>```\n\n| Property      | description        | required | description                                                                                                  |\n|:--------------|:-------------------|:---------|:-------------------------------------------------------------------------------------------------------------|\n| `fiatCode`   | `string`           | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats                            |\n| `coinCode`   | `string`           | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto                       |\n| `coinAmount` | `string/number`    | `true`   | Coin amount                                                                                                  |\n| `blockchain` | `string`           | `false`  | Blockchain code e.g. 'ETH' or 'TRON' see [Crypto](#crypto) to get a list all available blockchains per coin. |\n\n**Result Example**\n\n```json\n{\n    \"spot_price\" : \"1.07\",\n    \"prices\" : [\n        {\n            \"payment_method_id\" : 6047,\n            \"type\" : \"FIAT_TO_CRYPTO\",\n            \"spot_price_fee\" : \"0.00\",\n            \"spot_price_including_fee\" : \"1.07\",\n            \"coin_amount\" : \"93.84000000\",\n            \"coin_code\" : \"USDT\",\n            \"fiat_amount\" : \"100.00\",\n            \"fiat_code\" : \"USD\",\n            \"fee_amount\" : \"0.00\",\n            \"network_fee\" : \"2.37\"\n        },\n        {\n            \"payment_method_id\" : 6058,\n            \"type\" : \"FIAT_TO_CRYPTO\",\n            \"spot_price_fee\" : \"0.00\",\n            \"spot_price_including_fee\" : \"1.09\",\n            \"coin_amount\" : \"93.84000000\",\n            \"coin_code\" : \"USDT\",\n            \"fiat_amount\" : \"100.00\",\n            \"fiat_code\" : \"USD\",\n            \"fee_amount\" : \"0.00\",\n            \"network_fee\" : \"2.37\"\n        }\n    ]\n}\n```\n\n---\n\n### Buy order type pricing\n\n> **Fetch single price for buy order type for a specific payment method**\n> ```js\n> banxa.getBuyPrice(\n>    fiatCode,\n>    coinCode,\n>    fiatAmount,\n>    paymentMethodId,\n>    blockchain\n> )\n>```\n\n| Property             | type               | required | required                                                                                                                                      |\n|:---------------------|:-------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------|\n| `fiatCode`          | `string`           | `true`   | Fiat code e.g. 'USD' or 'EUR see [Fiat](#fiat) to get a list all available fiats                                                              |\n| `coinCode`          | `string`           | `true`   | Coin code e.g. 'BTC' or 'ETH see [Crypto](#crypto) to get a list all available crypto                                                         |\n| `fiatAmount`        | `string/number` | `true`   | Fiat amount                                                                                                                                   |\n| `payment_method_id` | `string/number` | `true`   | Unique ID for the payment method that you want to get prices for. see [Payment Methods](#payment-methods) to get a list of payment providers. |\n| `blockchain`        | `string`           | `false`  | Blockchain code e.g. 'ETH' or 'TRON' see [Crypto](#crypto) to get a list all available blockchains per coin.                                  |\n\n> **Fetch single price for buy order type for a specific payment method with coin amount**\n> ```js\n> banxa.getBuyPricesFromCoinAmount(\n>    fiatCode,\n>    coinCode,\n>    coinAmount,\n>    paymentMethodId,\n>    blockchain\n> )\n>```\n\n| Property             | type               | required | required                                                                                                                                      |\n|:---------------------|:-------------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------|\n| `fiatCode`          | `string`           | `true`   | Fiat code e.g. 'USD' or 'EUR see [Fiat](#fiat) to get a list all available fiats                                                              |\n| `coinCode`          | `string`           | `true`   | Coin code e.g. 'BTC' or 'ETH see [Crypto](#crypto) to get a list all available crypto                                                         |\n| `coinAmount`        | `string/number` | `true`   | Coin amount                                                                                                                                   |\n| `payment_method_id` | `string/number` | `true`   | Unique ID for the payment method that you want to get prices for. see [Payment Methods](#payment-methods) to get a list of payment providers. |\n| `blockchain`        | `string`           | `false`  | Blockchain code e.g. 'ETH' or 'TRON' see [Crypto](#crypto) to get a list all available blockchains per coin.    \n\n**Result Example**\n\n```json\n{\n    \"payment_method_id\" : 6058,\n    \"type\" : \"FIAT_TO_CRYPTO\",\n    \"spot_price_fee\" : \"0.00\",\n    \"spot_price_including_fee\" : \"1.09\",\n    \"coin_amount\" : \"93.84000000\",\n    \"coin_code\" : \"USDT\",\n    \"fiat_amount\" : \"100.00\",\n    \"fiat_code\" : \"USD\",\n    \"fee_amount\" : \"0.00\",\n    \"network_fee\" : \"2.37\"\n}\n```\n\n## Sell order types pricing\n\n> **Fetch all available prices for sell order type**\n> ```js\n> banxa.getAllSellPrices(\n>   coinCode, \n>   fiatCode, \n>   coinAmount\n> )\n> ```\n\n| Property      | type               | required | description                                                                            |\n|:--------------|:-------------------|:---------|:---------------------------------------------------------------------------------------|\n| `coinCode`   | `string`           | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto |\n| `fiatCode`   | `string`           | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats      |\n| `coinAmount` | `string/number` | `true`   | Crypto amount that will be used to calculate the fiat amount                           |\n\n> **Fetch all available prices for sell order type with fiat amount**\n> ```js\n> banxa.getAllSellPricesFromFiatAmount(\n>   coinCode, \n>   fiatCode, \n>   fiatAmount\n> )\n> ```\n\n| Property      | type               | required | description                                                                            |\n|:--------------|:-------------------|:---------|:---------------------------------------------------------------------------------------|\n| `coinCode`   | `string`           | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto |\n| `fiatCode`   | `string`           | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats      |\n| `fiatAmount` | `string/number` | `true`   | Fiat amount that will be used to calculate the coin amount                           |\n\n**Result Example**\n\n```json\n{\n    \"spot_price\" : \"1.07\",\n    \"prices\" : [\n        {\n            \"payment_method_id\" : 6045,\n            \"type\" : \"CRYPTO_TO_FIAT\",\n            \"spot_price_fee\" : \"0.00\",\n            \"spot_price_including_fee\" : \"32500.00\",\n            \"coin_amount\" : \"0.02000000\",\n            \"coin_code\" : \"BTC\",\n            \"fiat_amount\" : \"BTC.00\",\n            \"fiat_code\" : \"AUD\",\n            \"fee_amount\" : \"0.00\",\n            \"network_fee\" : \"0.00\"\n        },\n        {\n            \"payment_method_id\" : 6046,\n            \"type\" : \"CRYPTO_TO_FIAT\",\n            \"spot_price_fee\" : \"0.00\",\n            \"spot_price_including_fee\" : \"32500.00\",\n            \"coin_amount\" : \"0.02000000\",\n            \"coin_code\" : \"BTC\",\n            \"fiat_amount\" : \"650.00\",\n            \"fiat_code\" : \"AUD\",\n            \"fee_amount\" : \"0.00\",\n            \"network_fee\" : \"0.00\"\n        }\n    ]\n}\n```\n\n### Sell order type pricing\n\n> **Fetch single price for buy order type for a specific payment method**\n> ```js\n> banxa.getSellPrice(\n>   coinCode, \n>   fiatCode, \n>   coinAmount, \n>   paymentMethodId\n> )\n>```\n\n| Property             | type            | required | description                                                                                                                                   |\n|:---------------------|:----------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------|\n| `coinCode`          | `string`        | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto                                                        |\n| `fiatCode`          | `string`        | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats                                                             |\n| `coinAmount`        | `string/number` | `true`   | Crypto amount that will be used to calculate                                                                                                  |\n| `payment_method_id` | `string/number` | `true`   | Unique ID for the payment method that you want to get prices for. see [Payment Methods](#payment-methods) to get a list of payment providers. |\n\n> **Fetch single price for buy order type for a specific payment method with fiat amount**\n> ```js\n> banxa.getSellPricesFromFiatAmount(\n>   coinCode, \n>   fiatCode, \n>   fiatAmount, \n>   paymentMethodId\n> )\n>```\n\n| Property             | type            | required | description                                                                                                                                   |\n|:---------------------|:----------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------|\n| `coinCode`          | `string`        | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto                                                        |\n| `fiatCode`          | `string`        | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats                                                             |\n| `fiatAmount`        | `string/number` | `true`   | Fiat amount that will be used to calculate                                                                                                  |\n| `payment_method_id` | `string/number` | `true`   | Unique ID for the payment method that you want to get prices for. see [Payment Methods](#payment-methods) to get a list of payment providers. |\n\n**Result Example**\n\n```json\n{\n    \"payment_method_id\" : 6033,\n    \"type\" : \"CRYPTO_TO_FIAT\",\n    \"spot_price_fee\" : \"0.00\",\n    \"spot_price_including_fee\" : \"1.09\",\n    \"coin_amount\" : \"93.84000000\",\n    \"coin_code\" : \"USDT\",\n    \"fiat_amount\" : \"100.00\",\n    \"fiat_code\" : \"USD\",\n    \"fee_amount\" : \"0.00\",\n    \"network_fee\" : \"2.37\"\n}\n```\n\n---\n\n# Orders\n\n## Retrieving orders\n\n### Fetch orders\n\n> **Fetch all orders within a specific time range. (paginated)**\n>```js\n> banxa.getOrders(\n>   startDate, \n>   endDate, \n>   statuses, \n>   perPage, \n>   page, \n>   accountReference\n> )\n>```\n\n| Property                | type            | required | description                                                                                                           |\n|:------------------------|:----------------|:---------|:----------------------------------------------------------------------------------------------------------------------|\n| `startDate`            | `string`        | `true`   | Start date used for filtering orders. Must be a date in the format YYYY-MM-DD.                                        |\n| `endDate`              | `string`        | `true`   | End date used for filtering orders. Must be a date in the format YYYY-MM-DD.                                          |\n| `statuses`             | `array`         | `false`  | One or many order statuses (see 'Available Statuses')                                                                 |\n| `perPage`              | `string/number` | `false`  | Page size.                                                                                                            |\n| `page`                 | `string/number` | `false`  | Page to retrieve.                                                                                                     |\n| `accountReference`     | `string`        | `false`  | Customer reference that was passed as a parameter when creating an order. Used to retrieve all orders for a customer. |\n\n| Available Statuses              |\n|:--------------------------------|\n| pendingPayment`  |\n| `waitingPayment`  |\n| `paymentReceived` |\n| `inProgress`      |\n| `coinTransferred` |\n| `cancelled`        |\n| `declined`         |\n| `expired`          |\n| `complete`         |\n| `refunded`         |\n\n**Result Example**\n\n```json\n[\n    {\n        \"id\"                  : \"e7f3d4e436c8925af84a391f317aaa6e\",\n        \"account_id\"          : \"ebfef819583ff4573e6db307abd9c126\",\n        \"account_reference\"   : \"banxa-account\",\n        \"order_type\"          : \"CRYPTO-BUY\",\n        \"ref\"                 : 501903,\n        \"country\"             : \"AU\",\n        \"fiat_code\"           : \"AUD\",\n        \"fiat_amount\"         : 100,\n        \"coin_code\"           : \"BTC\",\n        \"coin_amount\"         : 0.00704583,\n        \"wallet_address\"      : \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n        \"wallet_address_tag\"  : null,\n        \"fee\"                 : 0,\n        \"fee_tax\"             : 0,\n        \"payment_fee\"         : 2.14,\n        \"payment_fee_tax\"     : 0.19,\n        \"commission\"          : 0,\n        \"tx_hash\"             : \"sync-tx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n        \"tx_confirms\"         : 10,\n        \"created_date\"        : \"01-Jul-2022\",\n        \"created_at\"          : \"01-Jul-2022 07:51:18\",\n        \"payment_type\"        : \"WorldPay Credit Card\",\n        \"status\"              : \"complete\",\n        \"completed_at\"        : \"01-Jul-2022 07:55:19\",\n        \"merchant_fee\"        : 0,\n        \"merchant_commission\" : 0,\n        \"meta_data\"           : null,\n        \"blockchain\"          : {\n            \"code\"        : \"BTC\",\n            \"description\" : \"Bitcoin\"\n        }\n    },\n    {\n        \"id\"                  : \"b719377e3541921297ebef33016fb068\",\n        \"account_id\"          : \"ebfef819583ff4573e6db307abd9c126\",\n        \"account_reference\"   : \"banxa-account\",\n        \"order_type\"          : \"CRYPTO-BUY\",\n        \"ref\"                 : 501902,\n        \"country\"             : \"AU\",\n        \"fiat_code\"           : \"AUD\",\n        \"fiat_amount\"         : 320,\n        \"coin_code\"           : \"BTC\",\n        \"coin_amount\"         : 0.02255405,\n        \"wallet_address\"      : \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n        \"wallet_address_tag\"  : null,\n        \"fee\"                 : 0,\n        \"fee_tax\"             : 0,\n        \"payment_fee\"         : 6.83,\n        \"payment_fee_tax\"     : 0.62,\n        \"commission\"          : 0,\n        \"tx_hash\"             : \"sync-tx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n        \"tx_confirms\"         : 10,\n        \"created_date\"        : \"01-Jul-2022\",\n        \"created_at\"          : \"01-Jul-2022 07:51:18\",\n        \"payment_type\"        : \"WorldPay Credit Card\",\n        \"status\"              : \"complete\",\n        \"completed_at\"        : \"01-Jul-2022 07:55:19\",\n        \"merchant_fee\"        : 0,\n        \"merchant_commission\" : 0,\n        \"meta_data\"           : null,\n        \"blockchain\"          : {\n            \"code\": \"BTC\",\n            \"description\": \"Bitcoin\"\n        }\n   }\n]\n```\n\n---\n\n### Fetch order\n\n> **Fetch single order**\n>```js\n> banxa.getOrder(orderId);\n>```\n\n| Property   | description | required | description                        |\n|:-----------|:------------|:---------|:-----------------------------------|\n| `orderId` | `string`    | `true`   | Unique ID of the order to retrieve |\n\n**Result Example**\n\n```json\n{\n    \"id\"                  : \"b719377e3541921297ebef33016fb068\",\n    \"account_id\"          : \"ebfef819583ff4573e6db307abd9c126\",\n    \"account_reference\"   : \"banxa-account\",\n    \"order_type\"          : \"CRYPTO-BUY\",\n    \"ref\"                 : 501902,\n    \"country\"             : \"AU\",\n    \"fiat_code\"           : \"AUD\",\n    \"fiat_amount\"         : 320,\n    \"coin_code\"           : \"BTC\",\n    \"coin_amount\"         : 0.02255405,\n    \"wallet_address\"      : \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"wallet_address_tag\"  : null,\n    \"fee\"                 : 0,\n    \"fee_tax\"             : 0,\n    \"payment_fee\"         : 6.83,\n    \"payment_fee_tax\"     : 0.62,\n    \"commission\"          : 0,\n    \"tx_hash\"             : \"sync-tx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"tx_confirms\"         : 10,\n    \"created_date\"        : \"01-Jul-2022\",\n    \"created_at\"          : \"01-Jul-2022 07:51:18\",\n    \"payment_type\"        : \"WorldPay Credit Card\",\n    \"status\"              : \"complete\",\n    \"completed_at\"        : \"01-Jul-2022 07:55:19\",\n    \"merchant_fee\"        : 0,\n    \"merchant_commission\" : 0,\n    \"meta_data\"           : null,\n    \"blockchain\"          : {\n        \"code\"        : \"BTC\",\n        \"description\" : \"Bitcoin\"\n    }\n}\n```\n\n---\n\n## Creating orders\n\nAllows your customer to create a buy or sell crypto order with Banxa. Upon success, the response will contain a checkout\nURL which will be unique for the order. The customer will be redirected to this URL to complete the checkout process,\nwhich will expire after 1 minute if a redirect does not occur.\n\nWhen creating an order you will be required to create a BuyOrderTransaction/SellOrderTransaction/NftBuyOrderTransaction\nobject.\nThis object will allow you to create a transaction using a fiat amount, coin amount, or if you require both, you can\nspecify your own amount using the createDynamic method, this will depend on your business use case.\n\n### Creating a buy order\n\n> ```js\n> banxa.createBuyOrder(\n>   buyOrderTransaction,\n>   returnUrlOnSuccess,\n>   returnUrlOnFailure,\n>   returnUrlOnCancelled,\n>   metadata,\n>   readOnlyAmounts,\n>   iframeRefererDomain,\n> );\n>```\n\n| Property                | type          | required | description                                                                                                                                                                 |\n|-------------------------|---------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `buyOrderTransaction`  | `Object`      | `true`   | `BuyOrderTransaction` object                                                                                                                                                |\n| `returnUrlOnSuccess`   | `string`      | `true`   | The return url on success                                                                                                                                                   | \n| `returnUrlOnFailure`   | `string/undefined` | `false`  | The return url on failure                                                                                                                                                   | \n| `returnUrlOnCancelled` | `string/undefined` | `false`  | The return url on cancelled                                                                                                                                                 | \n| `metadata`             | `string/undefined` | `false`  | Free form string that you can use to send us any information that will be returned in the Get Orders endpoint                                                               | \n| `readOnlyAmounts`      | `boolean`     | `false`  | Will cause the cryptocurrency and fiat amounts on the Banxa screens to be read-only and un-editable.                                                                        |\n| `iframeRefererDomain`  | `string/undefined` | `false`  | 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. |\n\n---\n\n> **BuyOrderTransaction using Fiat as base amount**\n>```js\n> const buyOrderTransaction = BuyOrderTransaction.createFromFiatAmount(\n>       accountReference, \n>       fiatCode, \n>       coinCode, \n>       fiatAmount, \n>       walletAddress, \n>       paymentMethodId\n>   );\n>```\n\n| Property            | type                      | required | description                                                                                                                                   |\n|---------------------|---------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `accountReference` | `string`                  | `true`   | The customer's unique ID                                                                                                                      |\n| `fiatCode`         | `string`                  | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats                                                             |\n| `coinCode`         | `string`                  | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto                                                        |\n| `fiatAmount`       | `string/number`           | `true`   | Fiat amount                                                                                                                                   |\n| `walletAddress`    | `string`                  | `true`   | The target wallet address to transfer the coin to                                                                                             |\n| `paymentMethodId`  | `string/number/undefined` | `false`  | Unique ID for the payment method that you want to get prices for. see [Payment Methods](#payment-methods) to get a list of payment providers. |\n| `blockchain`       | `string/undefined`        | `false`  | Blockchain code, the list of available blockchains per coin @see [Crypto](#crypto) for all available blockchains per coin                     |\n| `walletAddressTag` | `string/undefined`        | `false`  | Wallet tag or memo associated with the wallet address. Should be sent for buy cryptocurrency orders only for BNB (Memo) or XRP (Tag).         |\n\n---\n\n> **BuyOrderTransaction using Coin as base amount**\n>```js\n>  const buyOrderTransaction = BuyOrderTransaction.createFromCoinAmount(\n>       accountReference, \n>       fiatCode, \n>       coinCode, \n>       coinAmount, \n>       walletAddress, \n>       paymentMethodId\n>   );\n>```\n>\n\n| Property            | type                      | required | description                                                                                                                                   |\n|---------------------|---------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `accountReference` | `string`                  | `true`   | The customer's unique ID                                                                                                                      |\n| `fiatCode`         | `string`                  | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats                                                             |\n| `coinCode`         | `string`                  | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto                                                        |\n| `coinAmount`       | `string/number`           | `true`   | The coin amount                                                                                                                               |\n| `walletAddress`    | `string`                  | `true`   | The target wallet address to transfer the coin to                                                                                             |\n| `paymentMethodId`  | `string/number/undefined` | `false`  | Unique ID for the payment method that you want to get prices for. see [Payment Methods](#payment-methods) to get a list of payment providers. |\n| `blockchain`       | `string/undefined`        | `false`  | Blockchain code, the list of available blockchains per coin @see [Crypto](#crypto) for all available blockchains per coin                     |\n| `walletAddressTag` | `string/undefined`        | `false`  | Wallet tag or memo associated with the wallet address. Should be sent for buy cryptocurrency orders only for BNB (Memo) or XRP (Tag).         |\n\n---\n> **BuyOrderTransaction using dynamic sourceAmount or targetAmount**\n>\n> When using BuyOrderTransaction.createDynamic you will need to specify `source`(Fiat), `target`(Coin), and\n> either `sourceAmount` or `targetAmount`\n>```js\n>   const buyOrderTransaction = BuyOrderTransaction.createDynamic(\n>       accountReference, \n>       source, \n>       target, \n>       sourceAmount, \n>       targetAmount, \n>       walletAddress, \n>       refundAddress, \n>       paymentMethodId, \n>       blockchain, \n>       walletAddressTag\n>   );\n>```\n\n| Property            | type                      | required | description                                                                                                                                   |\n|---------------------|---------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `accountReference` | `string`                  | `true`   | The customer's unique ID                                                                                                                      |\n| `source`           | `string`                  | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats                                                             |\n| `target`           | `string`                  | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto                                                        |\n| `sourceAmount`     | `string/number/undefined` | `true`   | Source amount - null if targetAmount is set                                                                                                   |\n| `targetAmount`     | `string/number/undefined` | `true`   | Target amount - null if sourceAmount is set                                                                                                   |\n| `walletAddress`    | `string/undefined`        | `true`   | The target wallet address to transfer the coin to - For Buy orders only                                                                       |\n| `refundAddress`    | `string/undefined`        | `true`   | The refund wallet address - For sell orders only                                                                                              |\n| `paymentMethodId`  | `string/number/undefined` | `false`  | Unique ID for the payment method that you want to get prices for. see [Payment Methods](#payment-methods) to get a list of payment providers. |\n| `blockchain`       | `string/undefined`        | `false`  | Blockchain code, the list of available blockchains per coin @see [Crypto](#crypto) for all available blockchains per coin                     |\n| `walletAddressTag` | `string/undefined`        | `false`  | Wallet tag or memo associated with the wallet address. Should be sent for buy cryptocurrency orders only for BNB (Memo) or XRP (Tag).         |\n\n> **Buy order full example**\n>\n>```js\n>const buyOrderTransaction = BuyOrderTransaction.createFromFiatAmount(accountReference, fiatCode, coinCode, fiatAmount, walletAddress, paymentMethodId, blockchain, walletAddressTag);// From Fiat Amount\n>```\n>```js\n>const buyOrderTransaction = BuyOrderTransaction.createFromCoinAmount(accountReference, fiatCode, coinCode, coinAmount, walletAddress, paymentMethodId, blockchain, walletAddressTag);// From Coin Amount\n>```\n>```js\n>const buyOrderTransaction = BuyOrderTransaction.createDynamic(accountReference, source, target, sourceAmount, null, walletAddress, null, paymentMethodId, blockchain, walletAddressTag); // Dynamic\n>```\n>```js\n>const buyOrderTransaction = BuyOrderTransaction.createDynamic(accountReference, source, target, null, targetAmount, walletAddress, null, paymentMethodId, blockchain, walletAddressTag); // Dynamic\n>```\n>```js\n>banxa.createBuyOrder(\n>     buyOrderTransaction,\n>     returnUrlOnSuccess,\n>     returnUrlOnFailure,\n>     returnUrlOnCancelled,\n>     metadata,\n>     readOnlyAmounts,\n>     iframeRefererDomain,\n>     );\n>```\n>\n>\n>**Result Example**\n>\n>```json\n>{\n>    \"id\"                : \"b890df4aee4583a25ca8da17eb863c81\",\n>    \"account_id\"        : \"3ec8d3c67617af11d84a18931c4e369d\",\n>    \"account_reference\" : \"banxa-test-01\",\n>    \"order_type\"        : \"CRYPTO-BUY\",\n>    \"fiat_code\"         : \"AUD\",\n>    \"fiat_amount\"       : 1,\n>    \"coin_code\"         : \"BTC\",\n>    \"wallet_address\"    : \"1LbQ1WNTsm1Nzj1hbh3WDCbEim1oUg5rfi\",\n>    \"blockchain\"        : {\n>        \"id\"          : 1,\n>        \"code\"        : \"BTC\",\n>        \"description\" : \"Bitcoin\"\n>    },\n>    \"created_at\"        : \"17-Aug-2022 00:09:03\",\n>    \"checkout_url\"      : \"https://your-return-url\"\n>}\n>```\n---\n\n### Creating a NFT buy order\n\n> ```js\n> banxa.createNftBuyOrder(\n>   nftBuyOrderTransaction,\n>   nftData,\n>   returnUrlOnSuccess,\n>   returnUrlOnFailure,\n>   returnUrlOnCancelled,\n>   iframeRefererDomain\n> );\n>```\n\n| Property                  | type          | required | description                                                                                                                                                                 |\n|---------------------------|---------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `nftBuyOrderTransaction` | `Object`      | `true`   | `NftBuyOrderTransaction` object                                                                                                                                             |\n| `nftData`                | `Object`      | `true`   | `NftData` object                                                                                                                                                            |\n| `returnUrlOnSuccess`     | `string`      | `true`   | The return url on success                                                                                                                                                   | \n| `returnUrlOnFailure`     | `string/undefined` | `false`  | The return url on failure                                                                                                                                                   | \n| `returnUrlOnCancelled`   | `string/undefined` | `false`  | The return url on cancelled                                                                                                                                                 | \n| `iframeRefererDomain`    | `string/undefined` | `false`  | 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. |\n\n---\n\n> **NftBuyOrderTransaction**\n>```js\n> const nftBuyOrderTransaction = NftBuyOrderTransaction.create(\n>        accountReference,\n>        fiatCode,\n>        coinCode,\n>        fiatAmount,\n>        walletAddress,\n>        paymentMethodId,\n>        blockchain,\n>        walletAddressTag\n>   );\n>```\n\n| Property            | type                         | required | description                                                                                                                                   |\n|---------------------|------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `accountReference` | `string`                     | `true`   | The customer's unique ID                                                                                                                      |\n| `fiatCode`         | `string`                     | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats                                                             |\n| `coinCode`         | `string`                     | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto                                                        |\n| `fiatAmount`       | `string/number`              | `true`   | Fiat amount                                                                                                                                   |\n| `walletAddress`    | `string`                     | `true`   | The target wallet address to transfer the coin to                                                                                             |\n| `paymentMethodId`  | `string/number/undefined` | `false`  | Unique ID for the payment method that you want to get prices for. see [Payment Methods](#payment-methods) to get a list of payment providers. |\n| `blockchain`       | `string/undefined`           | `false`  | Blockchain code, the list of available blockchains per coin @see [Crypto](#crypto) for all available blockchains per coin                     |\n| `walletAddressTag` | `string/undefined`           | `false`  | Wallet tag or memo associated with the wallet address. Should be sent for buy cryptocurrency orders only for BNB (Memo) or XRP (Tag).         |\n\n---\n\n> **NftData**\n>```js\n>  const nftData = NftData.create(\n>       purchaseReference, \n>       nft, \n>       metaData\n>   );\n>```\n\n| Property             | type     | required | description                 |\n|----------------------|----------|----------|-----------------------------|\n| `purchaseReference` | `string` | `true`   | A reference of the purchase |\n| `nft`               | `Object` | `true`   | `Nft` object                |\n| `metaData`          | `array`  | `false`  | Array of metaData           |\n\n---\n> **Nft**\n>\n>```js\n>   const nft = Nft.create(\n>       name, \n>       collection, \n>       nftMedia,\n>   );\n>```\n\n| Property      | type           | required | description              |\n|---------------|----------------|----------|--------------------------|\n| `name`       | `string`       | `true`   | The name of the NFT      |\n| `collection` | `string`       | `true`   | The Collection the NFT   |\n| `nftMedia`   | `object`       | `true`   | `NftMedia` object        |\n\n---\n> **Create VideoNftMedia**\n>\n>```js\n>   const nftMedia = VideoNftMedia.create(link);\n>```\n> **Create ImageNftMedia**\n>\n>```js\n>   const nftMedia = ImageNftMedia.create(link);\n>```\n\n| Property      | type           | required | description             |\n|---------------|----------------|----------|-------------------------|\n| `link`        | `string`       | `true`   | A link to the Nft video |\n\n---\n\n> **Nft buy order full example**\n>\n>```js\n>\n>const nftBuyOrderTransaction = NftBuyOrderTransaction.create(\n>      accountReference, \n>      fiatCode, \n>      coinCode, \n>      fiatAmount, \n>      walletAddress, \n>      paymentMethodId, \n>      blockchain, \n>      walletAddressTag\n>   );\n>\n>\n>   const nftMedia = ImageNftMedia.create(link); // OR nftMedia = VideoNftMedia.create(link)\n>\n>\n>   const nft = Nft.create(\n>       name, \n>       collection, \n>       nftMedia,\n>   );\n>\n>  const nftData = NftData.create(\n>       purchaseReference, \n>       nft, \n>       metaData\n>   );\n>\n>   banxa.createNftBuyOrder(\n>       nftBuyOrderTransaction,\n>       nftData,\n>       returnUrlOnSuccess,\n>       returnUrlOnFailure,\n>       returnUrlOnCancelled,\n>       iframeRefererDomain,\n>     );\n>```\n>\n>\n>**Result Example**\n>\n>```json\n>{\n>    \"id\"                : \"b890df4aee4583a25ca8da17eb863c81\",\n>    \"account_id\"        : \"3ec8d3c67617af11d84a18931c4e369d\",\n>    \"account_reference\" : \"Banxa-Testing-01\",\n>    \"order_type\"        : \"NFT-BUY\",\n>    \"blockchain\"        : {\n>        \"id\"          : 1,\n>        \"code\"        : \"ETH\",\n>        \"description\" : \"Ethereum (ERC-20)\"\n>    },\n>    \"created_at\"        : \"17-Aug-2022 00:09:03\",\n>    \"checkout_url\"      : \"https://your-return-url\"\n>}\n>```\n---\n\n### Creating a Sell order\n\n> ```js\n> banxa.createSellOrder(\n>   sellOrderTransaction,\n>   returnUrlOnSuccess,\n>   returnUrlOnFailure,\n>   returnUrlOnCancelled,\n>   metadata,\n>   readOnlyAmounts,\n>   iframeRefererDomain,\n> )\n>```\n\n| Property                  | type          | required | description                                                                                                                                                                 |\n|---------------------------|---------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `sellOrderTransaction`   | `Object`      | `true`   | `SellOrdertransaction` object                                                                                                                                               |\n| `returnUrlOnSuccess`     | `string`      | `true`   | The return url on success                                                                                                                                                   | \n| `returnUrlOnFailure`     | `string/undefined` | `false`  | The return url on failure                                                                                                                                                   | \n| `returnUrlOnCancelled`   | `string/undefined` | `false`  | The return url on cancelled                                                                                                                                                 | \n| `metadata`               | `string/undefined` | `false`  | Free form string that you can use to send us any information that will be returned in the Get Orders endpoint                                                               | \n| `readOnlyAmounts`        | `boolean`     | `false`  | Will cause the cryptocurrency and fiat amounts on the Banxa screens to be read-only and un-editable.                                                                        |\n| `iframeRefererDomain`    | `string/undefined` | `false`  | 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. |\n\n---\n\n> **SellOrderTransaction using Fiat as base amount**\n>```js\n> const sellOrderTransaction = SellOrderTransaction.createFromFiatAmount(\n>       accountReference, \n>       fiatCode, \n>       coinCode, \n>       fiatAmount, \n>       refundAddress, \n>       paymentMethodId,\n>       blockchain,\n>       walletAddressTag,\n>);\n>```\n\n| Property            | type                      | required | description                                                                                                                                   |\n|---------------------|---------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `accountReference` | `string`                  | `true`   | The customer's unique ID                                                                                                                      |\n| `fiatCode`         | `string`                  | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats                                                             |\n| `coinCode`         | `string`                  | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto                                                        |\n| `fiatAmount`       | `string/number`           | `true`   | Fiat amount                                                                                                                                   |\n| `refundAddress`    | `string`                  | `true`   | The refund wallet address if the order gets rejected                                                                                          |\n| `paymentMethodId`  | `string/number/undefined` | `false`  | Unique ID for the payment method that you want to get prices for. see [Payment Methods](#payment-methods) to get a list of payment providers. |\n| `blockchain`       | `string/undefined`        | `false`  | Blockchain code, the list of available blockchains per coin @see [Crypto](#crypto) for all available blockchains per coin                     |\n| `walletAddressTag` | `string/undefined`        | `false`  | Wallet tag or memo associated with the wallet address. Should be sent for buy cryptocurrency orders only for BNB (Memo) or XRP (Tag).         |\n\n---\n\n\n> **sellOrderTransaction using Coin as base amount**\n>```js\n> const sellOrderTransaction = SellOrderTransaction.createFromCoinAmount(\n>       accountReference, \n>       fiatCode, \n>       coinCode, \n>       coinAmount, \n>       refundAddress, \n>       paymentMethodId,\n>       blockchain,\n>       walletAddressTag,\n>   );\n>```\n\n| Property            | type                      | required | description                                                                                                                                   |\n|---------------------|---------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `accountReference` | `string`                  | `true`   | The customer's unique ID                                                                                                                      |\n| `fiatCode`         | `string`                  | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats                                                             |\n| `coinCode`         | `string`                  | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto                                                        |\n| `coinAmount`       | `string/number`           | `true`   | The coin amount                                                                                                                               |\n| `refundAddress`    | `string`                  | `true`   | The refund wallet address if the order gets rejected                                                                                          |\n| `paymentMethodId`  | `string/number/undefined` | `false`  | Unique ID for the payment method that you want to get prices for. see [Payment Methods](#payment-methods) to get a list of payment providers. |\n| `blockchain`       | `string/undefined`        | `false`  | Blockchain code, the list of available blockchains per coin @see [Crypto](#crypto) for all available blockchains per coin                     |\n| `walletAddressTag` | `string/undefined`        | `false`  | Wallet tag or memo associated with the wallet address. Should be sent for buy cryptocurrency orders only for BNB (Memo) or XRP (Tag).         |\n\n---\n\n\n> **sellOrderTransaction using dynamic sourceAmount or targetAmount**\n>\n> When using SellOrderTransaction.createDynamic you will need to specify `source`(Fiat), `target`(Coin), and\n> either `sourceAmount` or `targetAmount`\n>```js\n> const sellOrderTransaction = SellOrderTransaction.createDynamic(\n>       accountReference, \n>       source, \n>       target, \n>       sourceAmount, \n>       targetAmount, \n>       walletAddress, \n>       refundAddress, \n>       paymentMethodId, \n>       blockchain, \n>       walletAddressTag\n>   );\n>```\n\n| Property            | type                      | required | description                                                                                                                                   |\n|---------------------|---------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `accountReference` | `string`                  | `true`   | The customer's unique ID                                                                                                                      |\n| `source`           | `string`                  | `true`   | Fiat code e.g. 'USD' or 'EUR' see [Fiat](#fiat) to get a list all available fiats                                                             |\n| `target`           | `string`                  | `true`   | Coin code e.g. 'BTC' or 'ETH' see [Crypto](#crypto) to get a list all available crypto                                                        |\n| `sourceAmount`     | `string/number/undefined` | `true`   | Source amount - null if targetAmount is set                                                                                                   |\n| `targetAmount`     | `string/number/undefined` | `true`   | Target amount - null if sourceAmount is set                                                                                                   |\n| `walletAddress`    | `string/undefined`        | `true`   | The target wallet address to transfer the coin to - For Buy orders only                                                                       |\n| `refundAddress`    | `string/undefined`        | `true`   | The refund wallet address - For sell orders only                                                                                              |\n| `paymentMethodId`  | `string/number/undefined` | `false`  | Unique ID for the payment method that you want to get prices for. see [Payment Methods](#payment-methods) to get a list of payment providers. |\n| `blockchain`       | `string/undefined`        | `false`  | Blockchain code, the list of available blockchains per coin @see [Crypto](#crypto) for all available blockchains per coin                     |\n| `walletAddressTag` | `string/undefined`        | `false`  | Wallet tag or memo associated with the wallet address. Should be sent for buy cryptocurrency orders only for BNB (Memo) or XRP (Tag).         |\n\n> **Sell order full example**\n>\n>```js\n>const sellOrderTransaction = SellOrderTransaction.createFromFiatAmount(accountReference, fiatCode, coinCode, fiatAmount, refundAddress, paymentMethodId, blockchain, walletAddressTag);// From Fiat Amount\n>```\n>```js\n>const sellOrderTransaction = SellOrderTransaction.createFromCoinAmount(accountReference, fiatCode, coinCode, coinAmount, refundAddress, paymentMethodId, blockchain, walletAddressTag);// From Coin Amount\n>```\n>```js\n>const sellOrderTransaction = SellOrderTransaction.createDynamic(accountReference, source, target, sourceAmount, null, null, refundAddress, paymentMethodId, blockchain, walletAddressTag); // Dynamic\n>```\n>```js\n>const sellOrderTransaction = SellOrderTransaction.createDynamic(accountReference, source, target, null, targetAmount, null, refundAddress, paymentMethodId, blockchain, walletAddressTag); // Dynamic\n>```\n>```js\n>banxa.createSellOrder(\n>    sellOrderTransaction,\n>    returnUrlOnSuccess,\n>    returnUrlOnFailure,\n>    returnUrlOnCancelled,\n>    metadata,\n>    readOnlyAmounts,\n>    iframeRefererDomain,\n>);\n>```\n>\n>**Result Example**\n>\n>```json\n>{\n>    \"id\"                : \"b890df4aee4583a25ca8da17eb863c81\",\n>    \"account_id\"        : \"3ec8d3c67617af11d84a18931c4e369d\",\n>    \"account_reference\" : \"banxa-test-01\",\n>    \"order_type\"        : \"CRYPTO-SELL\",\n>    \"fiat_code\"         : \"AUD\",\n>    \"fiat_amount\"       : 1,\n>    \"coin_code\"         : \"BTC\",\n>    \"wallet_address\"    : \"1LbQ1WNTsm1Nzj1hbh3WDCbEim1oUg5rfi\",\n>    \"blockchain\"        : {\n>        \"id\"          : 1,\n>        \"code\"        : \"BTC\",\n>        \"description\" : \"Bitcoin\"\n>    },\n>    \"created_at\"        : \"17-Aug-2022 00:09:03\",\n>    \"checkout_url\"      : \"https://your-return-url\"\n>\n>}\n>```\n---\n\n### Confirm sell order\n\n> **Once the coin amount transfer for a Sell Order has been executed,    \nBanxa must be notified by sending a request to this endpoint with transaction hash, source and destination wallet\naddress details.**\n>```js\n> banxa.confirmSellOrder(\n>       orderId,\n>       txHash,\n>       sourceAddress,\n>       destinationAddress,\n>       sourceAddressTag,\n>       destinationAddressTag\n> )\n>```\n\n| Property                 | type          | required | description                                                                                         |\n|--------------------------|---------------|:---------|:----------------------------------------------------------------------------------------------------|\n| `orderId`               | `string`      | `true`   | Unique ID for the the order                                                                         |\n| `txHash`                | `string`      | `true`   | Blockchain transaction hash of the order                                                            |\n| `sourceAddress`         | `string`      | `true`   | The provided customer's source wallet address                                                       |\n| `destinationAddress`    | `string`      | `true`   | The wallet address provided to merchants to transact to                                             |\n| `sourceAddressTag`      | `string/undefined` | `false`  | The customer's source wallet address tag if the provided source wallet address requires it          |\n| `destinationAddressTag` | `string/undefined` | `false`  | The wallet address tag provided to merchants if the provided destination wallet address requires it |\n\n**Result Example**\n\n```json\n{\n    \"id\"                  : \"ee94a43403fb608f341dd5c4c899b846\",\n    \"account_id\"          : \"d6e7ab2b8f638bed61dc0ac5bec37d4d\",\n    \"account_reference\"   : \"banxa-account\",\n    \"order_type\"          : \"CRYPTO-SELL\",\n    \"payment_type\"        : \"CLEARJCNSELLFP\",\n    \"ref\"                 : 507000,\n    \"fiat_code\"           : \"AUD\",\n    \"fiat_amount\"         : 100,\n    \"coin_code\"           : \"BTC\",\n    \"coin_amount\"         : 0.00286436,\n    \"wallet_address\"      : null,\n    \"wallet_address_tag\"  : null,\n    \"fee\"                 : 9.1,\n    \"fee_tax\"             : 0,\n    \"payment_fee\"         : 0,\n    \"payment_fee_tax\"     : 0,\n    \"commission\"          : 0.1,\n    \"tx_hash\"             : null,\n    \"tx_confirms\"         : 0,\n    \"created_date\"        : \"01-Jul-2022\",\n    \"created_at\"          : \"01-Jul-2022 07:51:18\",\n    \"status\"              : \"in progress\",\n    \"completed_at\"        : null,\n    \"merchant_fee\"        : 6.54,\n    \"merchant_commission\" : 0.05,\n    \"meta_data\"           : null,\n    \"blockchain\"          : {\n        \"id\"          : 1,\n        \"code\"        : \"BTC\",\n        \"description\" : \"Bitcoin\"\n    }\n}\n```\n\n---\n\n# Identity\n\n## Create Identity\n\n> **Allows you to share customer details with Banxa before an Order is created.   \n> This reduces the need for customers to re-submit personal details and upload KYC documentation during the Banxa\ncheckout\n> flow.    \n> Detailed guide on how to implement this API can be found [here](https://docs.banxa.com/docs/identities-service).\n> You can also find Testing information [here](https://docs.banxa.com/docs/order-flow)**\n>```js\n> banxa.createIdentity(\n>   identitySharingCollection,\n>   customerDetails,\n>   customerIdentity,\n>   identityDocumentCollection,\n>   residentialAddress\n> )","readmeFilename":"README.md"}