{"info":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","description":"

OVEX Exchange APIs

Authorizing Requests with the API Key:

Obtain API key from your OVEX Dashboard(The key has an expiration limit of 365 days.)
\n
Set the Authorization header in your request:
headers['Authorization'] = \"Bearer {API_KEY}\"
\n

Global rate limit on all OVEX Exchange API endpoints

Maximum 100 request per 10 seconds
\n
Maximum 400 requests per 60 seconds
\n
Maximum 3000 requests per 10 minutes
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"27223512","collectionId":"182ec62b-7745-473a-8330-2de33d1de54e","publishedId":"2sBXitEU5i","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-04-13T19:10:57.000Z"},"item":[{"name":"API_V2","item":[{"name":"Markets","item":[{"name":"Markets","id":"acabdf2f-e511-43cc-8c9b-aa60044c88f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"www.ovex.io/api/v2/markets","description":"

Get a list of available markets. The market id is unique and is always in the form of xxxyyy, where xxx is the base currency code, yyy is the quote currency code, e.g. 'btcusdt'.

Note that this is an unauthenticated endpoint and available markets depend on your jurisdiction and not all markets listed are available in all jurisdictions. Please use an authorised request to see the markets available in your jurisdiction.

\n","urlObject":{"path":["api/v2","markets"],"host":["www.ovex.io"],"query":[{"disabled":true,"description":{"content":"

(Optional) Member sn you want markets of - for brokers only. Requires Auth.

\n","type":"text/plain"},"key":"sn","value":"SNXXXYYY000"}],"variable":[]}},"response":[{"id":"f22c654e-4c52-4d89-8caa-e508d60d6484","name":"market_list","originalRequest":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/markets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 18 Jan 2024 08:13:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, PATCH, DELETE"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Version","value":"HTTP/1.1"},{"key":"Host","value":"api.review.ovex.io"},{"key":"X-Real-Ip","value":"139.84.230.93"},{"key":"X-Forwarded-For","value":"139.84.230.93, 139.84.230.93"},{"key":"X-Forwarded-Host","value":"api.review.ovex.io"},{"key":"X-Forwarded-Port","value":"443"},{"key":"X-Forwarded-Proto","value":"https"},{"key":"Accept-Encoding","value":"gzip"},{"key":"Cf-Visitor","value":"{\"scheme\":\"https\"}"},{"key":"User-Agent","value":"PostmanRuntime/7.36.0"},{"key":"Accept","value":"*/*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Postman-Token","value":"{{vault:authorization-secret---uuid}}"},{"key":"Referer","value":"http://api.review.ovex.io/api/v2/markets"},{"key":"Cf-Connecting-Ip","value":"139.84.230.93"},{"key":"Cdn-Loop","value":"cloudflare"},{"key":"Cf-Ipcountry","value":"ZA"},{"key":"X-Request-Id","value":"a03482ab-015c-4bc8-9f23-b1fd97e7d828"},{"key":"X-Runtime","value":"0.021987"},{"key":"Strict-Transport-Security","value":"max-age=0; includeSubDomains"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8475617b18f53cad-CDG"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"aavezar\",\n \"name\": \"AAVE/ZAR\",\n \"base_currency\": \"aave\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 6,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"AAVE coin\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"adabtc\",\n \"name\": \"ADA/BTC\",\n \"base_currency\": \"ada\",\n \"quote_currency\": \"btc\",\n \"base_precision\": 6,\n \"quote_precision\": 8,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Cardano Coin \",\n \"quote_currency_long\": \"Bitcoin\"\n },\n {\n \"id\": \"adausdt\",\n \"name\": \"ADA/USDT\",\n \"base_currency\": \"ada\",\n \"quote_currency\": \"usdt\",\n \"base_precision\": 6,\n \"quote_precision\": 6,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Cardano Coin \",\n \"quote_currency_long\": \"USD Tether\"\n },\n {\n \"id\": \"apeusdt\",\n \"name\": \"APE/USDT\",\n \"base_currency\": \"ape\",\n \"quote_currency\": \"usdt\",\n \"base_precision\": 6,\n \"quote_precision\": 6,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"APE coin\",\n \"quote_currency_long\": \"USD Tether\"\n },\n {\n \"id\": \"apezar\",\n \"name\": \"APE/ZAR\",\n \"base_currency\": \"ape\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 6,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"APE coin\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"avaxzar\",\n \"name\": \"AVAX/ZAR\",\n \"base_currency\": \"avax\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 6,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Avax coin\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"bnbbtc\",\n \"name\": \"BNB/BTC\",\n \"base_currency\": \"bnb\",\n \"quote_currency\": \"btc\",\n \"base_precision\": 6,\n \"quote_precision\": 8,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Binance Coin\",\n \"quote_currency_long\": \"Bitcoin\"\n },\n {\n \"id\": \"bnbusdt\",\n \"name\": \"BNB/USDT\",\n \"base_currency\": \"bnb\",\n \"quote_currency\": \"usdt\",\n \"base_precision\": 6,\n \"quote_precision\": 6,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Binance Coin\",\n \"quote_currency_long\": \"USD Tether\"\n },\n {\n \"id\": \"bnbzar\",\n \"name\": \"BNB/ZAR\",\n \"base_currency\": \"bnb\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 6,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Binance Coin\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"btcngn\",\n \"name\": \"BTC/NGN\",\n \"base_currency\": \"btc\",\n \"quote_currency\": \"ngn\",\n \"base_precision\": 8,\n \"quote_precision\": 2,\n \"rfq_enabled\": false,\n \"indicative_pricing\": true,\n \"base_currency_long\": \"Bitcoin\",\n \"quote_currency_long\": \"Nigerian Naira\"\n },\n {\n \"id\": \"btcusd\",\n \"name\": \"BTC/USD\",\n \"base_currency\": \"btc\",\n \"quote_currency\": \"usd\",\n \"base_precision\": 8,\n \"quote_precision\": 8,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Bitcoin\",\n \"quote_currency_long\": \"United States Dollar\"\n },\n {\n \"id\": \"btcusdt\",\n \"name\": \"BTC/USDT\",\n \"base_currency\": \"btc\",\n \"quote_currency\": \"usdt\",\n \"base_precision\": 8,\n \"quote_precision\": 6,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Bitcoin\",\n \"quote_currency_long\": \"USD Tether\"\n },\n {\n \"id\": \"btczar\",\n \"name\": \"BTC/ZAR\",\n \"base_currency\": \"btc\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 8,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Bitcoin\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"compzar\",\n \"name\": \"COMP/ZAR\",\n \"base_currency\": \"comp\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 8,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Compound\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"dogebtc\",\n \"name\": \"DOGE/BTC\",\n \"base_currency\": \"doge\",\n \"quote_currency\": \"btc\",\n \"base_precision\": 8,\n \"quote_precision\": 8,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Doge Coin\",\n \"quote_currency_long\": \"Bitcoin\"\n },\n {\n \"id\": \"dogeusdt\",\n \"name\": \"DOGE/USDT\",\n \"base_currency\": \"doge\",\n \"quote_currency\": \"usdt\",\n \"base_precision\": 8,\n \"quote_precision\": 6,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Doge Coin\",\n \"quote_currency_long\": \"USD Tether\"\n },\n {\n \"id\": \"dogezar\",\n \"name\": \"DOGE/ZAR\",\n \"base_currency\": \"doge\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 8,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Doge Coin\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"ethbtc\",\n \"name\": \"ETH/BTC\",\n \"base_currency\": \"eth\",\n \"quote_currency\": \"btc\",\n \"base_precision\": 8,\n \"quote_precision\": 8,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Ethereum\",\n \"quote_currency_long\": \"Bitcoin\"\n },\n {\n \"id\": \"ethghs\",\n \"name\": \"ETH/GHS\",\n \"base_currency\": \"eth\",\n \"quote_currency\": \"ghs\",\n \"base_precision\": 8,\n \"quote_precision\": 8,\n \"rfq_enabled\": false,\n \"indicative_pricing\": true,\n \"base_currency_long\": \"Ethereum\",\n \"quote_currency_long\": \"Ghanian Cedi\"\n },\n {\n \"id\": \"ethzar\",\n \"name\": \"ETH/ZAR\",\n \"base_currency\": \"eth\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 8,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Ethereum\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"kp3rzar\",\n \"name\": \"KP3R/ZAR\",\n \"base_currency\": \"kp3r\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 8,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Keep3RV1\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"linkbtc\",\n \"name\": \"LINK/BTC\",\n \"base_currency\": \"link\",\n \"quote_currency\": \"btc\",\n \"base_precision\": 8,\n \"quote_precision\": 8,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Chainlink\",\n \"quote_currency_long\": \"Bitcoin\"\n },\n {\n \"id\": \"linkusdt\",\n \"name\": \"LINK/USDT\",\n \"base_currency\": \"link\",\n \"quote_currency\": \"usdt\",\n \"base_precision\": 8,\n \"quote_precision\": 6,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Chainlink\",\n \"quote_currency_long\": \"USD Tether\"\n },\n {\n \"id\": \"linkzar\",\n \"name\": \"LINK/ZAR\",\n \"base_currency\": \"link\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 8,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Chainlink\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"ltcbtc\",\n \"name\": \"LTC/BTC\",\n \"base_currency\": \"ltc\",\n \"quote_currency\": \"btc\",\n \"base_precision\": 8,\n \"quote_precision\": 8,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Litecoin\",\n \"quote_currency_long\": \"Bitcoin\"\n },\n {\n \"id\": \"ltcusdt\",\n \"name\": \"LTC/USDT\",\n \"base_currency\": \"ltc\",\n \"quote_currency\": \"usdt\",\n \"base_precision\": 8,\n \"quote_precision\": 6,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Litecoin\",\n \"quote_currency_long\": \"USD Tether\"\n },\n {\n \"id\": \"ltczar\",\n \"name\": \"LTC/ZAR\",\n \"base_currency\": \"ltc\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 8,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Litecoin\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"shibusdt\",\n \"name\": \"SHIB/USDT\",\n \"base_currency\": \"shib\",\n \"quote_currency\": \"usdt\",\n \"base_precision\": 8,\n \"quote_precision\": 6,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"SHIBA Coin\",\n \"quote_currency_long\": \"USD Tether\"\n },\n {\n \"id\": \"shibzar\",\n \"name\": \"SHIB/ZAR\",\n \"base_currency\": \"shib\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 8,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"SHIBA Coin\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"solbtc\",\n \"name\": \"SOL/BTC\",\n \"base_currency\": \"sol\",\n \"quote_currency\": \"btc\",\n \"base_precision\": 8,\n \"quote_precision\": 8,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Solana\",\n \"quote_currency_long\": \"Bitcoin\"\n },\n {\n \"id\": \"soltusd\",\n \"name\": \"SOL/TUSD\",\n \"base_currency\": \"sol\",\n \"quote_currency\": \"tusd\",\n \"base_precision\": 8,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Solana\",\n \"quote_currency_long\": \"TrueUSD\"\n },\n {\n \"id\": \"solusdt\",\n \"name\": \"SOL/USDT\",\n \"base_currency\": \"sol\",\n \"quote_currency\": \"usdt\",\n \"base_precision\": 8,\n \"quote_precision\": 6,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Solana\",\n \"quote_currency_long\": \"USD Tether\"\n },\n {\n \"id\": \"solzar\",\n \"name\": \"SOL/ZAR\",\n \"base_currency\": \"sol\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 8,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Solana\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"sushibtc\",\n \"name\": \"SUSHI/BTC\",\n \"base_currency\": \"sushi\",\n \"quote_currency\": \"btc\",\n \"base_precision\": 8,\n \"quote_precision\": 8,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Sushi Swap\",\n \"quote_currency_long\": \"Bitcoin\"\n },\n {\n \"id\": \"usdczar\",\n \"name\": \"USDC/ZAR\",\n \"base_currency\": \"usdc\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 8,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"USD Coin\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"usdtghs\",\n \"name\": \"USDT/GHS\",\n \"base_currency\": \"usdt\",\n \"quote_currency\": \"ghs\",\n \"base_precision\": 6,\n \"quote_precision\": 8,\n \"rfq_enabled\": false,\n \"indicative_pricing\": true,\n \"base_currency_long\": \"USD Tether\",\n \"quote_currency_long\": \"Ghanian Cedi\"\n },\n {\n \"id\": \"usdtusd\",\n \"name\": \"USDT/USD\",\n \"base_currency\": \"usdt\",\n \"quote_currency\": \"usd\",\n \"base_precision\": 6,\n \"quote_precision\": 8,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"USD Tether\",\n \"quote_currency_long\": \"United States Dollar\"\n },\n {\n \"id\": \"usdtzar\",\n \"name\": \"USDT/ZAR\",\n \"base_currency\": \"usdt\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 6,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"USD Tether\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"usdtzarp\",\n \"name\": \"USDT/ZARP\",\n \"base_currency\": \"usdt\",\n \"quote_currency\": \"zarp\",\n \"base_precision\": 6,\n \"quote_precision\": 6,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"USD Tether\",\n \"quote_currency_long\": \"ZARP\"\n },\n {\n \"id\": \"xrpbtc\",\n \"name\": \"XRP/BTC\",\n \"base_currency\": \"xrp\",\n \"quote_currency\": \"btc\",\n \"base_precision\": 0,\n \"quote_precision\": 8,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Ripple\",\n \"quote_currency_long\": \"Bitcoin\"\n },\n {\n \"id\": \"xrppax\",\n \"name\": \"XRP/PAX\",\n \"base_currency\": \"xrp\",\n \"quote_currency\": \"pax\",\n \"base_precision\": 0,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Ripple\",\n \"quote_currency_long\": \"Paxos Standard\"\n },\n {\n \"id\": \"xrpusdt\",\n \"name\": \"XRP/USDT\",\n \"base_currency\": \"xrp\",\n \"quote_currency\": \"usdt\",\n \"base_precision\": 0,\n \"quote_precision\": 6,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Ripple\",\n \"quote_currency_long\": \"USD Tether\"\n },\n {\n \"id\": \"xrpzar\",\n \"name\": \"XRP/ZAR\",\n \"base_currency\": \"xrp\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 0,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"Ripple\",\n \"quote_currency_long\": \"South African Rands\"\n },\n {\n \"id\": \"zarpzar\",\n \"name\": \"ZARP/ZAR\",\n \"base_currency\": \"zarp\",\n \"quote_currency\": \"zar\",\n \"base_precision\": 6,\n \"quote_precision\": 2,\n \"rfq_enabled\": true,\n \"indicative_pricing\": false,\n \"base_currency_long\": \"ZARP\",\n \"quote_currency_long\": \"South African Rands\"\n }\n]"}],"_postman_id":"acabdf2f-e511-43cc-8c9b-aa60044c88f0"}],"id":"64a74adc-9d38-4c69-bc06-c4055364902f","_postman_id":"64a74adc-9d38-4c69-bc06-c4055364902f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"RfQ","item":[{"name":"Get Quote","id":"55b792c2-7bd2-44f9-bb9c-7b1b8dbf9784","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"www.ovex.io/api/v2/rfq/get_quote?market=btczar&from_amount=500000&side=buy&prefunded=0","description":"

Request for quote (RfQ). Get a strict all inclusive quote for trading between 2 currencies.

Specify a market e.g. (btczar, ethbtc, usdtzar, ethusdt)

Specify a 'side' of the market. e.g.('buy' btc with zar or 'sell' btc for ZAR)

Specify either a from_amount OR to_amount e.g.(side = buy, from_amount = x ZAR, to_amount = y BTC). NB: If both from_amount and to_amount are specified, from_amount is used for quoting.

\n","urlObject":{"path":["api/v2","rfq","get_quote"],"host":["www.ovex.io"],"query":[{"description":{"content":"

Market for quote. Available markets depend on your jurisdiction, and can be found on the OVEX site.

\n","type":"text/plain"},"key":"market","value":"btczar"},{"description":{"content":"

Amount specified in input volume. E.g. (market = btczar, side = buy : from_amount is in zar. If side = sell, from_amount is in btc)

\n","type":"text/plain"},"key":"from_amount","value":"500000"},{"description":{"content":"

Either 'buy or 'sell'. (Optional) Default: 'buy'

\n","type":"text/plain"},"key":"side","value":"buy"},{"disabled":true,"description":{"content":"

Amount specified in output volume. E.g. (market = btczar, side = buy : to_amount is in btc. If side = sell, to_amount is in zar)

\n","type":"text/plain"},"key":"to_amount","value":"1"},{"description":{"content":"

(Optional) Integer: 1 if immediate settlement, 0 if utilising Post Trade Settlement. Default: 0

\n","type":"text/plain"},"key":"prefunded","value":"0"},{"disabled":true,"description":{"content":"

(Optional) Integer: 1 to get an indicative price, 0 to get a trading price. Defaults to trading price [0] if available on the requested market.

\n","type":"text/plain"},"key":"indicative","value":"0"}],"variable":[]}},"response":[{"id":"04323987-2b8b-4b79-87d4-2063871ff9ea","name":"Success","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"quote_token\": \"eyJhbGciOiJIUzI1NiJ9...\",\n \"from_currency\": \"zar\",\n \"to_currency\": \"btc\",\n \"from_amount\": \"100000.0\",\n \"to_amount\": \"0.05\",\n \"rate\": \"2000000.0\",\n \"rate_is_from_currency\": true,\n \"fee\": \"0.1\",\n \"fee_currency\": \"zar\",\n \"expires_at\": \"2026-03-15T10:30:15Z\"\n}"}],"_postman_id":"55b792c2-7bd2-44f9-bb9c-7b1b8dbf9784"},{"name":"Accept Quote","id":"527f752e-c41e-48e9-9b4f-26a9df590d90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"quote_token\": \"token_from_get_quote_endpoint\"\n}","options":{"raw":{"language":"json"}}},"url":"www.ovex.io/api/v2/rfq/accept_quote","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}},"urlObject":{"path":["api/v2","rfq","accept_quote"],"host":["www.ovex.io"],"query":[],"variable":[]}},"response":[{"id":"46359dd8-26ca-43cb-87b1-aac2233b428b","name":"Success","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1234,\n \"from_currency\": \"zar\",\n \"to_currency\": \"btc\",\n \"from_amount\": \"100000.0\",\n \"to_amount\": \"0.05\",\n \"rate\": \"2000000.0\",\n \"fee\": \"0.1\",\n \"state\": \"confirmed\",\n \"created_at\": \"2026-03-15T10:30:00Z\",\n \"confirmed_at\": \"2026-03-15T10:30:05Z\"\n}"},{"id":"64788332-8e61-43ad-97c3-da23dfa8e8bb","name":"Quote Expired","originalRequest":{"header":[],"url":""},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Quote has expired\"\n}"}],"_postman_id":"527f752e-c41e-48e9-9b4f-26a9df590d90"}],"id":"92652ae9-d0ed-4a20-b3a0-eaab0ce65832","_postman_id":"92652ae9-d0ed-4a20-b3a0-eaab0ce65832","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"Deposits","item":[{"name":"History","id":"5867a0f8-dbe3-4634-8c6b-3f4c1cbc3d76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/deposits/history?limit=20&state=accepted¤cy=btc","description":"

Get your deposit history as a paginated collection.

Type: Integer\nDefault: 1\n(Optional)\nShows information on the given page number.

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Type: Integer\nValues: 1 - 1000\nDefault: 50\n(Optional)\nThe amount of items to display on a page.

\n","type":"text/plain"},"key":"limit","value":"20"},{"disabled":true,"description":{"content":"

Type: ISO Formatted DateTime\n(Optional)\nStart datetime\nDefaults to 30 days ago if not passed

\n","type":"text/plain"},"key":"from","value":"2022-12-31T08:00:00+00:00"},{"disabled":true,"description":{"content":"

Type: ISO Formatted DateTime\n(Optional)\nEnd datetime\nDefaults to the current datetime if not passed

\n","type":"text/plain"},"key":"to","value":"2023-01-31T08:00:00+00:00"},{"disabled":true,"description":{"content":"

If set, returned results will be sorted in specific order, default to 'desc'\nValues: [asc desc]

\n","type":"text/plain"},"key":"order_by","value":"asc"},{"disabled":true,"description":{"content":"

The unique client SNR reference. (Optional - Ramps Member Only)

\n","type":"text/plain"},"key":"snr","value":""},{"disabled":true,"description":{"content":"

Type: String (Optional)\nType of currency the withdraw belongs to.\nvalues [coin fiat]

\n","type":"text/plain"},"key":"currency_type","value":""},{"description":{"content":"

State of the deposit. (Optional)

\n","type":"text/plain"},"key":"state","value":"accepted"},{"description":{"content":"

Type: String\nCurrency value contains zar, btc, eth, tusd, ZAR, BTC, ETH, TUSD. (Optional)

\n","type":"text/plain"},"key":"currency","value":"btc"},{"disabled":true,"description":{"content":"

Type: String (Optional)\nIf set, returned data will be in specific format (json default).\nValues: [pdf csv]

\n","type":"text/plain"},"key":"alt_format","value":"csv"}],"variable":[]}},"response":[{"id":"32b264e5-e1ba-40fa-92ff-d996b059f52b","name":"History","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/deposits/history?limit=50¤cy=zar","host":["www","ovex","io"],"path":["api","v2","deposits","history"],"query":[{"key":"page","value":"1","description":"Type: Integer\nDefault: 1\n(Optional)\nShows information on the given page number.","disabled":true},{"key":"limit","value":"50","description":"Type: Integer\nValues: 1 - 1000\nDefault: 50\n(Optional)\nThe amount of items to display on a page."},{"key":"from","value":"2022-12-31T08:00:00+00:00","description":"Type: ISO Formatted DateTime\n(Optional)\nStart datetime\nDefaults to 30 days ago if not passed","disabled":true},{"key":"to","value":"2023-01-31T08:00:00+00:00","description":"Type: ISO Formatted DateTime\n(Optional)\nEnd datetime\nDefaults to the current datetime if not passed","disabled":true},{"key":"order_by","value":"asc","description":"If set, returned result will be sorted in specific order, default to 'desc'\nValues: [asc desc]","disabled":true},{"key":"snr","value":"","description":"The unique client SNR reference. (Optional - Ramps Member Only)","disabled":true},{"key":"state","value":"accepted","description":"State of the deposit. (Optional)","disabled":true},{"key":"currency","value":"zar","description":"Type: String\nCurrency value contains zar, btc, eth, tusd, ZAR, BTC, ETH, TUSD. (Optional)"},{"key":"alt_format","value":"csv","description":"Type: String (Optional)\nIf set, returned data will be in specific format (json default).\nValues: [pdf csv]","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"deposits\": [\n {\n \"id\": \"N/A\",\n \"sn\": \"SNE677EF1E78\",\n \"snr\": null,\n \"ramps_settled\": false,\n \"currency\": \"zar\",\n \"amount\": \"55.0\",\n \"fee\": \"0.0\",\n \"txid\": \"Manual Adjustment\",\n \"created_at\": \"2023-10-08T19:44:51+02:00\",\n \"completed_at\": \"2023-10-08T19:44:51+02:00\",\n \"state\": \"collected\",\n \"humanized_state\": \"Completed\",\n \"note\": \"Account Adjustment\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null,\n \"pending_carf_declaration\": false\n },\n {\n \"id\": \"TIDE7DFBB0787\",\n \"sn\": \"SNE677EF1E78\",\n \"snr\": null,\n \"ramps_settled\": false,\n \"currency\": \"zar\",\n \"amount\": \"900.0\",\n \"fee\": \"0.0\",\n \"txid\": null,\n \"created_at\": \"2023-09-12T19:04:05+02:00\",\n \"completed_at\": \"2023-09-12T19:04:05+02:00\",\n \"state\": \"accepted\",\n \"humanized_state\": \"Completed\",\n \"note\": \"\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null,\n \"pending_carf_declaration\": false\n },\n {\n \"id\": \"TID8884349AA7\",\n \"sn\": \"SNE677EF1E78\",\n \"snr\": null,\n \"ramps_settled\": false,\n \"currency\": \"btc\",\n \"amount\": \"0.00001\",\n \"fee\": \"0.0\",\n \"txid\": \"0x342342423424243\",\n \"created_at\": \"2023-07-20T16:20:27+02:00\",\n \"confirmations\": 0,\n \"completed_at\": \"2023-07-19T16:20:27+02:00\",\n \"state\": \"accepted\",\n \"humanized_state\": \"Completed\",\n \"note\": \"\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null,\n \"pending_carf_declaration\": false\n }\n ],\n \"pagination\": {\n \"total\": \"3\",\n \"total_pages\": \"1\",\n \"limit\": \"50\",\n \"page\": \"1\",\n \"next_page\": \"\",\n \"prev_page\": \"\"\n }\n}"}],"_postman_id":"5867a0f8-dbe3-4634-8c6b-3f4c1cbc3d76"},{"name":"Deposit:Specific","id":"19816433-84cb-4772-9fdc-bef595d33cd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/deposit?txid=0000000000","description":"

Get details of a specific deposit

Transaction ID of the deposit

\n","type":"text/plain"},"key":"txid","value":"0000000000"}],"variable":[]}},"response":[{"id":"bd4b9aae-858f-4391-8add-9b25f28c800f","name":"Success","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"D12345\",\n \"sn\": \"SN8B4E48B1CE\",\n \"deposited_by\": \"user@ovex.io\",\n \"currency\": \"btc\",\n \"amount\": \"0.5\",\n \"fee\": \"0.001\",\n \"txid\": \"abc123def456...\",\n \"created_at\": \"2026-03-15T10:30:00Z\",\n \"confirmations\": 6,\n \"completed_at\": null,\n \"state\": \"collected\",\n \"carf_transfer_type\": \"CARF505\",\n \"carf_other_description\": null,\n \"pending_carf_declaration\": false,\n \"note\": \"\"\n}"}],"_postman_id":"19816433-84cb-4772-9fdc-bef595d33cd5"},{"name":"Deposit Address","id":"01da8de9-a948-4397-a60e-c90ed9289da5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/deposit_address?currency=bch","description":"

Where to deposit. The address field could be empty when a new address is generating (e.g. for bitcoin), you should try again later in that case.

Get crypto deposits that require a CARF transfer type declaration.

Returns submitted crypto deposits that have not yet been assigned a CARF transfer type. Only deposits created after the CARF cutoff date and that are not system-generated (gifts, referrals, arbitrage) are included.

(Optional) Client SN — for broker use only.

\n","type":"text/plain"},"key":"sn","value":"SNXXXXXXXXXX"}],"variable":[]}},"response":[{"id":"b5c05362-8eb8-458c-a7f0-f86d22e0c522","name":"Success - Pending deposits","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"deposits\": [\n {\n \"id\": \"D12345\",\n \"sn\": \"SN8B4E48B1CE\",\n \"deposited_by\": \"user@ovex.io\",\n \"currency\": \"btc\",\n \"amount\": \"0.5\",\n \"fee\": \"0.001\",\n \"txid\": \"abc123def456...\",\n \"created_at\": \"2026-03-15T10:30:00Z\",\n \"confirmations\": 6,\n \"completed_at\": null,\n \"state\": \"submitted\",\n \"humanized_state\": \"Pending Declaration\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null,\n \"pending_carf_declaration\": true,\n \"note\": \"\"\n }\n ]\n}"},{"id":"9743ac48-3068-4d2e-a2e5-ae5bb9f495a0","name":"Success - No pending deposits","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"deposits\": []\n}"}],"_postman_id":"6bdb92ec-7ce6-4a58-bf62-06b3c29918d6"},{"name":"Declare CARF Type","id":"07020ac8-1a7b-4d6e-bfcd-9a2c048ce05c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"txid\": \"0x0000000000000000000000000000000000000000000000000000000000000000\",\n \"carf_transfer_type\": \"CARF501\",\n \"carf_other_description\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"www.ovex.io/api/v2/deposits/declare_carf","description":"

Declare the CARF transfer type for a pending crypto deposit.

Parameters:

txid (required): The transaction ID of the deposit.
carf_transfer_type (required): A valid CARF deposit type code (e.g. CARF501). Use GET /carf_transfer_types to list valid codes.
carf_other_description (optional): Free-text description when the transfer type is 'Other' (CARF508).
sn (optional): Client SN for broker use only.

Declare the CARF transfer type for ALL pending crypto deposits at once.

Applies the same CARF transfer type to every deposit that is currently awaiting declaration.

Parameters:

carf_transfer_type (required): A valid CARF deposit type code (e.g. CARF501). Use GET /carf_transfer_types to list valid codes.
carf_other_description (optional): Free-text description when the transfer type is 'Other' (CARF508).
sn (optional): Client SN for broker use only.

Deposit Folder

\n","_postman_id":"1990b786-be4e-41a8-b830-1c721899641a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"Withdraws","item":[{"name":"History","id":"bb73a62a-77bd-4f18-be5c-0b27ec2831a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/withdraws/history?currency=zar","description":"

List your withdraws as paginated collection.

Type: Integer\nDefault: 1\n(Optional)\nShows information on the given page number.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Type: Integer\nValues: 1 - 1000\nDefault: 50\n(Optional)\nThe amount of items to display on a page.

\n","type":"text/plain"},"key":"limit","value":"100"},{"disabled":true,"description":{"content":"

Type: ISO Formatted DateTime\n(Optional)\nStart datetime\nDefaults to 30 days ago if not passed

\n","type":"text/plain"},"key":"from","value":"2022-12-31T08:00:00+00:00"},{"disabled":true,"description":{"content":"

Type: ISO Formatted DateTime\n(Optional)\nEnd datetime\nDefaults to the current datetime if not passed

\n","type":"text/plain"},"key":"to","value":"2023-01-31T08:00:00+00:00"},{"disabled":true,"description":{"content":"

If set, returned results will be sorted in specific order, default to 'desc'\nValues: [asc desc]

\n","type":"text/plain"},"key":"order_by","value":"desc"},{"disabled":true,"description":{"content":"

Type: String\n(Optional - Ramps members only)\nThe unique SNR client reference.

\n","type":"text/plain"},"key":"snr","value":"SNRXXXXXXXX"},{"disabled":true,"description":{"content":"

Type: String (Optional)\nType of currency the withdraw belongs to.\nvalues [coin fiat]

\n","type":"text/plain"},"key":"currency_type","value":""},{"description":{"content":"

Type: String\n(Optional)\nCurrency to filter on

\n","type":"text/plain"},"key":"currency","value":"zar"},{"disabled":true,"description":{"content":"

Type: String (Optional)\nIf set, returned data will be in specific format (json default).\nValues: [pdf csv]

\n","type":"text/plain"},"key":"alt_format","value":""}],"variable":[]}},"response":[{"id":"df13e143-b3cc-4d2a-9562-6a26fb2afe80","name":"History (NEW)","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/withdraws?page=1&limit=2","host":["www","ovex","io"],"path":["api","v2","withdraws"],"query":[{"key":"page","value":"1","description":"Type: Integer\nDefault: 1\n(Optional)\nShows information on the given page number."},{"key":"limit","value":"2","description":"Type: Integer\nValues: 1 - 1000\nDefault: 50\n(Optional)\nThe amount of items to display on a page."},{"key":"from","value":"2022-12-31T08:00:00+00:00","description":"Type: ISO Formatted DateTime\n(Optional)\nStart datetime\nDefaults to 30 days ago if not passed","disabled":true},{"key":"to","value":"2023-01-31T08:00:00+00:00","description":"Type: ISO Formatted DateTime\n(Optional)\nStart datetime\nDefaults to the current datetime if not passed","disabled":true},{"key":"snr","value":"SNRXXXXXXXX","description":"Type: String\n(Optional - Ramps members only)\nThe unique SNR client reference.","disabled":true},{"key":"currency","value":"zar","description":"Type: String\n(Optional)\nCurrency to filter on","disabled":true},{"key":"alt_format","value":null,"description":"Type: String \n(Optional)\nIf set, returned data will be in specific format (json default).\nAllowed values: [pdf csv]","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"withdraws\": [\n {\n \"id\": \"TIDA9E93A4E79\",\n \"sn\": \"SN614C7C7507\",\n \"currency\": \"eth\",\n \"type\": \"coin\",\n \"amount\": \"55.0\",\n \"fee\": \"0.0\",\n \"blockchain_txid\": \"0xed084b4cdbc4e64adddd6b7e55446d178d38e6c580bbfb66a71e050a9b34f7af\",\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"0xb0ed8c1db015bca06e56ca5d9379537a0029eb45\"\n },\n \"rid\": \"0xb0ed8c1db015bca06e56ca5d9379537a0029eb45\",\n \"reference\": null,\n \"state\": \"succeed\",\n \"note\": null,\n \"created_at\": \"2023-10-10T18:00:12+02:00\",\n \"updated_at\": \"2023-10-10T18:00:12+02:00\",\n \"done_at\": \"2023-10-10T18:00:12+02:00\",\n \"created_via\": \"api\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TID9D71111F0B\",\n \"sn\": \"SN614C7C7507\",\n \"currency\": \"zar\",\n \"type\": \"fiat\",\n \"amount\": \"983.0\",\n \"fee\": \"0.0\",\n \"withdraw_data\": {\n \"bank_name\": \"Example Bank\",\n \"branch_code\": \"00000\",\n \"account_number\": \"0123456789\",\n \"account_holder_name\": \"Jon Doe\"\n },\n \"rid\": \"Jon Doe, Example Bank, 0123456789, 00000\",\n \"reference\": null,\n \"state\": \"succeed\",\n \"note\": null,\n \"created_at\": \"2023-10-05T14:28:51+02:00\",\n \"updated_at\": \"2023-10-05T14:28:51+02:00\",\n \"done_at\": \"2023-10-05T14:28:51+02:00\",\n \"created_via\": \"web\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TID9D75471F0B\",\n \"sn\": \"SN614C7C7507\",\n \"currency\": \"zar\",\n \"type\": \"fiat\",\n \"amount\": \"100.0\",\n \"fee\": \"0.0\",\n \"withdraw_data\": {\n \"bank_name\": \"Example Bank\",\n \"branch_code\": \"00000\",\n \"account_number\": \"0123456789\",\n \"account_holder_name\": \"Jon Doe\"\n },\n \"rid\": \"Jon Doe, Example Bank, 0123456789, 00000\",\n \"reference\": \"ANT test\",\n \"state\": \"succeed\",\n \"note\": null,\n \"created_at\": \"2023-10-03T14:28:51+02:00\",\n \"updated_at\": \"2023-10-03T14:28:51+02:00\",\n \"done_at\": \"2023-10-03T14:28:51+02:00\",\n \"created_via\": null,\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TID7F5E41572A\",\n \"sn\": \"SN614C7C7507\",\n \"currency\": \"zar\",\n \"type\": \"fiat\",\n \"amount\": \"9000.0\",\n \"fee\": \"8.0\",\n \"withdraw_data\": {\n \"bank_name\": \"Example Bank\",\n \"branch_code\": \"00000\",\n \"account_number\": \"0123456789\",\n \"account_holder_name\": \"Jon Doe\"\n },\n \"rid\": \"Jon Doe, Example Bank, 0123456789, 00000\",\n \"reference\": null,\n \"state\": \"canceled\",\n \"note\": null,\n \"created_at\": \"2023-10-03T12:07:17+02:00\",\n \"updated_at\": \"2023-10-03T12:10:34+02:00\",\n \"done_at\": null,\n \"created_via\": null,\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDE74BF874F8\",\n \"sn\": \"SN614C7C7507\",\n \"currency\": \"zar\",\n \"type\": \"fiat\",\n \"amount\": \"9000.0\",\n \"fee\": \"8.0\",\n \"withdraw_data\": {\n \"bank_name\": \"Example Bank\",\n \"branch_code\": \"00000\",\n \"account_number\": \"0123456789\",\n \"account_holder_name\": \"Jon Doe\"\n },\n \"rid\": \"Jon Doe, Example Bank, 0123456789, 00000\",\n \"reference\": null,\n \"state\": \"rejected\",\n \"note\": \"R800.0 is still locked as funds deposited via instant EFT are only withdrawable after 2 business days\",\n \"created_at\": \"2023-10-03T12:05:37+02:00\",\n \"updated_at\": \"2023-10-03T12:05:37+02:00\",\n \"done_at\": null,\n \"created_via\": null,\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TID9D55479F0B\",\n \"sn\": \"SN614C7C7507\",\n \"currency\": \"zar\",\n \"type\": \"fiat\",\n \"amount\": \"100.0\",\n \"fee\": \"0.0\",\n \"withdraw_data\": {\n \"bank_name\": \"Example Bank\",\n \"branch_code\": \"00000\",\n \"account_number\": \"0123456789\",\n \"account_holder_name\": \"Jon Doe\"\n },\n \"rid\": \"Jon Doe, Example Bank, 0123456789, 00000\",\n \"reference\": null,\n \"state\": \"rejected\",\n \"note\": \"Third party withdrawal detected. Please withdraw to your own account.\",\n \"created_at\": \"2023-10-02T14:28:51+02:00\",\n \"updated_at\": \"2023-10-02T14:28:51+02:00\",\n \"done_at\": \"2023-10-02T14:28:51+02:00\",\n \"created_via\": null,\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"N/A\",\n \"sn\": \"SN614C7C7507\",\n \"currency\": \"btc\",\n \"type\": \"coin\",\n \"amount\": \"0.00000002\",\n \"fee\": \"0.0\",\n \"blockchain_txid\": \"Manual Adjustment\",\n \"rid\": \"N/A\",\n \"reference\": \"Account Adjustment\",\n \"state\": \"succeed\",\n \"note\": \"Account Adjustment\",\n \"created_at\": \"2023-07-30T19:44:51+02:00\",\n \"updated_at\": \"2023-07-30T19:44:51+02:00\",\n \"done_at\": \"2023-07-30T19:44:51+02:00\",\n \"created_via\": \"AccountAdjustment\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TID9A55471F0B\",\n \"sn\": \"SN614C7C7507\",\n \"currency\": \"eth\",\n \"type\": \"coin\",\n \"amount\": \"0.0000015\",\n \"fee\": \"0.0\",\n \"blockchain_txid\": \"0XKJDDLOSDAS\",\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"0xb0ed8c1db015bca06e56ca5d9379537a0029eb45\"\n },\n \"rid\": \"0xb0ed8c1db015bca06e56ca5d9379537a0029eb45\",\n \"reference\": null,\n \"state\": \"succeed\",\n \"note\": null,\n \"created_at\": \"2023-07-27T19:44:51+02:00\",\n \"updated_at\": \"2023-07-27T19:44:51+02:00\",\n \"done_at\": null,\n \"created_via\": null,\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n }\n ],\n \"pagination\": {\n \"total\": \"8\",\n \"total_pages\": \"1\",\n \"limit\": \"50\",\n \"page\": \"1\",\n \"next_page\": \"\",\n \"prev_page\": \"\"\n }\n}"}],"_postman_id":"bb73a62a-77bd-4f18-be5c-0b27ec2831a9"},{"name":"Create","id":"da540a91-2e7b-45fa-844e-e18787cc291e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"www.ovex.io/api/v2/withdraws/create?amount=100&beneficiary_id=1","description":"

Create a withdrawal for an existing beneficiary.

API Withdrawals are only enabled for saved and confirmed beneficiaries. Add a beneficiary using the beneficiary endpoints or through the website UI. Beneficiaries will have to be confirmed (via email).

(Optional) CARF transfer type code for crypto withdrawals. Use GET /carf_transfer_types to list valid codes. Required for crypto withdrawals in CARF-applicable jurisdictions.

\n","type":"text/plain"},"key":"carf_transfer_type","value":"CARF601"},{"disabled":true,"description":{"content":"

(Optional) Free-text description when carf_transfer_type is 'Other' (CARF605).

\n","type":"text/plain"},"key":"carf_other_description","value":""}],"variable":[]}},"response":[{"id":"0b59f3e9-a366-463b-b81b-6537f462766a","name":"Success","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 456,\n \"tid\": \"TIDABC123DEF\",\n \"currency\": \"btc\",\n \"amount\": \"0.5\",\n \"fee\": \"0.001\",\n \"state\": \"submitted\",\n \"beneficiary_id\": 789,\n \"created_at\": \"2026-03-15T10:30:00Z\",\n \"carf_transfer_type\": \"CARF601\",\n \"carf_other_description\": null\n}"},{"id":"66800ffe-69ac-4f3e-9665-0257502ac266","name":"Insufficient funds","originalRequest":{"header":[],"url":""},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Insufficient funds available\"\n}"}],"_postman_id":"da540a91-2e7b-45fa-844e-e18787cc291e"}],"id":"2ca5058f-045a-4b69-8fb0-43c28a5bba97","description":"

Withdraws Folder

\n","_postman_id":"2ca5058f-045a-4b69-8fb0-43c28a5bba97","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"Fees","item":[{"name":"Fees:Deposit","id":"6f576863-dd0c-42e4-941e-9decc478e876","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/fees/deposit","description":"

Returns deposit fees for currencies

Returns withdraw fees for currencies.

Fees endpoints

\n","_postman_id":"75a24827-d43f-4ff1-881b-5d4b0978c8c5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"Members","item":[{"name":"Members","id":"261ff483-2aaa-478f-95c4-7152517dc1db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/members/me","description":"

Get your profile and accounts info

Returns list of member levels and the privileges they provide.

Member endpoints

\n","_postman_id":"e2f1aee6-a0a2-442a-ac09-f1bcab3970fa","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"Currency","item":[{"name":"Currencies","id":"10ed3249-d3ef-40fa-a601-759320a07197","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"www.ovex.io/api/v2/currencies?type=coin&new_data=true","description":"

Get list of currencies

\n","urlObject":{"path":["api/v2","currencies"],"host":["www.ovex.io"],"query":[{"description":{"content":"

Currency type (Optional)

\n","type":"text/plain"},"key":"type","value":"coin"},{"description":{"content":"

Returns new response structure when set to true (Optional). Default false

\n","type":"text/plain"},"key":"new_data","value":"true"}],"variable":[]}},"response":[{"id":"3469d849-f2b8-43fc-bec1-d4fd4256f126","name":"Old Response Structure","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/currencies?type=coin&new_data=false","host":["www.ovex.io"],"path":["api/v2","currencies"],"query":[{"key":"type","value":"coin","description":"Currency type (Optional)"},{"key":"new_data","value":"false","description":"Returns new response structure when set to true (Optional). Default false "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"aave\",\n \"name\": \"AAVE coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/08 13:37:36 +0200\"\n },\n {\n \"id\": \"ada\",\n \"name\": \"Cardano Coin \",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/08 13:37:36 +0200\"\n },\n {\n \"id\": \"ape\",\n \"name\": \"APE coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/08 13:37:36 +0200\"\n },\n {\n \"id\": \"avax\",\n \"name\": \"Avax coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/08 13:37:36 +0200\"\n },\n {\n \"id\": \"bnb\",\n \"name\": \"Binance Coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/21 15:45:05 +0200\"\n },\n {\n \"id\": \"btc\",\n \"name\": \"Bitcoin\",\n \"symbol\": \"฿\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0000356\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.1\",\n \"withdraw_limit_72h\": \"0.2\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 100000000,\n \"precision\": 8,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/21 15:45:05 +0200\"\n },\n {\n \"id\": \"comp\",\n \"name\": \"Compound\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/08 13:37:36 +0200\"\n },\n {\n \"id\": \"doge\",\n \"name\": \"Doge Coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/08 13:37:36 +0200\"\n },\n {\n \"id\": \"eth\",\n \"name\": \"Ethereum\",\n \"symbol\": \"Ξ\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.00021\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.2\",\n \"withdraw_limit_72h\": \"0.5000000000000001\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1000000000000000000,\n \"precision\": 8,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/21 15:45:05 +0200\"\n },\n {\n \"id\": \"kp3r\",\n \"name\": \"Keep3RV1\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/08 13:37:36 +0200\"\n },\n {\n \"id\": \"link\",\n \"name\": \"Chainlink\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/08 13:37:36 +0200\"\n },\n {\n \"id\": \"ltc\",\n \"name\": \"Litecoin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 1,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/08 13:37:36 +0200\"\n },\n {\n \"id\": \"shib\",\n \"name\": \"SHIBA Coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/08 13:37:36 +0200\"\n },\n {\n \"id\": \"sol\",\n \"name\": \"Solana\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 1,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/21 15:45:05 +0200\"\n },\n {\n \"id\": \"sushi\",\n \"name\": \"Sushi Swap\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/08 13:37:36 +0200\"\n },\n {\n \"id\": \"usdc\",\n \"name\": \"USD Coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/21 15:45:05 +0200\"\n },\n {\n \"id\": \"usdt\",\n \"name\": \"USD Tether\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 2,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/21 15:45:05 +0200\"\n },\n {\n \"id\": \"xrp\",\n \"name\": \"Ripple\",\n \"symbol\": \"X\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": false,\n \"withdrawal_enabled\": false,\n \"instant_exchange\": false,\n \"base_factor\": 1000000,\n \"precision\": 6,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/21 15:45:05 +0200\"\n },\n {\n \"id\": \"zarp\",\n \"name\": \"ZARP\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": false,\n \"withdrawal_enabled\": false,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/08 13:37:36 +0200\"\n }\n]"},{"id":"5a2eb7ba-da2a-4ab2-bba6-af0571969382","name":"New Response Structure","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/currencies?type=coin&new_data=true","host":["www.ovex.io"],"path":["api/v2","currencies"],"query":[{"key":"type","value":"coin","description":"Currency type (Optional)"},{"key":"new_data","value":"true","description":"Returns new response structure when set to true (Optional). Default false "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"aave\",\n \"name\": \"AAVE coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"networks\": [\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.1\",\n \"withdraw_fee\": \"0.1\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"0.2\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"ada\",\n \"name\": \"Cardano Coin \",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"networks\": [\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"4.0\",\n \"withdraw_fee\": \"125.0\",\n \"withdrawal_enabled\": false,\n \"min_withdraw_amount\": \"4.0\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"ape\",\n \"name\": \"APE coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"networks\": [\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"1.0\",\n \"withdraw_fee\": \"0.5000000000000001\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"1.0\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"avax\",\n \"name\": \"Avax coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"networks\": [],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"bnb\",\n \"name\": \"Binance Coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"networks\": [\n {\n \"network_name\": \"binance\",\n \"deposit_enabled\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"1.0\",\n \"withdraw_fee\": \"0.1\",\n \"withdrawal_enabled\": false,\n \"min_withdraw_amount\": \"0.5000000000000001\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"btc\",\n \"name\": \"Bitcoin\",\n \"symbol\": \"฿\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"networks\": [\n {\n \"network_name\": \"bitcoin\",\n \"deposit_enabled\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0003\",\n \"withdraw_fee\": \"0.00015\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"0.0003\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.1\",\n \"withdraw_limit_72h\": \"0.2\",\n \"instant_exchange\": false,\n \"base_factor\": 100000000,\n \"precision\": 8,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"comp\",\n \"name\": \"Compound\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"networks\": [\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.1\",\n \"withdraw_fee\": \"0.1\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"0.2\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"doge\",\n \"name\": \"Doge Coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"networks\": [],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"eth\",\n \"name\": \"Ethereum\",\n \"symbol\": \"Ξ\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"networks\": [\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.01\",\n \"withdraw_fee\": \"0.0025\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"0.015\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.2\",\n \"withdraw_limit_72h\": \"0.5000000000000001\",\n \"instant_exchange\": false,\n \"base_factor\": 1000000000000000000,\n \"precision\": 8,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"kp3r\",\n \"name\": \"Keep3RV1\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"networks\": [\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.1\",\n \"withdraw_fee\": \"0.01\",\n \"withdrawal_enabled\": false,\n \"min_withdraw_amount\": \"0.02\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"link\",\n \"name\": \"Chainlink\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"networks\": [\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"3.4\",\n \"withdraw_fee\": \"1.2\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"3.4\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"ltc\",\n \"name\": \"Litecoin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"networks\": [\n {\n \"network_name\": \"litecoin\",\n \"deposit_enabled\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.002\",\n \"withdraw_fee\": \"0.05\",\n \"withdrawal_enabled\": false,\n \"min_withdraw_amount\": \"0.1\"\n }\n ],\n \"min_confirmations\": 1,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"shib\",\n \"name\": \"SHIBA Coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"networks\": [\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"100000.0\",\n \"withdraw_fee\": \"99000.0\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"100000.0\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"sol\",\n \"name\": \"Solana\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"networks\": [\n {\n \"network_name\": \"solana\",\n \"deposit_enabled\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.01\",\n \"withdraw_fee\": \"0.005\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"0.1\"\n }\n ],\n \"min_confirmations\": 1,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"sushi\",\n \"name\": \"Sushi Swap\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"networks\": [\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"3.0\",\n \"withdraw_fee\": \"3.0\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"4.0\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"usdc\",\n \"name\": \"USD Coin\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"networks\": [\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"10.0\",\n \"withdraw_fee\": \"8.0\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"10.0\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"usdt\",\n \"name\": \"USD Tether\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"networks\": [\n {\n \"network_name\": \"tron\",\n \"deposit_enabled\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"10.0\",\n \"withdraw_fee\": \"5.0\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"10.0\"\n },\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"2.0\",\n \"withdraw_fee\": \"8.0\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"10.0\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 2,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"xrp\",\n \"name\": \"Ripple\",\n \"symbol\": \"X\",\n \"type\": \"coin\",\n \"erc20\": false,\n \"networks\": [\n {\n \"network_name\": \"ripple\",\n \"deposit_enabled\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"10.0\",\n \"withdraw_fee\": \"2.0\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"10.0\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1000000,\n \"precision\": 6,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n },\n {\n \"id\": \"zarp\",\n \"name\": \"ZARP\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"networks\": [\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"100.0\",\n \"withdraw_fee\": \"20.0\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"100.0\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 0,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n }\n]"}],"_postman_id":"10ed3249-d3ef-40fa-a601-759320a07197"},{"name":"Currencies:Id","id":"21b7f512-b742-4866-ace9-4468ea16ebd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/currencies/{id}?=&new_data=true","description":"

Get list of currencies

Returns new response structure when set to true (Optional). Default false

\n","type":"text/plain"},"key":"new_data","value":"true"}],"variable":[]}},"response":[{"id":"8efd85bf-ac44-46e2-b3a1-5c9f9d1006e9","name":"Old Response Structure","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/currencies/usdt?&new_data=false","host":["www.ovex.io"],"path":["api/v2","currencies","usdt"],"query":[{"key":null,"value":null},{"key":"type","value":"coin","disabled":true},{"key":"new_data","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"usdt\",\n \"name\": \"USD Tether\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"0.0\",\n \"min_confirmations\": 6,\n \"withdraw_fee\": \"0.0\",\n \"min_withdraw_amount\": \"0.0\",\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"deposit_enabled\": true,\n \"withdrawal_enabled\": true,\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 2,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\",\n \"updated_at\": \"2025/07/21 15:45:05 +0200\"\n}"},{"id":"0e200919-b501-4edd-8b70-69024c5dd711","name":"New Response Structure","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/currencies/usdt?&new_data=true","host":["www.ovex.io"],"path":["api/v2","currencies","usdt"],"query":[{"key":null,"value":null},{"key":"type","value":"coin","disabled":true},{"key":"new_data","value":"true","description":"Returns new response structure when set to true (Optional). Default false "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"usdt\",\n \"name\": \"USD Tether\",\n \"symbol\": \"A\",\n \"type\": \"coin\",\n \"erc20\": true,\n \"networks\": [\n {\n \"network_name\": \"ethereum\",\n \"deposit_enabled\": true,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"2.0\",\n \"withdraw_fee\": \"8.0\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"10.0\"\n },\n {\n \"network_name\": \"tron\",\n \"deposit_enabled\": false,\n \"deposit_fee\": \"0.0\",\n \"min_deposit_amount\": \"10.0\",\n \"withdraw_fee\": \"5.0\",\n \"withdrawal_enabled\": true,\n \"min_withdraw_amount\": \"10.0\"\n }\n ],\n \"min_confirmations\": 6,\n \"withdraw_limit_24h\": \"0.0\",\n \"withdraw_limit_72h\": \"0.0\",\n \"instant_exchange\": false,\n \"base_factor\": 1,\n \"precision\": 2,\n \"display_precision\": 3,\n \"icon_url\": \"https://currency.icon\"\n}"}],"_postman_id":"21b7f512-b742-4866-ace9-4468ea16ebd5"},{"name":"Withdraw Requirements","event":[{"listen":"test","script":{"exec":["var template = `","","",""," "," "," "," "," "," "," "," {{#each response}}"," "," "," "," "," "," "," {{/each}}","

Label	Key	Value	Required
{{label}}	{{key}}	{{value}}	{{required}}

","`;","","function constructVisualizerPayload() {"," return {response: pm.response.json()}","}","","pm.visualizer.set(template, constructVisualizerPayload());"],"type":"text/javascript","packages":{},"id":"4f20426f-cd6c-4bbf-818b-7bd9961eedce"}}],"id":"1f38debb-a381-4668-a5db-827ff541335e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"currency_id","value":"gbp","description":"

The currency code, upper or lower case e.g. ZAR, BTC, btc, gbp.

\n","type":"text","uuid":"2dfdbcfb-d092-41af-ae4e-4359c6ffc634"}]},"url":"www.ovex.io/api/v2/currencies/withdraw_requirements","description":"

Get a list of different payment methods and the additional withdraw requirements for each method.

A Fiat beneficiary has a payment_method e.g. SWIFT, SEPA
\n
A Coin beneficiary has a network_name e.g. bitcoin, ethereum
\n

Note:

The payment_method and network_name are case sensitive.
\n
The key's with required = trueneed to be provided (in addition) when creating a beneficiary.
\n

\n","urlObject":{"path":["api/v2","currencies","withdraw_requirements"],"host":["www.ovex.io"],"query":[],"variable":[]}},"response":[{"id":"2043c102-f6fe-4e83-94e3-2aef233a91b8","name":"Coin USDT","originalRequest":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/currencies/withdraw_requirements"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n [\n {\n \"key\": \"network_name\",\n \"value\": \"ethereum\",\n \"required\": true\n },\n {\n \"key\": \"crypto_wallet_address\",\n \"required\": true\n }\n ]\n]"},{"id":"02a022d0-22c1-493e-8ba0-0f35d591834d","name":"Fiat GBP","originalRequest":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/currencies/withdraw_requirements"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n [\n {\n \"key\": \"payment_method\",\n \"value\": \"CHAPS\",\n \"required\": true\n },\n {\n \"key\": \"account_holder_name\",\n \"required\": true\n },\n {\n \"key\": \"bank_name\",\n \"required\": true\n },\n {\n \"key\": \"bank_country\",\n \"required\": true\n },\n {\n \"key\": \"account_number\",\n \"required\": true\n },\n {\n \"key\": \"swift_code\",\n \"required\": false\n },\n {\n \"key\": \"sort_code\",\n \"required\": true\n },\n {\n \"key\": \"street_address\",\n \"required\": true\n },\n {\n \"key\": \"city\",\n \"required\": true\n },\n {\n \"key\": \"postal_code\",\n \"required\": true\n }\n ],\n [\n {\n \"key\": \"payment_method\",\n \"value\": \"Faster Payments\",\n \"required\": true\n },\n {\n \"key\": \"account_holder_name\",\n \"required\": true\n },\n {\n \"key\": \"bank_name\",\n \"required\": true\n },\n {\n \"key\": \"bank_country\",\n \"required\": true\n },\n {\n \"key\": \"account_number\",\n \"required\": true\n },\n {\n \"key\": \"sort_code\",\n \"required\": true\n },\n {\n \"key\": \"street_address\",\n \"required\": true\n },\n {\n \"key\": \"city\",\n \"required\": true\n },\n {\n \"key\": \"postal_code\",\n \"required\": true\n }\n ],\n [\n {\n \"key\": \"payment_method\",\n \"value\": \"SWIFT\",\n \"required\": true\n },\n {\n \"key\": \"account_holder_name\",\n \"required\": true\n },\n {\n \"key\": \"bank_name\",\n \"required\": true\n },\n {\n \"key\": \"bank_country\",\n \"required\": true\n },\n {\n \"key\": \"iban\",\n \"required\": true\n },\n {\n \"key\": \"swift_code\",\n \"required\": false\n },\n {\n \"key\": \"street_address\",\n \"required\": true\n },\n {\n \"key\": \"city\",\n \"required\": true\n },\n {\n \"key\": \"postal_code\",\n \"required\": true\n },\n {\n \"key\": \"intermediary_bank_swift_code\",\n \"required\": false\n },\n {\n \"key\": \"intermediary_bank_street_address\",\n \"required\": false\n },\n {\n \"key\": \"intermediary_bank_postal_code\",\n \"required\": false\n }\n ]\n]"}],"_postman_id":"1f38debb-a381-4668-a5db-827ff541335e"}],"id":"a3ca981a-5cce-4caa-a043-954eff97aa92","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"30e050f8-5567-4641-92cc-7417c90dd0c7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4a11805a-a93a-4d0d-b0e9-91a40b454b25"}}],"_postman_id":"a3ca981a-5cce-4caa-a043-954eff97aa92","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"Sessions","item":[{"name":"Sessions","id":"e58dda5a-9f6a-4d2e-a589-b7f0645e202f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"www.ovex.io/api/v2/sessions","description":"

Create a new user session

Deletes all sessions for a user.

Get list of user accounts

User account currency.

\n","type":"text/plain"},"key":"currency","value":"btc"}],"variable":[]}},"response":[{"id":"99c3bb92-3a0a-4b75-9c16-d09b6a9f0652","name":"Success","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"currency\": \"btc\",\n \"balance\": \"0.5\",\n \"locked\": \"0.0\",\n \"deposit_address\": \"bc1q...\"\n}"}],"_postman_id":"258de059-8783-462b-8187-76b52ff0e777"},{"name":"Open Account","id":"c956b4fc-8d9d-4e94-a878-6561eec11485","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"www.ovex.io/api/v2/account?currency=zarp&sn=SNXXXXXXXXXX","description":"

Create an account for the given currency.

Currency of the account you want to open.

\n","type":"text/plain"},"key":"currency","value":"zarp"},{"description":{"content":"

The SN of a broker's client that you would like to open an account for.

\n","type":"text/plain"},"key":"sn","value":"SNXXXXXXXXXX"}],"variable":[]}},"response":[{"id":"5ecec2e5-a2bf-4241-8f9e-af09bd167bef","name":"Open Account (Standard)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"www.ovex.io/api/v2/account?currency=zarp","host":["www.ovex.io"],"path":["api/v2","account"],"query":[{"key":"currency","value":"zarp","description":"Currency of the account you want to open"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"currency\": \"zarp\",\n \"currency_name\": \"\",\n \"icon_url\": \"https://pbs.twimg.com/media/DfkiZGiW0AADnt9.png\",\n \"balance\": \"0.0\",\n \"locked\": \"0.0\",\n \"total_balance\": \"0.0\",\n \"btc_eq\": \"0.0\",\n \"usd_eq\": \"0.0\",\n \"display_precision\": 3,\n \"state\": \"pending\"\n}"}],"_postman_id":"c956b4fc-8d9d-4e94-a878-6561eec11485"}],"id":"15c1dcb0-066c-46e5-a95c-ac8b27c37a37","_postman_id":"15c1dcb0-066c-46e5-a95c-ac8b27c37a37","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"Broker","item":[{"name":"Withdraws","id":"20cfdaa4-b435-4ba8-ba9e-db559ec02a0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/broker/withdraws?currency=btc&tid=TIDXXXXXXXXX&sn=SNXXXXXXXXXX","description":"

Broker Endpoint:\nGet a list of historic client withdraws for clients in your broker profile

Currency symbol. e.g. (btc, zar etc.) OPTIONAL

\n","type":"text/plain"},"key":"currency","value":"btc"},{"description":{"content":"

Unique TID of withdrawal OPTIONAL

\n","type":"text/plain"},"key":"tid","value":"TIDXXXXXXXXX"},{"description":{"content":"

Unique SN of a client OPTIONAL

\n","type":"text/plain"},"key":"sn","value":"SNXXXXXXXXXX"},{"disabled":true,"description":{"content":"

Type: String (Optional)\nType of currency the withdraw belongs to.\nvalues [coin fiat]

\n","type":"text/plain"},"key":"currency_type","value":""}],"variable":[]}},"response":[{"id":"be3fd143-ac4a-444f-9ed1-7f8abc1c01af","name":"Withdraws (New)","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/broker/withdraws","host":["www.ovex.io"],"path":["api/v2","broker","withdraws"],"query":[{"key":"currency","value":"btc","description":"Currency symbol. e.g. (btc, zar etc.) OPTIONAL","disabled":true},{"key":"tid","value":"TIDXXXXXXXXX","description":"Unique TID of withdrawal OPTIONAL","disabled":true},{"key":"sn","value":"SNXXXXXXXXXX","description":"Unique SN of a client OPTIONAL","disabled":true},{"key":"currency_type","value":"","description":"Type: String (Optional)\nType of currency the withdraw belongs to.\nvalues [coin fiat]","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"btc\",\n \"type\": \"coin\",\n \"amount\": \"0.005\",\n \"fee\": \"0.0001\",\n \"blockchain_txid\": \"0xaa2baf3d9e309f9c915a8acf162f51baa7b111fba084c8309e9865226f0e7e83\",\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"0x0xxxxxxxxxxxxxxxxxxxxx\"\n },\n \"rid\": \"0x0xxxxxxxxxxxxxxxxxxxxx\",\n \"reference\": \"4232242431\",\n \"state\": \"suspected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"created_at\": \"2024-12-05T18:38:50+02:00\",\n \"updated_at\": \"2024-12-05T18:38:52+02:00\",\n \"done_at\": null,\n \"created_via\": null,\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"zar\",\n \"type\": \"fiat\",\n \"amount\": \"5000.0\",\n \"fee\": \"60.0\",\n \"withdraw_data\": {\n \"bank_name\": \"Paula Barton bank of the people\",\n \"branch_code\": \"2424\",\n \"account_number\": \"42311424\",\n \"account_holder_name\": \"Kameko Mcmahon\"\n },\n \"rid\": \"Kameko Mcmahon, Paula Barton bank of the people, 42311424, 2424\",\n \"reference\": \"\",\n \"state\": \"rejected\",\n \"note\": \"Withdrawal risk error. Please contact support@ovex.io and quote the withdrawal TID (TIDCD131C5869) on this email.\",\n \"created_at\": \"2024-12-05T18:19:05+02:00\",\n \"updated_at\": \"2024-12-05T18:19:07+02:00\",\n \"done_at\": \"2024-12-05T18:19:07+02:00\",\n \"created_via\": null,\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"zar\",\n \"type\": \"fiat\",\n \"amount\": \"5000.0\",\n \"fee\": \"60.0\",\n \"withdraw_data\": {\n \"bank_name\": \"Paula Barton Bank\",\n \"branch_code\": \"078899\",\n \"account_number\": \"34058525\",\n \"account_holder_name\": \"Jossia De Deciples \"\n },\n \"rid\": \"Jossia De Deciples , Paula Barton Bank, 34058525, 078899\",\n \"reference\": \"\",\n \"state\": \"rejected\",\n \"note\": \"Withdrawal risk error. Please contact support@ovex.io and quote the withdrawal TID (TIDCE893C87F4) on this email.\",\n \"created_at\": \"2024-12-05T18:15:28+02:00\",\n \"updated_at\": \"2024-12-05T18:15:30+02:00\",\n \"done_at\": \"2024-12-05T18:15:30+02:00\",\n \"created_via\": null,\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"eth\",\n \"type\": \"coin\",\n \"amount\": \"0.5\",\n \"fee\": \"0.0001\",\n \"blockchain_txid\": \"0xce7da7943c2287b3c66291c970a51d371bb3ec8bf3fa2d6859c3b7c4fdcac25a\",\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"0xb08074dedc5e9d5a3acf34ffe175a771e624c89f\"\n },\n \"rid\": \"0xb08074dedc5e9d5a3acf34ffe175a771e624c89f\",\n \"reference\": null,\n \"state\": \"rejected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"created_at\": \"2024-12-05T16:04:49+02:00\",\n \"updated_at\": \"2024-12-05T16:04:53+02:00\",\n \"done_at\": \"2024-12-05T16:04:52+02:00\",\n \"created_via\": \"api\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"usdt\",\n \"type\": \"coin\",\n \"amount\": \"500.0\",\n \"fee\": \"0.0\",\n \"blockchain_txid\": \"0x544fdbf6470fa4bdedabb675b4fa15b2e0a5c81dcdd3dc0a6ac6de4329d8a6f6\",\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"0x4730fd7f76af4cad616573bfe1c2891066f14b03\"\n },\n \"rid\": \"0x4730fd7f76af4cad616573bfe1c2891066f14b03\",\n \"reference\": \"The ref\",\n \"state\": \"suspected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"created_at\": \"2024-11-28T10:52:52+02:00\",\n \"updated_at\": \"2024-11-28T10:52:56+02:00\",\n \"done_at\": null,\n \"created_via\": null,\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"zar\",\n \"type\": \"fiat\",\n \"amount\": \"200.0\",\n \"fee\": \"60.0\",\n \"withdraw_data\": {\n \"account_holder_name\": \"default rid\"\n },\n \"rid\": \"default rid\",\n \"reference\": null,\n \"state\": \"rejected\",\n \"note\": \"Third party withdrawal detected. Please withdraw to your own account.\",\n \"created_at\": \"2024-10-28T16:35:39+02:00\",\n \"updated_at\": \"2024-10-28T16:35:39+02:00\",\n \"done_at\": \"2024-10-28T16:35:39+02:00\",\n \"created_via\": \"api\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"usd\",\n \"type\": \"fiat\",\n \"amount\": \"200.0\",\n \"fee\": \"60.0\",\n \"withdraw_data\": {\n \"city\": \"Atlanta Georgia\",\n \"country\": \"US\",\n \"bank_name\": \"Gaylord - Price Bank\",\n \"branch_code\": \"UCVUSBO1\",\n \"postal_code\": \"0008\",\n \"email_address\": \"example@email.com\",\n \"account_number\": \"09775457\",\n \"account_holder_name\": \"Mannie Samantha\"\n },\n \"rid\": \"Mannie Samantha, Gaylord - Price Bank, 09775457, example@email.com, Atlanta Georgia, 0008, US\",\n \"reference\": null,\n \"state\": \"suspected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"created_at\": \"2024-10-28T16:35:24+02:00\",\n \"updated_at\": \"2024-10-28T16:35:25+02:00\",\n \"done_at\": null,\n \"created_via\": \"api\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"eth\",\n \"type\": \"coin\",\n \"amount\": \"0.5\",\n \"fee\": \"0.0001\",\n \"blockchain_txid\": \"0x5ce205b6f2142c8edbfd088098fc47bab4c2aa50634bd9a8af9b463960d0d49d\",\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"default rid\"\n },\n \"rid\": \"default rid\",\n \"reference\": null,\n \"state\": \"suspected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"created_at\": \"2024-10-28T16:34:37+02:00\",\n \"updated_at\": \"2024-10-28T16:34:39+02:00\",\n \"done_at\": null,\n \"created_via\": \"api\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"eth\",\n \"type\": \"coin\",\n \"amount\": \"0.5\",\n \"fee\": \"0.0001\",\n \"blockchain_txid\": \"0x90659a88019743d49e02f119a7d201a773ca8d4a8f603f697cbda1544895bd4b\",\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"0xb08074dedc5e9d5a3acf34ffe175a771e624c89f\"\n },\n \"rid\": \"0xb08074dedc5e9d5a3acf34ffe175a771e624c89f\",\n \"reference\": null,\n \"state\": \"suspected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"created_at\": \"2024-10-28T16:16:45+02:00\",\n \"updated_at\": \"2024-10-28T16:16:48+02:00\",\n \"done_at\": null,\n \"created_via\": \"api\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"usd\",\n \"type\": \"fiat\",\n \"amount\": \"200.0\",\n \"fee\": \"60.0\",\n \"withdraw_data\": {\n \"city\": \"Atlanta Georgia\",\n \"country\": \"US\",\n \"bank_name\": \"Conroy Group Bank\",\n \"branch_code\": \"EVYAMUK1348\",\n \"postal_code\": \"0008\",\n \"email_address\": \"example@email.com\",\n \"account_number\": \"57316928\",\n \"account_holder_name\": \"Mannie Samantha\"\n },\n \"rid\": \"Mannie Samantha, Conroy Group Bank, 57316928, example@email.com, Atlanta Georgia, 0008, US\",\n \"reference\": null,\n \"state\": \"suspected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"created_at\": \"2024-10-28T16:15:06+02:00\",\n \"updated_at\": \"2024-10-28T16:15:08+02:00\",\n \"done_at\": null,\n \"created_via\": \"api\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"usd\",\n \"type\": \"fiat\",\n \"amount\": \"200.0\",\n \"fee\": \"60.0\",\n \"withdraw_data\": {\n \"city\": \"Atlanta Georgia\",\n \"country\": \"US\",\n \"bank_name\": \"Thiel, Skiles and Hermiston Bank\",\n \"branch_code\": \"WANOPKE1\",\n \"postal_code\": \"0008\",\n \"email_address\": \"example@email.com\",\n \"account_number\": \"68667059\",\n \"account_holder_name\": \"Mannie Samantha\"\n },\n \"rid\": \"Mannie Samantha, Thiel, Skiles and Hermiston Bank, 68667059, example@email.com, Atlanta Georgia, 0008, US\",\n \"reference\": null,\n \"state\": \"suspected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"created_at\": \"2024-10-28T13:42:50+02:00\",\n \"updated_at\": \"2024-10-28T13:42:52+02:00\",\n \"done_at\": null,\n \"created_via\": \"api\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"eth\",\n \"type\": \"coin\",\n \"amount\": \"0.5\",\n \"fee\": \"0.0001\",\n \"blockchain_txid\": \"0xf150da6b59c5890d990332221cce3e6b2ef1276d7ab3e66f45bb7fbc3dbc521e\",\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"default rid\"\n },\n \"rid\": \"default rid\",\n \"reference\": null,\n \"state\": \"rejected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"created_at\": \"2024-10-28T13:40:06+02:00\",\n \"updated_at\": \"2024-10-28T13:40:08+02:00\",\n \"done_at\": \"2024-10-28T13:40:08+02:00\",\n \"created_via\": \"api\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"usd\",\n \"type\": \"fiat\",\n \"amount\": \"200.0\",\n \"fee\": \"60.0\",\n \"withdraw_data\": {\n \"city\": \"Atlanta Georgia\",\n \"country\": \"US\",\n \"bank_name\": \"Legros LLC Bank\",\n \"branch_code\": \"QRLOSCY1\",\n \"postal_code\": \"0008\",\n \"email_address\": \"example@email.com\",\n \"account_number\": \"54466133\",\n \"account_holder_name\": \"Mannie Samantha\"\n },\n \"rid\": \"Mannie Samantha, Legros LLC Bank, 54466133, example@email.com, Atlanta Georgia, 0008, US\",\n \"reference\": null,\n \"state\": \"suspected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"created_at\": \"2024-10-28T13:19:05+02:00\",\n \"updated_at\": \"2024-10-28T13:19:07+02:00\",\n \"done_at\": null,\n \"created_via\": \"api\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"usd\",\n \"type\": \"fiat\",\n \"amount\": \"200.0\",\n \"fee\": \"60.0\",\n \"withdraw_data\": {\n \"city\": \"Atlanta Georgia\",\n \"country\": \"US\",\n \"bank_name\": \"Kuvalis, Smitham and Shanahan Bank\",\n \"branch_code\": \"XHNETKX1\",\n \"postal_code\": \"0008\",\n \"email_address\": \"example@email.com\",\n \"account_number\": \"17726324\",\n \"account_holder_name\": \"Mannie Samantha\"\n },\n \"rid\": \"Mannie Samantha, Kuvalis, Smitham and Shanahan Bank, 17726324, example@email.com, Atlanta Georgia, 0008, US\",\n \"reference\": null,\n \"state\": \"suspected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"created_at\": \"2024-10-28T13:18:32+02:00\",\n \"updated_at\": \"2024-10-28T13:18:34+02:00\",\n \"done_at\": null,\n \"created_via\": \"api\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n },\n {\n \"id\": \"TIDXXXXXXXXX\",\n \"sn\": \"SNXXXXXXXXXX\",\n \"snr\": null,\n \"currency\": \"eth\",\n \"type\": \"coin\",\n \"amount\": \"1.0\",\n \"fee\": \"0.0001\",\n \"blockchain_txid\": \"0x66e4fcfb9326788241da996412a1f357e5be1f0d6f5da50360880d924fccbf23\",\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"default rid\"\n },\n \"rid\": \"default rid\",\n \"reference\": \"Quae et et in labori\",\n \"state\": \"suspected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"created_at\": \"2024-10-28T09:32:06+02:00\",\n \"updated_at\": \"2024-10-28T09:32:08+02:00\",\n \"done_at\": null,\n \"created_via\": null,\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n }\n]"}],"_postman_id":"20cfdaa4-b435-4ba8-ba9e-db559ec02a0b"},{"name":"Clients","id":"1fbbe889-4fc8-4419-9e26-e1400e446784","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/broker/clients","description":"

Broker Endpoint:\nGet a list of clients and their respective account balances for a client in a broker profile

Broker Endpoint:\nGet a list of client saved beneficiaries in your broker profile

Unique SN of a client (Optional)

\n","type":"text/plain"},"key":"sn","value":"SNXXXXXXXX"},{"disabled":true,"description":{"content":"

Currency IDto filter on (Optional)

\n","type":"text/plain"},"key":"currency_id","value":"usdt"}],"variable":[]}},"response":[{"id":"05c87203-041a-42a9-b0ca-698ffb2090ce","name":"Clients Beneficiaries (New)","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/broker/clients_beneficiaries?sn=SNXXXXXXXX","host":["www.ovex.io"],"path":["api/v2","broker","clients_beneficiaries"],"query":[{"key":"sn","value":"SNXXXXXXXX","description":"Unique SN of a client OPTIONAL"},{"key":"currency_id","value":"usdt","description":"Currency id to filter on (Optional)","type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"beneficiary_id\": 5,\n \"sn\": \"SNXXXXXXXX\",\n \"email\": \"example@email.com\",\n \"name\": \"Savings Account\",\n \"currency_id\": \"zar\",\n \"withdraw_data\": {\n \"bank_name\": \"Example Bank\",\n \"branch_code\": \"00000\",\n \"account_number\": \"0123456789\",\n \"account_holder_name\": \"John Doe\"\n },\n \"rid\": \"John Doe, Example Bank, 0123456789, 00000\",\n \"network_name\": \"default\",\n \"reference_no\": null,\n \"confirmed\": true,\n \"default_carf_transfer_type\": null,\n \"default_carf_other_description\": null\n },\n {\n \"beneficiary_id\": 13,\n \"sn\": \"SNXXXXXXXX\",\n \"email\": \"example@email.com\",\n \"name\": \"Holiday Savings\",\n \"currency_id\": \"eth\",\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"0x0xxxxxxxxxxxxxxxxxxxxx\"\n },\n \"rid\": \"0x0xxxxxxxxxxxxxxxxxxxxx\",\n \"network_name\": \"ethereum\",\n \"reference_no\": null,\n \"confirmed\": false,\n \"default_carf_transfer_type\": null,\n \"default_carf_other_description\": null\n }\n]"}],"_postman_id":"4c0c5a7f-9dde-46a4-83a7-a82c8b232aa9"},{"name":"New Withdrawal","id":"deae6435-c759-46fb-ac64-50d6ea549a4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"www.ovex.io/api/v2/broker/withdraw?beneficiary_id=1&amount=100","description":"

Broker Endpoint:\nCreate a withdrawal for a client in your broker profile using a saved client beneficiary

Unique ID of a saved client beneficiary

\n","type":"text/plain"},"key":"beneficiary_id","value":"1"},{"description":{"content":"

Withdrawal amount (including withdrawal fees)

\n","type":"text/plain"},"key":"amount","value":"100"},{"disabled":true,"description":{"content":"

(Optional) CARF transfer type code for crypto withdrawals. Use GET /carf_transfer_types to list valid codes.

\n","type":"text/plain"},"key":"carf_transfer_type","value":"CARF601"},{"disabled":true,"description":{"content":"

(Optional) Free-text description when carf_transfer_type is 'Other' (CARF605).

\n","type":"text/plain"},"key":"carf_other_description","value":""}],"variable":[]}},"response":[{"id":"8bf798bf-a73c-49b1-ab4b-081215e5ae8b","name":"Coin Withdrawal (New)","originalRequest":{"method":"POST","header":[],"url":{"raw":"www.ovex.io/api/v2/broker/withdraw?beneficiary_id=12&amount=0.24","host":["www.ovex.io"],"path":["api/v2","broker","withdraw"],"query":[{"key":"beneficiary_id","value":"12","description":"Unique ID of a saved client beneficiary"},{"key":"amount","value":"0.24","description":"Withdrawal amount (including withdrawal fees)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"TID9AA7B31861\",\n \"sn\": \"SNE6EB217750\",\n \"snr\": null,\n \"currency\": \"eth\",\n \"type\": \"coin\",\n \"amount\": \"0.24\",\n \"fee\": \"0.0001\",\n \"blockchain_txid\": null,\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"0x0xxxxxxxxxxxxxxxxxxxxx\"\n },\n \"rid\": \"0x0xxxxxxxxxxxxxxxxxxxxx\",\n \"reference\": null,\n \"state\": \"rejected\",\n \"note\": \"Withdrawal risk error. Please contact support@ovex.io and quote the withdrawal TID (TID9AA7B31861) on this email.\",\n \"created_at\": \"2025-01-22T13:28:26+02:00\",\n \"updated_at\": \"2025-01-22T13:28:28+02:00\",\n \"done_at\": \"2025-01-22T13:28:28+02:00\",\n \"created_via\": \"api\",\n \"carf_transfer_type\": \"CARF601\",\n \"carf_other_description\": null\n}"},{"id":"4e3a637b-a2c0-49d0-9023-ad11145cab35","name":"Fiat Withdrawal (New)","originalRequest":{"method":"POST","header":[],"url":{"raw":"www.ovex.io/api/v2/broker/withdraw?beneficiary_id=5&amount=300","host":["www.ovex.io"],"path":["api/v2","broker","withdraw"],"query":[{"key":"beneficiary_id","value":"5","description":"Unique ID of a saved client beneficiary"},{"key":"amount","value":"300","description":"Withdrawal amount (including withdrawal fees)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"TIDAAE1DA5D21\",\n \"sn\": \"SN017EF9E009\",\n \"snr\": null,\n \"currency\": \"zar\",\n \"type\": \"fiat\",\n \"amount\": \"300.0\",\n \"fee\": \"60.0\",\n \"withdraw_data\": {\n \"bank_name\": \"Example Bank\",\n \"branch_code\": \"00000\",\n \"account_number\": \"0123456789\",\n \"account_holder_name\": \"John Doe\"\n },\n \"rid\": \"John Doe, Example Bank, 0123456789, 00000\",\n \"reference\": null,\n \"state\": \"rejected\",\n \"note\": \"Third party withdrawal detected. Please withdraw to your own account.\",\n \"created_at\": \"2025-01-22T13:45:43+02:00\",\n \"updated_at\": \"2025-01-22T13:45:44+02:00\",\n \"done_at\": \"2025-01-22T13:45:44+02:00\",\n \"created_via\": \"api\",\n \"carf_transfer_type\": null,\n \"carf_other_description\": null\n}"}],"_postman_id":"deae6435-c759-46fb-ac64-50d6ea549a4a"},{"name":"OTC Trades","id":"9655b63f-3bf1-40d5-9247-72d282d59867","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/broker/otc_trades","description":"

Broker Endpoint:\nGet a list of historic client OTC Trades for clients in your broker profile

Unique SN of a client

\n","type":"text/plain"},"key":"sn","value":"SNXXXXXXXX"},{"disabled":true,"description":{"content":"

Type: Integer\nDefault: 1\n(Optional)\nShows information on the given page number.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Type: Integer\nValues: 1 - 1000\nDefault: 50\n(Optional)\nThe amount of items to display on a page.

\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"

Type: ISO Formatted DateTime\n(Optional)\nStart datetime\nDefaults to 30 days ago if not passed

\n","type":"text/plain"},"key":"from","value":"2022-12-31T08:00:00+00:00"},{"disabled":true,"description":{"content":"

Type: ISO Formatted DateTime\n(Optional)\nEnd datetime\nDefaults to the current datetime if not passed

\n","type":"text/plain"},"key":"to","value":"2023-01-31T08:00:00+00:00"},{"disabled":true,"description":{"content":"

If set, returned trades will be sorted in specific order('desc' or 'asc'), default to 'desc'. OPTIONAL

\n","type":"text/plain"},"key":"order_by","value":"desc"},{"disabled":true,"description":{"content":"

Trade is RFQ(true) or not(false). OPTIONAL

\n","type":"text/plain"},"key":"rfq","value":"false"},{"disabled":true,"description":{"content":"

Type: String (Optional)\nIf set, returned data will be in specific format (json default).\nValues: [pdf csv]

\n","type":"text/plain"},"key":"alt_format","value":"csv"},{"disabled":true,"description":{"content":"

Type: Boolean (Optional)\nNest child trades under their parent trade. Only affects JSON content type. Affects pagination.\ndefault: true

\n","type":"text/plain"},"key":"nest_children","value":"true"}],"variable":[]}},"response":[{"id":"37ed5f5c-9f79-4052-b1d1-cfd9c9f46135","name":"OTC Trades (New)","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/broker/otc_trades?legacy=false","host":["www.ovex.io"],"path":["api/v2","broker","otc_trades"],"query":[{"key":"sn","value":"SNXXXXXXXX","description":"Unique SN of a client","disabled":true},{"key":"page","value":"1","description":"Type: Integer\nDefault: 1\n(Optional)\nShows information on the given page number.","disabled":true},{"key":"limit","value":"50","description":"Type: Integer\nValues: 1 - 1000\nDefault: 50\n(Optional)\nThe amount of items to display on a page.","disabled":true},{"key":"from","value":"2022-12-31T08:00:00+00:00","description":"Type: ISO Formatted DateTime\n(Optional)\nStart datetime\nDefaults to 30 days ago if not passed","disabled":true},{"key":"to","value":"2023-01-31T08:00:00+00:00","description":"Type: ISO Formatted DateTime\n(Optional)\nEnd datetime\nDefaults to the current datetime if not passed","disabled":true},{"key":"order_by","value":"desc","description":"If set, returned trades will be sorted in specific order('desc' or 'asc'), default to 'desc'. OPTIONAL","disabled":true},{"key":"rfq","value":"false","description":"Trade is RFQ(true) or not(false). OPTIONAL","disabled":true},{"key":"alt_format","value":"csv","description":"Type: String (Optional)\nIf set, returned data will be in specific format (json default).\nValues: [pdf csv]","disabled":true},{"key":"nest_children","value":"true","description":"Type: Boolean (Optional)\nNest child trades under their parent trade. Only affects JSON content type. Affects pagination.\ndefault: true","disabled":true},{"key":"legacy","value":"false","description":"Use legacy params and response"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"trades\": [\n {\n \"id\": \"TID3BB8F59A27\",\n \"sn\": \"SNA696628326\",\n \"from_currency\": \"usdc\",\n \"to_currency\": \"zar\",\n \"from_amount\": \"300.0\",\n \"to_amount\": \"5366.1\",\n \"rate\": \"17.887\",\n \"rate_is_from_currency\": false,\n \"fee\": \"0.0\",\n \"broker_fee_amount\": \"3.0\",\n \"status\": \"unconfirmed\",\n \"rfq\": false,\n \"created_at\": \"2023-06-22T18:15:38+02:00\",\n \"percentage_settled\": \"0.00%\"\n },\n {\n \"id\": \"TID2EF6D59A27\",\n \"sn\": \"SNA696628326\",\n \"from_currency\": \"usdc\",\n \"to_currency\": \"zar\",\n \"from_amount\": \"333.0\",\n \"to_amount\": \"5366.1\",\n \"rate\": \"17.887\",\n \"rate_is_from_currency\": false,\n \"fee\": \"0.0\",\n \"broker_fee_amount\": \"3.0\",\n \"status\": \"confirmed\",\n \"rfq\": false,\n \"created_at\": \"2023-06-22T18:15:38+02:00\",\n \"percentage_settled\": \"100.00%\"\n },\n {\n \"id\": \"TID16DC474335\",\n \"sn\": \"SNA696628326\",\n \"from_currency\": \"zar\",\n \"to_currency\": \"btc\",\n \"from_amount\": \"4332.0\",\n \"to_amount\": \"0.01312727\",\n \"rate\": \"330000.0\",\n \"rate_is_from_currency\": true,\n \"fee\": \"0.0\",\n \"broker_fee_amount\": \"12.0\",\n \"status\": \"partially_settled\",\n \"rfq\": false,\n \"created_at\": \"2023-06-22T18:13:00+02:00\",\n \"percentage_settled\": \"88.74%\",\n \"child_trades\": [\n {\n \"id\": \"TID16DC474335\",\n \"sn\": \"SNA696628326\",\n \"from_currency\": \"zar\",\n \"to_currency\": \"btc\",\n \"from_amount\": \"444.0\",\n \"to_amount\": \"0.00134545\",\n \"rate\": \"330000.0\",\n \"rate_is_from_currency\": true,\n \"fee\": \"0.0\",\n \"broker_fee_amount\": \"3.0\",\n \"status\": \"confirmed\",\n \"rfq\": false,\n \"created_at\": \"2023-06-22T18:13:00+02:00\",\n \"percentage_settled\": \"10.25%\"\n },\n {\n \"id\": \"TIDAA2DADE285\",\n \"sn\": \"SNA696628326\",\n \"from_currency\": \"zar\",\n \"to_currency\": \"btc\",\n \"from_amount\": \"900.0\",\n \"to_amount\": \"0.00272727\",\n \"rate\": \"330000.0\",\n \"rate_is_from_currency\": true,\n \"fee\": \"0.0\",\n \"broker_fee_amount\": \"3.0\",\n \"status\": \"confirmed\",\n \"rfq\": false,\n \"created_at\": \"2023-06-22T18:13:00+02:00\",\n \"percentage_settled\": \"20.78%\"\n },\n {\n \"id\": \"TID240340535B\",\n \"sn\": \"SNA696628326\",\n \"from_currency\": \"zar\",\n \"to_currency\": \"btc\",\n \"from_amount\": \"2500.0\",\n \"to_amount\": \"0.00757576\",\n \"rate\": \"330000.0\",\n \"rate_is_from_currency\": true,\n \"fee\": \"0.0\",\n \"broker_fee_amount\": \"3.0\",\n \"status\": \"confirmed\",\n \"rfq\": false,\n \"created_at\": \"2023-06-22T18:13:00+02:00\",\n \"percentage_settled\": \"57.71%\"\n },\n {\n \"id\": \"TID4A5942EEB4\",\n \"sn\": \"SNA696628326\",\n \"from_currency\": \"zar\",\n \"to_currency\": \"btc\",\n \"from_amount\": \"488.0\",\n \"to_amount\": \"0.00147879\",\n \"rate\": \"330000.0\",\n \"rate_is_from_currency\": true,\n \"fee\": \"0.0\",\n \"broker_fee_amount\": \"3.0\",\n \"status\": \"unconfirmed\",\n \"rfq\": false,\n \"created_at\": \"2023-06-22T18:13:00+02:00\",\n \"percentage_settled\": \"0.00%\"\n }\n ]\n }\n ],\n \"pagination\": {\n \"total\": \"3\",\n \"total_pages\": \"1\",\n \"limit\": \"50\",\n \"page\": \"1\",\n \"next_page\": \"\",\n \"prev_page\": \"\"\n }\n}"}],"_postman_id":"9655b63f-3bf1-40d5-9247-72d282d59867"},{"name":"Deposits","id":"f4b87fbe-7d9e-4a1b-935c-78a17e9d3879","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/broker/deposits?sn=SNXXXXXXXX&tid=TIDXXXXXXX¤cy=xxx","description":"

Broker Endpoint:\nGet a list of historic client deposits for clients in your broker profile

Unique SN of a client OPTIONAL

\n","type":"text/plain"},"key":"sn","value":"SNXXXXXXXX"},{"description":{"content":"

Unique TID of a withdrawal OPTIONAL

\n","type":"text/plain"},"key":"tid","value":"TIDXXXXXXX"},{"description":{"content":"

Currency symbol. e.g. (btc, zar etc.) OPTIONAL

\n","type":"text/plain"},"key":"currency","value":"xxx"},{"disabled":true,"description":{"content":"

Type: String (Optional)\nType of currency the withdraw belongs to.\nvalues [coin fiat]

\n","type":"text/plain"},"key":"currency_type","value":""}],"variable":[]}},"response":[{"id":"0c7d65ca-f833-4c70-bacd-30a914359009","name":"Success","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"D12345\",\n \"sn\": \"SN12345\",\n \"currency\": \"btc\",\n \"amount\": \"0.5\",\n \"txid\": \"abc123...\",\n \"state\": \"collected\",\n \"created_at\": \"2026-03-15T10:30:00Z\"\n }\n]"}],"_postman_id":"f4b87fbe-7d9e-4a1b-935c-78a17e9d3879"},{"name":"Get Quote","id":"ef1dda8a-8865-49d2-9aab-534a68af0c27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/broker/rfq/get_quote?market=btczar&from_amount=5000000&side=buy&to_amount=1&sn=SNXXXXXXXXXX&prefunded=0","description":"

Request for quote (RfQ). Get a strict all inclusive quote for trading between 2 currencies.

Specify a market e.g. (btczar, ethbtc, usdtzar, ethusdt)

Specify a 'side' of the market. e.g.('buy' btc with zar or 'sell' btc for ZAR)

Specify either a from_amount OR to_amount e.g.(side = buy, from_amount = x ZAR, to_amount = y BTC). NB: If both from_amount and to_amount are specified, from_amount is used for quoting.

Market for quote. Available markets depend on your client's jurisdiction, and can be found on the OVEX site.

\n","type":"text/plain"},"key":"market","value":"btczar"},{"description":{"content":"

Amount specified in input volume. E.g. (market = btczar, side = buy : from_amount is in zar. If side = sell, from_amount is in btc)

\n","type":"text/plain"},"key":"from_amount","value":"5000000"},{"description":{"content":"

Either 'buy or 'sell'. (Optional) Default: 'buy'

\n","type":"text/plain"},"key":"side","value":"buy"},{"description":{"content":"

Amount specified in output volume. E.g. (market = btczar, side = buy : to_amount is in btc. If side = sell, to_amount is in zar)

\n","type":"text/plain"},"key":"to_amount","value":"1"},{"description":{"content":"

Unique sn of a client

\n","type":"text/plain"},"key":"sn","value":"SNXXXXXXXXXX"},{"description":{"content":"

(Optional) Integer: 1 if immediate settlement, 0 if utilising Post Trade Settlement. Default: 0

\n","type":"text/plain"},"key":"prefunded","value":"0"},{"disabled":true,"description":{"content":"

(Optional) Integer: 1 to get an indicative price, 0 to get a trading price. Defaults to trading price [0] if available on the requested market.

\n","type":"text/plain"},"key":"indicative","value":"0"}],"variable":[]}},"response":[{"id":"36e51c9a-1034-45a0-b90c-d2f391a31592","name":"Success","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"quote_token\": \"eyJhbGciOiJIUzI1NiJ9...\",\n \"from_currency\": \"zar\",\n \"to_currency\": \"btc\",\n \"from_amount\": \"100000.0\",\n \"to_amount\": \"0.05\",\n \"rate\": \"2000000.0\",\n \"rate_is_from_currency\": true,\n \"fee\": \"0.1\",\n \"fee_currency\": \"zar\",\n \"expires_at\": \"2026-03-15T10:30:15Z\"\n}"}],"_postman_id":"ef1dda8a-8865-49d2-9aab-534a68af0c27"},{"name":"Accept Quote","id":"8d4187b0-7a7e-4fcb-a8b1-188bde2bc395","protocolProfileBehavior":{"disableUrlEncoding":true,"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"www.ovex.io/api/v2/broker/rfq/accept_quote?quote_token=xxxxxxxxxxxxxxxx","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}},"urlObject":{"path":["api/v2","broker","rfq","accept_quote"],"host":["www.ovex.io"],"query":[{"description":{"content":"

Unique token generated from requesting a quote obtained from the get_quote endpoint.

\n","type":"text/plain"},"key":"quote_token","value":"xxxxxxxxxxxxxxxx"}],"variable":[]}},"response":[{"id":"9a4d9a2e-e991-446f-8a21-dca050b7d036","name":"Success","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1234,\n \"from_currency\": \"zar\",\n \"to_currency\": \"btc\",\n \"from_amount\": \"100000.0\",\n \"to_amount\": \"0.05\",\n \"rate\": \"2000000.0\",\n \"fee\": \"0.1\",\n \"state\": \"confirmed\",\n \"created_at\": \"2026-03-15T10:30:00Z\",\n \"confirmed_at\": \"2026-03-15T10:30:05Z\"\n}"},{"id":"339d5303-6583-4252-a63c-50c946b9c3bf","name":"Quote Expired","originalRequest":{"header":[],"url":""},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Quote has expired\"\n}"}],"_postman_id":"8d4187b0-7a7e-4fcb-a8b1-188bde2bc395"},{"name":"Deposit Addresses","id":"c68673f4-0e82-43e5-9cce-4f5363dc76a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/broker/deposit_addresses?currency=btc&sn=SNXXXXXXXXXX","description":"

Broker Endpoint:\nGet a list of deposit addresses for clients per currency

Currency name. e.g. btc, eth, usdt.

\n","type":"text/plain"},"key":"currency","value":"btc"},{"description":{"content":"

Unique SN of a client

\n","type":"text/plain"},"key":"sn","value":"SNXXXXXXXXXX"}],"variable":[]}},"response":[{"id":"9f04d0de-5878-46bc-a114-a7bec1342589","name":"Success","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"deposit_address\": \"bc1q...\",\n \"blockchain\": {\n \"key\": \"btc-mainnet\",\n \"name\": \"Bitcoin\"\n }\n}"}],"_postman_id":"c68673f4-0e82-43e5-9cce-4f5363dc76a3"},{"name":"Fiat Deposit Accounts","id":"83278320-3554-43ed-9764-e0e97d28ccf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/broker/fiat_accounts","description":"

Broker Endpoint:\nGet fiat account deposit details (ZAR). NB: Deposit references must be client SN. Fiat deposits will not be allocated if an incorrect SN is provided with the bank transfer.

Broker Endpoint:\nGet a list of clients or a specific client's account balances.

Currency name. e.g. btc, eth, usdt. OPTIONAL

\n","type":"text/plain"},"key":"currency","value":"btc"},{"description":{"content":"

Unique SN of a client OPTIONAL

\n","type":"text/plain"},"key":"sn","value":"SNXXXXXXXXXX"}],"variable":[]}},"response":[{"id":"7ad3f6d4-f2ce-461c-8eec-5eafe95e4bda","name":"Success","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"currency\": \"btc\",\n \"balance\": \"0.5\",\n \"locked\": \"0.0\",\n \"deposit_address\": \"bc1q...\"\n },\n {\n \"currency\": \"zar\",\n \"balance\": \"50000.0\",\n \"locked\": \"0.0\",\n \"deposit_address\": null\n },\n {\n \"currency\": \"eth\",\n \"balance\": \"2.0\",\n \"locked\": \"0.0\",\n \"deposit_address\": \"0x...\"\n }\n]"}],"_postman_id":"82a0b785-0f8d-4f3d-84cf-0fe2bd28f5f0"},{"name":"Get OffShore transactions","id":"43a60315-fc15-4653-b114-e029ad50d182","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/broker/offshore_transactions?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}},"urlObject":{"path":["api/v2","broker","offshore_transactions"],"host":["www.ovex.io"],"query":[{"description":{"content":"

Optional

\n","type":"text/plain"},"key":"start_date","value":"YYYY-MM-DD"},{"description":{"content":"

Optional

\n","type":"text/plain"},"key":"end_date","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"ae11c082-8a64-4a20-b85e-5d506e24c7fe","name":"Success","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"43a60315-fc15-4653-b114-e029ad50d182"}],"id":"315bd970-b23c-4a64-9c86-ba06c56df656","description":"

Endpoints for OVEX brokers. Authorisation requirement: Your OVEX account must be assigned as a broker to a broker profile on OVEX.

\n","_postman_id":"315bd970-b23c-4a64-9c86-ba06c56df656","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"Ramps","item":[{"name":"Client","item":[{"name":"Client Create","event":[{"listen":"test","script":{"exec":["const jsonData = pm.response.json();","","if (pm.response.code === 201){ "," pm.collectionVariables.set('snr', jsonData.snr);","}"],"type":"text/javascript","id":"6c722d66-44e3-4661-96f1-40cc395102a5"}}],"id":"ea58fd4a-c300-4f31-a986-2dd8e0a911a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"ramps_reference_id","value":"90b6d29f-a3ef-4004-896e-94dac5c8cd03","description":"

Type: String\nThe ramps reference ID is a unique ID supplied by the member (you) for the client. It is used only as a reference.

\n","type":"text"},{"key":"default_currency","value":"USDC","description":"

Type: String\nValues: ZARP, USDT, USDC.\n(Optional)\nThe default currency will override the member's default ramp's currency. This currency only takes effect when the auto-settle feature is triggered.

\n","type":"text"},{"key":"instant_settlement","value":"true","description":"

Type: Boolean\nValues: true, false (Defaulted to false.) \nIf set to true, there will be no delay before the auto-settlement.

\n","type":"text"}]},"url":"www.ovex.io/api/v2/ramps/client/create","description":"

Creates a ramp client. An SNR is generated for the client and this will be their unchangeable, unique identifier.

Returns

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value	Type	Description
snr	\"SNRXXXXXXXX\" SNR[A-F0-9] {8}	String	SNR is a unique identifier created for the client. The client will quote the SNR when making deposits.

Responses

201 - Client created successfully.

400 - Ramps reference ID already exists.

500 - Error creating client.

Type: String\nValues: ZARP, USDT, USDC.\n(Optional)\nThis currency only takes effect when the auto-settle feature is triggered. If no default currency is set, then the member's default will be used.

\n","type":"text"},{"key":"instant_settlement","value":"true","description":"

Type: Boolean \nValues: true, false (Defaulted to false.) \nIf set to true, there will be no delay before the auto-settlement.

\n","type":"text"}]},"url":"www.ovex.io/api/v2/ramps/client/:snr","description":"

Changes/updates the client's default currency. If no default currency is set, then the client's default currency will mirror the member's.

Responses

200 - Default currency changed successfully.

404 - Client not found.

500 - Error updating ramps client.

The client's unique SNR returned in '/ramps/client/create'.

\n","type":"text/plain"},"type":"any","value":"SNRXXXXXXXX","key":"snr"}]}},"response":[{"id":"da2b6933-b559-4aee-ad0b-e0eea0a2ca3b","name":"Client Edit (Standard)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"default_currency","value":"USDT","description":"Type: String\nValues: ZARP, USDT, USDC.\n(Optional)\nThis currency only takes effect when the auto-settle feature is triggered. If no default currency is set, then the member's default will be used.","type":"text"}]},"url":{"raw":"www.ovex.io/api/v2/ramps/client/:snr","host":["www.ovex.io"],"path":["api/v2","ramps","client",":snr"],"variable":[{"key":"snr","value":"","description":"The client's unique SNR."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Update successful\",\n \"status\": 200\n}"}],"_postman_id":"124516ae-b56d-4079-88fe-374b4ef7bf03"},{"name":"Client Info","id":"236954f4-7b41-44ab-905b-34da1cd6d5f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"www.ovex.io/api/v2/ramps/client/:reference","description":"

Used to get the info of the client. :reference can either be the OVEX-generated SNR or the ramps_reference_id provided during client creation

Returns

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value	Type	Description
snr	\"SNRXXXXXXXX\"	String	Unique client reference generated by OVEX
ramps_reference_id	\"client1\"	String	The reference ID that was supplied on client creation.
default_currency	ZARP, USDT, USDC, null	String, null	The default currency used in auto-settlement. A null value means that the member's default currency will be used.
instant_settlement	true, false	Boolean	Whether the client is configured for instant or delayed settlement.
kyc_validated	true, false	Boolean	True when all client KYC information is provided and verified.
notes	\"\"	String	Any additional information about the client
created_at	\"2023-08-18T09:06:04+02:00\"	Datetime	ISO8601 formatted DateTime
updated_at	\"2023-08-18T09:06:04+02:00\"	Datetime	ISO8601 formatted DateTime

Responses

200 - Success.

404 - Client not found.

SNR (generated by OVEX) or ramps_reference_id provided during client creation

\n","type":"text/plain"},"type":"any","value":"","key":"reference"},{"id":"570458c3-e3d5-4f16-89db-9d894707bc58","type":"any","value":"SNRXXXXXXXX","key":"snr"}]}},"response":[{"id":"69427b21-79b6-49fa-bc96-eb1a63726b7d","name":"Client Info (Standard)","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/ramps/client/:reference","host":["www.ovex.io"],"path":["api/v2","ramps","client",":reference"],"variable":[{"key":"reference","value":"","description":"SNR (generated by OVEX) or ramps_reference_id provided during client creation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"snr\": \"SNRXXXXXXXX\",\n \"ramps_reference_id\": \"42538933-a3b5-481f-a8a8-9d0c44961b54\",\n \"default_currency\": \"zarp\",\n \"instant_settlement\": true,\n \"kyc_validated\": true,\n \"notes\": \"\",\n \"created_at\": \"2023-08-18T09:06:04+02:00\",\n \"updated_at\": \"2024-02-28T15:35:16+02:00\"\n}"}],"_postman_id":"236954f4-7b41-44ab-905b-34da1cd6d5f1"},{"name":"Client Deposit Details","id":"7091c15e-a255-40dc-85af-f178a3d62bc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"currency","value":"ZAR","description":"

Type: String\nValues: ZAR, NGN.\nThe currency of the deposit.

\n","type":"text"}]},"url":"www.ovex.io/api/v2/ramps/client/deposit_details/:snr","description":"

Used to get the deposit details for a client, given a currency. A list of addresses are returned.

Returns (List)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value	Type	Description
currency	ZAR	String	The deposit currency.
total_balance	0	Decimal	The total balance in the account.
available_balance	0	Decimal	The available balance in the account.
locked_balance	0	Decimal	The unavailable balance in the account.
deposit_details (refer below for more information)	[details_1, details_2]	List	List of different deposit details.

Deposit Details (Required)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value	Type	Description
bank	Bank Name	String	The bank to make the deposit to.
account_number	123456789	String	The account number to deposit to.
reference	SNRXXXXXXXX	String	The reference to include with your deposit.

Deposit Details (Additional Information - Optional)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value	Type	Description
recipient_name	OVEX	String	The recipient of the deposit.
bank_address	-	String	The bank's address.
swift_code	-	String	SWIFT code.
branch_code	-	String	The branch code.
account_type	-	String	The type of deposit account.
note	-	String	Any deposit notes.
iban	-	String	IBAN

Responses

200 - Success.

403 - Client is not KYC validated. Please submit KYC information.

404 - Client not found.

Type: String\nThe client's unique SNR.

\n","type":"text/plain"},"type":"any","value":"SNRXXXXXXXXX","key":"snr"}]}},"response":[{"id":"1767653a-4ae0-4b4e-82e8-9308c619acfa","name":"Client Deposit Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/ramps/client/deposit_details/:snr","host":["www","ovex","io"],"path":["api","v2","ramps","client","deposit_details",":snr"],"variable":[{"key":"snr","value":"SNRXXXXXXXXX","description":"Type: String\nThe client's unique SNR."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"currency\": \"zar\",\n \"total_balance\": \"282034.45\",\n \"available_balance\": \"282034.45\",\n \"locked_balance\": \"0.0\",\n \"fiat_details\": {\n \"recipient_name\": \"OVEX\",\n \"bank\": \"Standard Bank\",\n \"bank_address\": null,\n \"beneficiary_address\": null,\n \"swift_code\": null,\n \"account_number\": \"2342522\",\n \"branch_code\": \"123423\",\n \"account_type\": \"Current\",\n \"reference\": \"SNR52E07447\",\n \"note\": null,\n \"iban\": null\n },\n \"deposit_details\": [\n {\n \"recipient_name\": \"OVEX\",\n \"bank\": \"Standard Bank\",\n \"bank_address\": null,\n \"beneficiary_address\": null,\n \"swift_code\": null,\n \"account_number\": \"2342522\",\n \"branch_code\": \"123423\",\n \"account_type\": \"Current\",\n \"reference\": \"SNR52E07447\",\n \"note\": null,\n \"iban\": null\n }\n ]\n }\n]"}],"_postman_id":"7091c15e-a255-40dc-85af-f178a3d62bc3"},{"name":"Client KYC","id":"a5f35e6e-70e1-4e8b-9304-001aa41e3042","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"John","type":"text","description":"

Type: String\nClient's first name(s).

\n"},{"key":"last_name","value":"Doe","type":"text","description":"

Type: String\nClient's last name.

\n"},{"key":"email","value":"johndoe@gmail.com","type":"text","description":"

Type: String\nClient's email address.

\n"},{"key":"cell_number","value":"+27 781231234","type":"text","description":"

Type: String\nClient's cellphone number.\nFormat: +country_code number

\n"},{"key":"id_number","value":"5910107294723","type":"text","description":"

Type: String\nClient's ID number.

\n"},{"key":"id_type","value":"card","type":"text","description":"

Type: String\nValues: card, book.\nID document type.

\n"},{"key":"country_code","value":"ZA","type":"text","description":"

Type: String\nA 2-letter uppercase country code (ISO 3166-1 alpha-2) e.g. ZA.

\n"},{"key":"id_document","type":"file","description":"

Type: File\nFront image/pdf of the client's ID document.

\n","value":null},{"key":"id_document_back","type":"file","description":"

Type: File\n(Required if 'id_type' is 'card')\nBack image/pdf of the client's ID document.

\n","value":null},{"key":"proof_of_address","type":"file","description":"

Type: File\nImage/PDF of the client's proof of address.

\n","value":null},{"key":"selfie","type":"file","description":"

Type: File\nImage/PDF of a selfie of the client.

\n","value":null},{"key":"bvn","value":"12345678901","description":"

Type: String\n(Required if country code is NG.)\nThe bank verification Number (BVN)

\n","type":"text","disabled":true}]},"url":"www.ovex.io/api/v2/ramps/client/kyc/:snr","description":"

Used to submit the KYC information and documentation. The information does not need to be sent all at once, however, the KYC can only be verified once all the information is provided.

A 206 response will be sent on partial field acceptance, and a 200 once all fields are completed.

Note: An ID type of 'card' requires both the front and back of the document and 'book' requires only the front.

Responses

200 - All KYC information has been submitted.

206 - Missing fields: {list of fields still requiring information}.

404 - Client not found.

500 - Error creating ramps client info profile.

The client's unique SNR returned in '/ramps/client/create'.

\n","type":"text/plain"},"type":"any","value":"SNRXXXXXXXX","key":"snr"}]}},"response":[{"id":"cfb582b1-ce5a-49dc-b50e-b15ef9d36785","name":"Client KYC (Completed)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"John","type":"text","description":"Type: String\n(Optional)\nClient's first name(s)."},{"key":"last_name","value":"Doe","type":"text","description":"Type: String\n(Optional)\nClient's last name."},{"key":"email","value":"johndoe@gmail.com","type":"text","description":"Type: String\nClient's email address."},{"key":"cell_number","value":"0781231234","type":"text","description":"Type: String\nClient's cellphone number."},{"key":"id_number","value":"5910107294723","type":"text","description":"Type: String\nClient's ID number."},{"key":"id_type","value":"card","type":"text","description":"Type: String\nValues: card, book.\nID document type."},{"key":"country_code","value":"ZA","type":"text","description":"Type: String\nA 2-letter uppercase country code (ISO 3166-1 alpha-2) e.g. ZA."},{"key":"id_document","type":"file","description":"Type: File\nFront image/pdf of the client's ID document.","src":["cf7osv7lX/fake-id-front.jpg"]},{"key":"id_document_back","type":"file","description":"Type: File\n(Required if 'id_type' is 'card')\nBack image/pdf of the client's ID document.","src":["E6UNWWqeX/fake-id-back.jpg"]},{"key":"proof_of_address","type":"file","description":"Type: File\nImage/PDF of the client's proof of address.","src":["C553JH5pM/fake-proof-of-address.jpg"]},{"key":"selfie","type":"file","description":"Type: File\nImage/PDF of a selfie of the client.","src":["MM-OBKVqr/fake-selfie.jpg"]}]},"url":{"raw":"www.ovex.io/api/v2/v2/ramps/client/kyc/:snr","host":["www","ovex","io"],"path":["api","v2","v2","ramps","client","kyc",":snr"],"variable":[{"key":"snr","value":"SNRXXXXXXXX","description":"The client's unique SNR."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"All KYC information has been submitted.\",\n \"status\": 200\n}"},{"id":"c4bbeabd-a5f2-458e-aaa9-1e1942158239","name":"Client KYC (Partial)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"John","type":"text","description":"Type: String\n(Optional)\nClient's first name(s)."},{"key":"last_name","value":"Doe","type":"text","description":"Type: String\n(Optional)\nClient's last name."},{"key":"email","value":"johndoe@gmail.com","type":"text","description":"Type: String\nClient's email address."},{"key":"cell_number","value":"0781231234","type":"text","description":"Type: String\nClient's cellphone number."},{"key":"id_number","value":"5910107294723","type":"text","description":"Type: String\nClient's ID number."},{"key":"id_type","value":"card","type":"text","description":"Type: String\nValues: card, book.\nID document type.","disabled":true},{"key":"country_code","value":"ZA","type":"text","description":"Type: String\nA 2-letter uppercase country code (ISO 3166-1 alpha-2) e.g. ZA.","disabled":true},{"key":"id_document","type":"file","description":"Type: File\nFront image/pdf of the client's ID document.","src":[],"disabled":true},{"key":"id_document_back","type":"file","description":"Type: File\n(Required if 'id_type' is 'card')\nBack image/pdf of the client's ID document.","src":[],"disabled":true},{"key":"proof_of_address","type":"file","description":"Type: File\nImage/PDF of the client's proof of address.","src":[],"disabled":true},{"key":"selfie","type":"file","description":"Type: File\nImage/PDF of a selfie of the client with their ID document visible.","src":[],"disabled":true}]},"url":{"raw":"www.ovex.io/api/v2/v2/ramps/client/kyc/:snr","host":["www.ovex.io"],"path":["api/v2","v2","ramps","client","kyc",":snr"],"variable":[{"key":"snr","value":"SNRXXXXXXXX","description":"The client's unique SNR."}]}},"status":"Partial Content","code":206,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing fields: id_type, country_code, id_document, id_document_back, proof_of_address, selfie\",\n \"status\": 206\n}"}],"_postman_id":"a5f35e6e-70e1-4e8b-9304-001aa41e3042"}],"id":"cf3066b2-bd1f-4040-9e41-c3d6522a2c92","description":"

The client API allows the member to:

Create a ramps client.
Update the client's default currency.
Retrieve the client info.
Provide KYC information and documentation.

Authentication is required for all client requests.

\n","_postman_id":"cf3066b2-bd1f-4040-9e41-c3d6522a2c92","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"On Ramp","item":[{"name":"Get Estimate","id":"026bff55-056a-4494-9c28-588be1096dcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"key":"from_amount","value":"100000","type":"text","description":"

Type: Big Decimal\nFrom amount.

\n"},{"key":"from_currency","value":"ZAR","type":"text","description":"

Type: String\nValue: ZAR\nFrom currency.

\n"},{"key":"to_currency","value":"USDC","type":"text","description":"

Type: String\nValues: ZARP, USDT, USDC\nTo currency.

\n"}]},"url":"www.ovex.io/api/v2/ramps/onramp/get_estimate","description":"

Get a trade estimate for an on ramp deposit.

Returns

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value	Type	Description
amount	15000	String	The estimated amount given the trade parameters.

Responses

200 - Reminder: This is an estimate only. The final amount may vary.

403 - Invalid order.

Type: String\nThe client's unique SNR.

\n","type":"text"},{"key":"tid","value":"TID1234512345","description":"

Type: String\nThe TID confirming the deposit. (Sent via webhook. Accessible via 'deposits history' endpoint.)

\n","type":"text"},{"key":"to_currency","value":"USDC","description":"

Type: String\nValues: ZARP, USDT, USDC.\nTo currency for conversion.

\n","type":"text"},{"key":"sig","value":"{{sig}}","description":"

Type: String\nA hex encryption of the payload as explained in Ramps.

\n","type":"text"}]},"url":"www.ovex.io/api/v2/ramps/onramp/settle","description":"

(Optional)
When the on ramp deposit is received (with SNR as the deposit reference), a webhook will be sent with the deposit details as well as the TID. (See Ramps /webhooks)

The auto-settle feature will trigger if this API is not used. (Currently, 15 minutes after the deposit is approved.)

Making a request to this API will override the auto-settlement.

Note:

The client must be fully KYC verified to settle the deposit.
\n
Requires a sig parameter. This is an encrypted hex string of the payload. The sig is generated by creating a SHA256 HMAC hash of the payload using your Ramps Secret Key. The secret key is provided when we enable ramps for your profile.
\n
Requires a Http-Idempotency-Key header. This value is a 32-character UUID. Every request is validated against the uniqueness of this value.
\n

Returns

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value	Type	Description
from_currency	ZAR	String	Onramp from currency.
to_currency	ZARP	String	Onramp to currency.
from_amount	10000	String	From amount.
to_amount	10000	String	Final to amount.
rate	1.0	String	The rate for the trade.
tid	TID12345678	String	TID of the trade from ZAR to selected coin. (Note: This is different to the deposit TID)
settlement_type	api_ramps	String	API or auto-settlement.

Responses

201 - Settle successful.

403 - {Error message}

Get consolidated history of all on ramp transactions for your account, with the ability to filter by external client SNR. Useful to validate data received via webhooks. Note that a maximum of 1000 records will be returned per call.

Unique SNR of external client. OPTIONAL

\n","type":"text/plain"},"key":"snr","value":"SNRXXXXXXXX"},{"disabled":true,"description":{"content":"

DateTime to start search. Default 30 days before 'to' date. OPTIONAL

\n","type":"text/plain"},"key":"from","value":"2024-01-31T00:00:00+00:00"},{"disabled":true,"description":{"content":"

DateTime to end search. Default to now. OPTIONAL

\n","type":"text/plain"},"key":"to","value":"2024-02-28T00:00:00+00:00"},{"disabled":true,"description":{"content":"

If set, returned trades will be sorted in specific order('desc' or 'asc'), default to 'desc'. OPTIONAL

\n","type":"text/plain"},"key":"order_by","value":"desc"},{"disabled":true,"description":{"content":"

Page number (defaults to 1). OPTIONAL

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Limit the number of returned transactions. Default to 1000. OPTIONAL

\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"996b1d9a-6eb3-44ec-b852-72187acbd5e8","name":"Transactions (Standard)","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/ramps/onramp/transactions","host":["www.ovex.io"],"path":["api/v2","ramps","onramp","transactions"],"query":[{"key":"snr","value":"SNRXXXXXXXX","description":"Unique SNR of external client. OPTIONAL","disabled":true},{"key":"from","value":"2024-10-01T00:00:00+00:00","description":"DateTime to start search. Default 30 days before 'to' date. OPTIONAL","disabled":true},{"key":"to","value":"2024-10-01T00:00:00+00:00","description":"DateTime to end search. Default to now. OPTIONAL","disabled":true},{"key":"order_by","value":"desc","description":"If set, returned trades will be sorted in specific order('desc' or 'asc'), default to 'desc'. OPTIONAL","disabled":true},{"key":"page","value":"1","description":"Page number (defaults to 1). OPTIONAL","disabled":true},{"key":"limit","value":"50","description":"Limit the number of returned transactions. Default to 1000. OPTIONAL","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"onramp_transactions\": [\n {\n \"tid\": \"TID5440A04711\",\n \"snr\": \"SNRYYYYYYYY\",\n \"from_currency\": \"zar\",\n \"from_amount\": \"999.0\",\n \"to_currency\": \"zarp\",\n \"to_amount\": \"999.0\",\n \"market_rate\": \"1.0\",\n \"status\": \"confirmed\",\n \"created_at\": \"2024-04-02T10:52:47+02:00\",\n \"updated_at\": \"2024-04-02T10:52:47+02:00\",\n \"deleted\": false,\n \"deposit\": {\n \"tid\": \"TIDD5280E4D38\",\n \"snr\": \"SNRYYYYYYYY\",\n \"currency\": \"zar\",\n \"amount\": \"999.0\",\n \"fee\": \"0.0\",\n \"completed_at\": \"2024-04-02T10:52:46+02:00\",\n \"state\": \"accepted\",\n \"created_at\": \"2024-04-02T10:48:44+02:00\",\n \"updated_at\": \"2024-04-02T10:52:48+02:00\"\n }\n },\n {\n \"tid\": \"TIDB94F1D5486\",\n \"snr\": \"SNRXXXXXXXX\",\n \"from_currency\": \"zar\",\n \"from_amount\": \"1002.0\",\n \"to_currency\": \"zarp\",\n \"to_amount\": \"1002.0\",\n \"market_rate\": \"1.0\",\n \"status\": \"confirmed\",\n \"created_at\": \"2024-04-02T09:29:06+02:00\",\n \"updated_at\": \"2024-04-02T09:29:06+02:00\",\n \"deleted\": false,\n \"deposit\": {\n \"tid\": \"TIDCE68582CBD\",\n \"snr\": \"SNRXXXXXXXX\",\n \"currency\": \"zar\",\n \"amount\": \"1002.0\",\n \"fee\": \"0.0\",\n \"completed_at\": \"2024-04-02T09:29:04+02:00\",\n \"state\": \"accepted\",\n \"created_at\": \"2024-04-02T09:29:03+02:00\",\n \"updated_at\": \"2024-04-02T09:29:06+02:00\"\n }\n },\n {\n \"tid\": \"TIDD813B9ECCD\",\n \"snr\": \"SNRXXXXXXXX\",\n \"from_currency\": \"zar\",\n \"from_amount\": \"1001.0\",\n \"to_currency\": \"zarp\",\n \"to_amount\": \"1001.0\",\n \"market_rate\": \"1.0\",\n \"status\": \"unconfirmed\",\n \"created_at\": \"2024-04-02T09:24:57+02:00\",\n \"updated_at\": \"2024-04-02T09:27:15+02:00\",\n \"deleted\": true,\n \"deleted_at\": \"2024-04-02T09:27:15+02:00\",\n \"reason_for_delete\": \"Trade Unconfirmed\",\n \"deposit\": {\n \"tid\": \"TIDB7B5698C54\",\n \"snr\": \"SNRXXXXXXXX\",\n \"currency\": \"zar\",\n \"amount\": \"1001.0\",\n \"fee\": \"0.0\",\n \"completed_at\": \"2024-04-02T09:24:55+02:00\",\n \"state\": \"rejected\",\n \"created_at\": \"2024-03-28T11:53:54+02:00\",\n \"updated_at\": \"2024-04-02T09:24:57+02:00\"\n }\n }\n ],\n \"pagination\": {\n \"total\": \"3\",\n \"total_pages\": \"1\",\n \"limit\": \"1000\",\n \"page\": \"1\",\n \"next_page\": \"\",\n \"prev_page\": \"\"\n }\n}"}],"_postman_id":"e019725f-3997-4f21-a5ed-7b3060c8a442"}],"id":"2a22c922-0141-419e-85a9-982312a662be","description":"

On ramp is the purchasing of crypto with fiat. Currently on ramp only allows for ZAR fiat to ZARP, USDT, or USDC crypto.

The on ramp process:

It is strongly advised that the client is fully KYC verified before attempting to on ramp.
The on ramp process is initiated when a deposit with a SNR as the deposit reference is received by Ovex.
The client's deposit can only be processed if they are fully KYC verified.
A Webhook will be sent out verifying the acceptance of the deposit. (See Ramps /webhooksfor help setting up.)
The member can decide to on ramp the deposit by either:
1. Waiting 15 minutes for the auto-settlement feature. (Webhook confirmation when complete)
2. Utilizing /ramps/onramp/settle to immediately on ramp the deposit.
\n

Authentication is required for all on ramp requests.

Note: There is no quote for on ramp, however, there is a quote estimate. The actual rate will be calculated when settling the on ramp deposit.

\n","_postman_id":"2a22c922-0141-419e-85a9-982312a662be","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"Off Ramp","item":[{"name":"Get Quote","event":[{"listen":"test","script":{"exec":["const jsonData = pm.response.json();","","if (pm.response.code === 200){ "," pm.collectionVariables.set('quote_token', jsonData.quote_token);","}"],"type":"text/javascript","id":"65e3c98e-596d-4173-9912-dfecae821cd7"}}],"id":"ae16436f-a7f8-4814-8fd8-dab599037033","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"from_amount","value":"1000","type":"text","description":"

Type: Big Decimal\nFrom amount.

\n"},{"key":"from_currency","value":"USDC","type":"text","description":"

Type: String\nValues: ZARP, USDT, USDC.\nFrom currency.

\n"},{"key":"to_currency","value":"ZAR","type":"text","description":"

Type: String\nValues: ZAR\nTo currency.

\n"}]},"url":"www.ovex.io/api/v2/ramps/offramp/get_quote","description":"

Creates a quote token which is required for /ramps/offramp/accept_quote.The token contains the information for the trade and expires after a few seconds. (<10 seconds)

Returns

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value	Type	Description
market	zarp/zar	String	The market of the trade.
from_currency	zar	String	Off ramp from currency.
from_amount	10000	String	From amount.
to_currency	zarp	String	Off ramp to currency.
to_amount	10000	String	Final to amount.
market_rate	1.0	String	The rate for the trade.
rate_is_from_currency	false	Boolean	False for an off ramp.
requested_at	1692196316	Float	Requested time as a Unix timestamp.
expires_at	1692196326	Float	Expiry time as a Unix timestamp.
quote_token	nb1OJDUibUUcKXwR	String	Token required for `/ramps/offramp/accept_quote.`

Responses

200 - Success.

403 - Invalid order.

Type: String\nName of the account holder for the withdrawal.

\n"},{"key":"bank_name","value":"ABC Bank","type":"text","description":"

Type: String\nThe bank's name.

\n"},{"key":"account_number","value":"123456789","type":"text","description":"

Type: String\nThe account number.

\n"},{"key":"branch_code","value":"112233","type":"text","description":"

Type: String\nThe branch code.

\n"},{"key":"snr","value":"SNRA74A54CF","type":"text","description":"

Type: String\nThe client's unique SNR.

\n"},{"key":"quote_token","value":"","type":"text","description":"

Type: String\nThe quote_token returned from '/ramps/offramp/get_quote'.

\n"},{"key":"sig","value":"{{sig}}","type":"text","description":"

Type: String\nA hex encryption of the payload as explained in Ramps.

\n"}]},"url":"www.ovex.io/api/v2/ramps/offramp/accept_quote","description":"

To accept a quote make sure to do the following.

Use the quote token that is returned by /ramps/offramp/get_quote to lock in the trade for the off ramp withdrawal.
Requires a sig parameter. This is an encrypted hex string of the payload. The sig is generated by creating a SHA256 HMAC hash of the payload using your Ramps Secret Key. The secret key is provided when we enable ramps for your profile.
Requires a Http-Idempotency-Key header. This value is a 32-character UUID. Every request is validated against the uniqueness of this value.

Returns

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value	Type	Description
id	TID123456	String	Unique trade ID.
from_currency	zar	String	Onramp from currency.
from_amount	10000	String	From amount.
to_currency	zarp	String	Onramp to currency.
to_amount	10000	String	To amount after rate conversion.
rate	1.0	String	The rate for the trade.
nett_withdrawal	9900.00	String	The final amount of the off-ramp withdrawal.
fee	100.00	String	The off-ramp fee for the withdrawal.

Responses

201 - Success, quote accepted.

400 - {Error accepting quote reason.}

403 - Client not verified. Ensure all KYC information is provided.

403 - Invalid Idempotency. / Invalid quote token.

404 - Client not found.

Get consolidated history of all off ramp transactions for your account, with the ability to filter by external client SNR. Useful to validate data received via webhooks. Note that a maximum of 1000 records will be returned per call.

Unique SNR of external client. OPTIONAL

\n","type":"text/plain"},"key":"snr","value":"SNRXXXXXXXX"},{"disabled":true,"description":{"content":"

DateTime to start search. Default 30 days before 'to' date. OPTIONAL

\n","type":"text/plain"},"key":"from","value":"2024-01-31T00:00:00+00:00"},{"disabled":true,"description":{"content":"

DateTime to end search. Default to now. OPTIONAL

\n","type":"text/plain"},"key":"to","value":"2024-02-28T00:00:00+00:00"},{"disabled":true,"description":{"content":"

If set, returned trades will be sorted in specific order('desc' or 'asc'), default to 'desc'. OPTIONAL

\n","type":"text/plain"},"key":"order_by","value":"desc"},{"disabled":true,"description":{"content":"

Page number (defaults to 1). OPTIONAL

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Limit the number of returned transactions. Default to 1000. OPTIONAL

\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"645f5720-91ce-4f26-b716-447bda3212a8","name":"Transactions (Standard)","originalRequest":{"method":"GET","header":[],"url":{"raw":"www.ovex.io/api/v2/ramps/offramp/transactions","host":["www.ovex.io"],"path":["api/v2","ramps","offramp","transactions"],"query":[{"key":"snr","value":"SNRXXXXXXXX","description":"Unique SNR of external client. OPTIONAL","disabled":true},{"key":"from","value":"2024-01-31T00:00:00+00:00","description":"DateTime to start search. Default 30 days before 'to' date. OPTIONAL","disabled":true},{"key":"to","value":"2024-02-28T00:00:00+00:00","description":"DateTime to end search. Default to now. OPTIONAL","disabled":true},{"key":"order_by","value":"desc","description":"If set, returned trades will be sorted in specific order('desc' or 'asc'), default to 'desc'. OPTIONAL","disabled":true},{"key":"page","value":"1","description":"Page number (defaults to 1). OPTIONAL","disabled":true},{"key":"limit","value":"50","description":"Limit the number of returned transactions. Default to 1000. OPTIONAL","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"offramp_transactions\": [\n {\n \"tid\": \"TIDC72FA9C6E8\",\n \"snr\": \"SNR22ABBB33\",\n \"from_currency\": \"usdc\",\n \"from_amount\": \"100.0\",\n \"to_currency\": \"zar\",\n \"to_amount\": \"1577.95\",\n \"market_rate\": \"15.7795162\",\n \"status\": \"confirmed\",\n \"created_at\": \"2025-01-28T09:24:23+02:00\",\n \"updated_at\": \"2025-01-28T09:33:27+02:00\",\n \"deleted\": false,\n \"withdraw\": {\n \"tid\": \"TIDB5E03AB91B\",\n \"snr\": null,\n \"currency\": \"eth\",\n \"amount\": \"0.015\",\n \"fee\": \"0.0001\",\n \"recipient_details\": {\n \"crypto_wallet_address\": \"0x0xxxxxxxxxxxxxxxxxxxxx\"\n },\n \"recipient\": \"0x0xxxxxxxxxxxxxxxxxxxxx\",\n \"status\": \"suspected\",\n \"note\": \"Automated account reconciliation mismatch\",\n \"completed_at\": null,\n \"created_at\": \"2025-01-24T16:44:02+02:00\",\n \"updated_at\": \"2025-01-28T09:34:34+02:00\"\n }\n },\n {\n \"tid\": \"TID0BB988659E\",\n \"snr\": \"SNR22ABBB33\",\n \"from_currency\": \"usdc\",\n \"from_amount\": \"100.0\",\n \"to_currency\": \"zar\",\n \"to_amount\": \"1582.26\",\n \"market_rate\": \"15.82262974\",\n \"status\": \"unconfirmed\",\n \"created_at\": \"2025-01-24T17:08:21+02:00\",\n \"updated_at\": \"2025-01-24T17:08:21+02:00\",\n \"deleted\": false\n },\n {\n \"tid\": \"TIDD0A06A96A7\",\n \"snr\": \"SNR22ABBB33\",\n \"from_currency\": \"usdc\",\n \"from_amount\": \"100.0\",\n \"to_currency\": \"zar\",\n \"to_amount\": \"1580.05\",\n \"market_rate\": \"15.80049597\",\n \"status\": \"unconfirmed\",\n \"created_at\": \"2025-01-24T13:56:32+02:00\",\n \"updated_at\": \"2025-01-24T13:56:32+02:00\",\n \"deleted\": false\n },\n {\n \"tid\": \"TID77F2B67548\",\n \"snr\": \"SNR22ABBB33\",\n \"from_currency\": \"usdc\",\n \"from_amount\": \"100.0\",\n \"to_currency\": \"zar\",\n \"to_amount\": \"1577.32\",\n \"market_rate\": \"15.77320699\",\n \"status\": \"unconfirmed\",\n \"created_at\": \"2025-01-24T13:45:39+02:00\",\n \"updated_at\": \"2025-01-24T13:45:39+02:00\",\n \"deleted\": false\n }\n ],\n \"pagination\": {\n \"total\": \"4\",\n \"total_pages\": \"1\",\n \"limit\": \"1000\",\n \"page\": \"1\",\n \"next_page\": \"\",\n \"prev_page\": \"\"\n }\n}\n"}],"_postman_id":"a201ebd0-c99f-4645-b823-4a5d2053b501"}],"id":"8d913250-4133-47c9-8645-4e3caba11a6c","description":"

Off ramp is the purchasing of fiat with crypto. Currently, off ramp supports ZARP, USDT, or USDC crypto to ZAR fiat.

The quote_token returned in the response of /ramps/offramp/get_quote must be passed to /ramps/offramp/accept_quote. This token contains the details of the trade.

The off ramp process:

A client's off ramp withdrawal can only be processed if they are fully KYC verified.
Obtain a quote token. There is no obligation to act upon this quote.
Accept the quote using the client's SNR and quote token.
A Webhook will be sent out verifying the off ramp withdrawal status. (See Ramps /webhooksfor help setting up.)

Authentication is required for all off ramp requests.

\n","_postman_id":"8d913250-4133-47c9-8645-4e3caba11a6c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Available Subscriptions","event":[{"listen":"test","script":{"exec":["pm.test(\"response should be okay to process\", function () {"," pm.response.to.not.be.error;"," // pm.response.to.have.jsonBody(response);"," pm.response.to.not.have.jsonBody(\"error\");","});","","pm.test(\"response must be valid and have a body\", function () {"," pm.response.to.be.ok;"," pm.response.to.be.withBody;"," pm.response.to.be.json;","});","","pm.test(\"status test\", function() {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"5b359062-97a7-48ce-acfc-ba9c21a6f164"}}],"id":"f4fdc039-e0a7-415b-9220-4fe9c31fe17f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"www.ovex.io/api/v2/webhook/available_subscriptions","description":"

Returns all events that a client can subscribe to.

\n","urlObject":{"path":["api/v2","webhook","available_subscriptions"],"host":["www.ovex.io"],"query":[],"variable":[]}},"response":[{"id":"d6e7fe40-15a2-4ce3-a62f-a4673ea68c21","name":"Available Subscriptions","originalRequest":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/webhook/available_subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Host","value":"www.ovex.io"},{"key":"X-Forwarded-Host","value":"www.ovex.io"},{"key":"X-Forwarded-Port","value":"443"},{"key":"X-Forwarded-Proto","value":"https"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"event_name\": \"offramp.state_change\"\n },\n {\n \"event_name\": \"settlement.complete\"\n },\n {\n \"event_name\": \"deposit.received\"\n },\n {\n \"event_name\": \"external_client.state_change\"\n }\n]"}],"_postman_id":"f4fdc039-e0a7-415b-9220-4fe9c31fe17f"},{"name":"Subscribe","event":[{"listen":"test","script":{"exec":["pm.test(\"response should be okay to process\", function () {"," pm.response.to.not.be.error;"," pm.response.to.have.jsonBody(response);"," pm.response.to.not.have.jsonBody(\"error\");","});","","pm.test(\"response must be valid and have a body\", function () {"," pm.response.to.be.ok;"," pm.response.to.be.withBody;"," pm.response.to.be.json;","});","","pm.test(\"status test\", function() {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"c0978748-d28d-4c28-bf7d-7b451bb7ffa0"}}],"id":"1fabdf82-4713-4f08-87e7-fc57b41f6f72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"event_name","value":"deposit.received","description":"

The event you are subscribing to.

\n","type":"text"},{"key":"url","value":"https://yourdomain.com/webhook-endpoint","description":"

The URL post requests are going to be sent to

\n","type":"text"}]},"url":"www.ovex.io/api/v2/webhook/subscribe","description":"

Used to subscribe to a webhook event. Use the GET webhook/available_subscriptions endpoint to get all available events.

Response statuses.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response status	Description
SUCCESS	Request was successful.
FAILED	An error occurred while trying to save the subscription. Contact support if this happens.
EVENT_NOT_FOUND	Provided event name is invalid. Get name from from endpoint provided above.
SUBSCRIPTION_ALREADY_ENABLED	User already enabled the subscription.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}},"urlObject":{"path":["api/v2","webhook","subscribe"],"host":["www.ovex.io"],"query":[],"variable":[]}},"response":[{"id":"32c69e33-e40d-4817-9635-0848a442b59e","name":"Successful subscription","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"event_name","value":"String","description":"The event you are subscribing to.","type":"text"},{"key":"url","value":"String","description":"The URL post requests are going to be sent to.","type":"text"}]},"url":"www.ovex.io/api/v2/webhook/subscribe"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Authorization","value":"Bearer xxxxxx"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"subscription_id\": \"E156EB60-39EA-46B8-ACC8-EC2415FCC6E8\"\n}"},{"id":"00e3a5ad-2bc5-4e1c-9ae0-3676075f0cd9","name":"Unsuccessful subscription","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"event_name","value":"incorrect.state","description":"The event you are subscribing to.","type":"text"},{"key":"url","value":"https://example.com/ovex_subcsriptions","description":"The URL post requests are going to be sent to.","type":"text"}]},"url":"www.ovex.io/api/v2/webhook/subscribe"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Authorization","value":"Bearer xxxxxx"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"EVENT_NOT_FOUND\",\n \"subscription_id\": \"\"\n}"}],"_postman_id":"1fabdf82-4713-4f08-87e7-fc57b41f6f72"},{"name":"Unsubscribe","event":[{"listen":"test","script":{"exec":["pm.test(\"response should be okay to process\", function () {"," pm.response.to.not.be.error;"," pm.response.to.have.jsonBody(response);"," pm.response.to.not.have.jsonBody(\"error\");","});","","pm.test(\"response must be valid and have a body\", function () {"," pm.response.to.be.ok;"," pm.response.to.be.withBody;"," pm.response.to.be.json;","});","","pm.test(\"status test\", function() {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"ea7a1aae-3b67-4db1-a419-c1c9a62548f0"}}],"id":"14c4ee3e-6a15-4b09-9d7e-5df74c7fc771","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"subscription_id","value":"String","description":"

Webhook subscription ID.

\n","type":"text"}]},"url":"www.ovex.io/api/v2/webhook/unsubscribe","description":"

Endpoint to unsubscribe from a specific webhook event using the subscription_id. The subscription_id is returned in the response when subscribing to the webhook. Alternatively, use Get /active_subscriptions to get the subscription_id associated with each of your webhook subscriptions.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}},"urlObject":{"path":["api/v2","webhook","unsubscribe"],"host":["www.ovex.io"],"query":[],"variable":[]}},"response":[{"id":"538511b8-2464-45d1-8440-01cf6f1df245","name":"Successful Unsubscription","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"subscription_id","value":"E156EB60-39EA-46B8-ACC8-EC2415FCC6E8","description":"The event subscription ID ","type":"text"}]},"url":{"raw":"www.ovex.io/api/v2/webhook/unsubscribe","host":["www.ovex.io"],"path":["api/v2","webhook","unsubscribe"],"query":[{"key":"","value":null,"disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Accept","value":"*/*"},{"key":"Accept-Encoding","value":"gzip, deflate, br"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, PATCH, DELETE"},{"key":"Authorization","value":"Bearer xxxxxxx"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"Content-Length","value":"20"},{"key":"Content-Type","value":"application/json"},{"key":"Cookie","value":"__profilin=p%3Dt"},{"key":"If-Modified-Since","value":""},{"key":"If-None-Match","value":""},{"key":"Postman-Token","value":"{{vault:authorization-secret---uuid}}"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/; HttpOnly"},{"key":"User-Agent","value":"PostmanRuntime/7.29.0"},{"key":"Vary","value":"Origin"},{"key":"Version","value":"HTTP/1.1"},{"key":"X-Forwarded-For","value":"172.21.0.1"},{"key":"X-Forwarded-Host","value":"api.wb.local"},{"key":"X-Forwarded-Port","value":"80"},{"key":"X-Forwarded-Proto","value":"http"},{"key":"X-Forwarded-Server","value":"d72c370167c8"},{"key":"X-Miniprofiler-Ids","value":"ursh9pjjtacw1gr0voi2,uuaq33xmcv9g2tqunnik,jthtd6h80w3uw2bksmug,oeboscwk8pszajcuzuky,h2mnwh92or0qrnzfbx7s,o25cav9ypwmbhr9lmn45,fo42p2e1dabc6cd9b42e,kjn7mn16v0y885swq0k8,t5ic0pirasxp8eelk2hi,bvkg054uh3m39ychum2d,x6zhjdvq6d606brtpf8x,jl5uzj890skvin6usxtk,s6ctiu9h4qmj4wnvc5sb,d85ab8l0le3pxa33js7o,hsykkw0tggs4qfki9rw1,vubvouzcx34qw3ke445c,mn52f66968aearay5ewx,3ont3mx3ivjdv6qm47fd,igj910n2h6zbtbrg0hkc,97wgznvhvtt8zzjch2dg"},{"key":"X-Miniprofiler-Original-Cache-Control","value":"no-cache"},{"key":"X-Real-Ip","value":"172.21.0.1"},{"key":"X-Request-Id","value":"cfcacdb6-973d-42fa-8691-d35a5a7f6a34"},{"key":"X-Runtime","value":"0.173988"},{"key":"Date","value":"Tue, 05 Jul 2022 16:04:03 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"},{"id":"a68e1b2c-d6c7-43a5-a60e-d6f61264d3b1","name":"Unsuccessful Unsubscription","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"subscription_id","value":"221551F3-371E-4B8B-BD36-8C787C64E","description":"The event subscription ID ","type":"text"}]},"url":{"raw":"api.wb.local/api/v2/webhook/unsubscribe","host":["api","wb","local"],"path":["api","v2","webhook","unsubscribe"],"query":[{"key":"","value":null,"disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Accept","value":"*/*"},{"key":"Accept-Encoding","value":"gzip, deflate, br"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, PATCH, DELETE"},{"key":"Authorization","value":"Bearer xxxxxx"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"Content-Length","value":"35"},{"key":"Content-Type","value":"application/json"},{"key":"Cookie","value":"__profilin=p%3Dt"},{"key":"If-Modified-Since","value":""},{"key":"If-None-Match","value":""},{"key":"Postman-Token","value":"{{vault:authorization-secret---uuid}}"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/; HttpOnly"},{"key":"User-Agent","value":"PostmanRuntime/7.29.0"},{"key":"Vary","value":"Origin"},{"key":"Version","value":"HTTP/1.1"},{"key":"X-Forwarded-For","value":"172.21.0.1"},{"key":"X-Forwarded-Port","value":"80"},{"key":"X-Forwarded-Proto","value":"http"},{"key":"X-Forwarded-Server","value":"d72c370167c8"},{"key":"X-Miniprofiler-Ids","value":"t5ic0pirasxp8eelk2hi,bvkg054uh3m39ychum2d,x6zhjdvq6d606brtpf8x,jl5uzj890skvin6usxtk,s6ctiu9h4qmj4wnvc5sb,d85ab8l0le3pxa33js7o,hsykkw0tggs4qfki9rw1,vubvouzcx34qw3ke445c,mn52f66968aearay5ewx,3ont3mx3ivjdv6qm47fd,igj910n2h6zbtbrg0hkc,97wgznvhvtt8zzjch2dg,o87z93o9cohr1omr2jmc,wgdtpfybcr05avdd9c6b,5tgcpx3vupt1ijbtfsh3,jypw5ulibe57to609cb4,szoowx7qkbydyulsso45,7fwp18t4jt8xm34mvanl,exs2oolupwovkucmzifp,5qu2qjenk8kxeg9i1k26"},{"key":"X-Miniprofiler-Original-Cache-Control","value":"no-cache"},{"key":"X-Real-Ip","value":"172.21.0.1"},{"key":"X-Request-Id","value":"ac40cf3c-a48a-4b40-8ee8-9dc824c118a9"},{"key":"X-Runtime","value":"0.055580"},{"key":"Date","value":"Tue, 05 Jul 2022 15:15:21 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUBSCRIPTION_NOT_FOUND\"\n}"}],"_postman_id":"14c4ee3e-6a15-4b09-9d7e-5df74c7fc771"},{"name":"Active Subscriptions","event":[{"listen":"test","script":{"exec":["pm.test(\"response should be okay to process\", function () {"," pm.response.to.not.be.error;"," pm.response.to.have.jsonBody(response);"," pm.response.to.not.have.jsonBody(\"error\");","});","","pm.test(\"response must be valid and have a body\", function () {"," pm.response.to.be.ok;"," pm.response.to.be.withBody;"," pm.response.to.be.json;","});","","pm.test(\"status test\", function() {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"a0c6a33e-9c83-4113-bd33-5b1449db4f21"}}],"id":"5541d516-56ee-4909-b566-9029a5904a87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"www.ovex.io/api/v2/webhook/all_subscriptions","description":"

Returns all active client webhook subscriptions.

Subscribing to a webhook will allow you to receive notifications for events that happen on your OVEX workspace. These events include the notification when:

An on ramp deposit is received.
An on ramp deposit is settled.
Any state changes for off ramp withdrawals.
KYC verified changed for your clients.

Once your Webhook is connected to your OVEX workspace, OVEX will send a POST request to the URL provided in your subscription request and expect a 200 response. If no response is received, OVEX will resend the request a maximum of 10 times with a backoff delay (10 seconds..3 minutes) between each attempt.

Available Subscriptions

deposit.received - Receive updates on received deposits. Sent as a JSON payload.

settlement.complete - Receive updates when a deposit is settled. Sent as a JSON payload.

offramp.state_change - Receive updates throughout the off ramp process as the transaction state changes. Sent as a JSON payload.

external_client.state_change - Receive updates when one of your clients successfully completes KYC and if OVEX compliance make changes to the KYC verified state.

States

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

State	Ramp Type	Description
CREATED	Both	The transaction has been created.
CONFIRMED	Both	The transaction has been completed.
CANCELLED	Both	The transaction has been deleted. This may still occur after a transaction has been 'CONFIRMED'.
REVERSED	Both	The transaction has been reversed. This would occur after a transaction has been 'CONFIRMED'.
SUBMITTED	On Ramp	The deposit has been received. The deposit is ready for settlement if the client is KYC verified.
SUBMITTED	Off Ramp	The trade has been completed and the withdrawal has been submitted for processing.
PROCESSING	Off Ramp	The withdawal is busy being processed.

Example On Ramp Webhooks

{\n  \"event_name\": \"deposit.received\",\n  \"subscription_id\": \"16985484-CBB2-40A2-A473-12HJKJH1234\",\n  \"data\": {\n    \"id\": \"TIDXXXXXXXXXX\",\n    \"currency\": \"zar\",\n    \"amount\": 100000,\n    \"status\": \"submitted\",\n    \"snr\": \"SNRXXXXXXXXX\",\n    \"kyc_validated\": true,\n    \"auto_settle\": true,\n    \"message\": \"A deposit for the client has been received. The amount of 100000.0 is ready for settlement. An automated settlement to usdc will be initiated in the next 15 minutes.\"\n  }\n}\n\n

Example Off Ramp Webhooks

{\n\"event_name\": \"offramp.state_change\",\n\"subscription_id\": \"2A9118E0-4CB5-42A7-9775-875555328C9F\"\n\"data\": {\"completed_at\": null,\n          \"created_at\": 1710431024,\n          \"from_amount\": 7600.0,\n          \"from_currency\": \"usdt\",\n          \"id\": \"TIDXXXXXXXXXX\",\n          \"rate\": 19.0126,\n          \"reason_for_delete\": null,\n          \"snr\": \"SNRXXXXXXXXX\",\n          \"status\": \"CREATED\",\n          \"to_amount\": 144495.76,\n          \"to_currency\": \"zar\"},\n}\n{\n\"event_name\": \"offramp.state_change\",\n\"subscription_id\": \"2A9118E0-4CB5-42A7-9775-875555328C9F\"\n\"data\": {\"completed_at\": null,\n          \"created_at\": 1710431024,\n          \"from_amount\": 7600.0,\n          \"from_currency\": \"usdt\",\n          \"id\": \"TIDXXXXXXXXXX\",\n          \"rate\": 19.0126,\n          \"reason_for_delete\": null,\n          \"snr\": \"SNRXXXXXXXXX\",\n          \"status\": \"PROCESSING\",\n          \"to_amount\": 144495.76,\n          \"to_currency\": \"zar\"},\n }\n \n {\n \"event_name\": \"offramp.state_change\",\n \"subscription_id\": \"2A9118E0-4CB5-42A7-9775-875555328C9F\"\n \"data\": {\"completed_at\": 1710431219,\n          \"created_at\": 1710431024,\n          \"from_amount\": 7600.0,\n          \"from_currency\": \"usdt\",\n          \"id\": \"TID8801CE8BDF\",\n          \"rate\": 19.0126,\n          \"reason_for_delete\": null,\n          \"snr\": \"SNR2EB99001\",\n          \"status\": \"CONFIRMED\",\n          \"to_amount\": 144495.76,\n          \"to_currency\": \"zar\"},\n}\n\n

\n","_postman_id":"7aad31fc-c0a2-416d-be1c-a976a963a819","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}}],"id":"5d9b01f5-1505-4e05-a705-c5c1b05c29dd","description":"

Setting up OVEX API Ramps

Overview

Contact support@ovex.io to enable OVEX API Ramps on your account.

A flow diagram of the ramps process.

When enabling ramps for your account:

You will need to provide a default currency.
We will provide you with a Ramps Secret Key.

Important things to note:

All requests require Bearer token authentication.
OVEX requires your server IP address(es) to be whitelisted. We only allow pre-approved individuals to access our network.
/ramps/onramp/settle and /ramps/offramp/accept_quote requires a sig parameter. This is an encrypted hex string of the payload. The sig is generated by creating a SHA256 HMAC hash of the payload using your Ramps Secret Key. The secret key is provided when we enable ramps for your profile.
/ramps/onramp/settle and /ramps/offramp/accept_quote requires a Http-Idempotency-Key header. This value is a 32-character UUID. Every request is validated against the uniqueness of this value.
It is required to subscribe to the Webhook service if you want to automatically receive confirmation of deposits/settles/withdrawals.
Transaction histories for ramps can be found at (Can filter by SNR):
1. /deposits
2. /trades/history
3. /withdraws
\n
Please take note of the usage of the following terms:
1. A 'member' refers to you, the user of Ovex.
2. A 'client' refers to your client.
3. SNR is the generated unique number for your client.
4. TID refers to the unique transaction IDs. The deposit TID is supplied by a Webhook after the deposit is accepted. Each deposit or trade will have a unique TID.
\n

Auto-settlement

Auto-settlement is a feature of the on-ramp process. When a KYC-verified client makes a deposit, the deposit will be automatically converted into the 'default currency' of choice. The auto-settlement will be initiated 15 minutes after the deposit is confirmed.

Default Currency

The default currency is essential for the on-ramp procedure. This is the currency that the auto-settlement will use when converting a deposit.

The current options are ZARP, USDT, or USDC.

The order of precedence that will be followed when determining the currency to use is:

The currency set with ramps/onramp/settle.
The client's default currency will be automatically used if set.
The member's default currency will be automatically used if the client's is not set.

Signature Creation (sig)

Authenticated calls require you to send a request signature with every request. This signature should be re-generated for every request. The sig is generated by creating a SHA256 HMAC hash using your Ramps Secret Key. The payload to be hashed must be a stringified JSON in the same order stated in the docs. (Refer to ramps/onramp/settle and ramps/offramp/accept_quotefor the order of the parameters.)

Example of Sig creation in Postman (sig specific code at #2)

// 1) Ensure input parameters are in the correct order and format.\nvar param_string =  interpolate(pm.request.body.toString());\nconst arr = param_string.split('&');\nvar response_body = {};\narr.forEach(function(item){\n    response_body[item.split('=')[0]] = item.split('=')[1];\n});\ndelete response_body['sig'];\npm.environment.set(\"response_body\", response_body);\n// 2) Encrypt the input parameters and encrypt using the Ramps Secret Key.\nsecret_key = \"foot clever camp\" // Ramps Secret Key provided when Ramps is enabled.\nsha256_encoded_str = CryptoJS.HmacSHA256(JSON.stringify(response_body), secret_key);\nsignature = sha256_encoded_str.toString(CryptoJS.enc.Hex);\n// 2) End\npm.environment.set(\"sig\", signature);\nfunction interpolate (value) {\n    const {Property} = require('postman-collection');\n    return Property.replaceSubstitutions(value, pm.variables.toObject()).toString()\n}\n\n

Idempotency Key

Along with the sig, authenticated calls require you to send an Http-Idempotency-Key in the header with every request with the value a UUID.

Note: The Http-Idempotency-Keymust be a UUID (different each time) as uniqueness is validated on each request.

\n","_postman_id":"5d9b01f5-1505-4e05-a705-c5c1b05c29dd","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"Beneficiaries","item":[{"name":"Get Beneficiaries","id":"80e8f7ab-4396-4c01-8b2e-4cf676865de6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/beneficiaries?currency_id=usd","description":"

Get a list of confirmed or unconfirmed beneficiaries.

Omit the currency_id parameter to get a list of all beneficiaries.

Any supported currencies: zar, btc, eth, tusd, ZAR, BTC, ETH, TUSD. (Optional)

\n","type":"text/plain"},"key":"currency_id","value":"usd"}],"variable":[]}},"response":[{"id":"dd7db529-577f-4162-8a64-edd5f549e2c1","name":"Get Beneficiaries (New)","originalRequest":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/beneficiaries"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"beneficiary_id\": 5,\n \"sn\": \"SN017EF9E009\",\n \"email\": \"example@email.com\",\n \"name\": \"Holiday Savings\",\n \"currency_id\": \"zar\",\n \"withdraw_data\": {\n \"bank_name\": \"Example Bank\",\n \"branch_code\": \"00000\",\n \"account_number\": \"0123456789\",\n \"account_holder_name\": \"John Doe\"\n },\n \"rid\": \"John Doe, Example Bank, 0123456789, 00000\",\n \"network_name\": \"default\",\n \"reference_no\": null,\n \"confirmed\": true,\n \"default_carf_transfer_type\": null,\n \"default_carf_other_description\": null\n },\n {\n \"beneficiary_id\": 13,\n \"sn\": \"SN017EF9E009\",\n \"email\": \"example@email.com\",\n \"name\": \"Desiree Nicolas\",\n \"currency_id\": \"eth\",\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"0x0xxxxxxxxxxxxxxxxxxxxx\",\n \"network_name\": \"ethereum\"\n },\n \"rid\": \"0x0xxxxxxxxxxxxxxxxxxxxx\",\n \"network_name\": \"ethereum\",\n \"reference_no\": null,\n \"confirmed\": false,\n \"default_carf_transfer_type\": null,\n \"default_carf_other_description\": null\n }\n]"}],"_postman_id":"80e8f7ab-4396-4c01-8b2e-4cf676865de6"},{"name":"Create Coin Beneficiary","id":"cd522b24-ef55-4c6e-a0dc-42039624cd7d","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"www.ovex.io/api/v2/beneficiaries/coin/create?name=My Beneficiary¤cy_id=eth&network_name=ethereum&crypto_wallet_address=0x742d35Cc6634C0532925a3b844Bc454e4438f44e","description":"

Create a saved beneficiary for a specific currency (Coins). Beneficiaries need to be confirmed via email before use.

To create a new coin beneficiary:

Pass currency_id to GET /currencies/withdraw_requirements to get the possible network_name's and the additional required parameters for each network. (Currently only crypto_wallet_address)
\n
Pass name, currency_id, network_name and any additional parameters (GET /currencies/withdraw_requirements) to the creation endpoint.
\n

A name for the new beneficiary

\n","type":"text/plain"},"key":"name","value":"My Beneficiary"},{"description":{"content":"

Any supported coin currencies: btc, eth, tusd, BTC, ETH, TUSD.

\n","type":"text/plain"},"key":"currency_id","value":"eth"},{"description":{"content":"

Get supported networks from GET /currencies/withdraw_requirements

\n","type":"text/plain"},"key":"network_name","value":"ethereum"},{"description":{"content":"

Valid coin address

\n","type":"text/plain"},"key":"crypto_wallet_address","value":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},{"disabled":true,"description":{"content":"

(Optional) Default CARF transfer type code for withdrawals from this beneficiary. Use GET /carf_transfer_types to list valid codes.

\n","type":"text/plain"},"key":"carf_transfer_type","value":"CARF601"},{"disabled":true,"description":{"content":"

(Optional) Free-text description when carf_transfer_type is 'Other' (CARF605).

\n","type":"text/plain"},"key":"carf_other_description","value":""}],"variable":[]}},"response":[{"id":"248830a3-49e2-4045-b482-1ff6869f47c6","name":"Create Coin Beneficiary","originalRequest":{"method":"POST","header":[],"url":{"raw":"www.ovex.io/api/v2/beneficiaries/coin/create?name=My Beneficiary¤cy_id=eth&network_name=ethereum&crypto_wallet_address=0x742d35Cc6634C0532925a3b844Bc454e4438f44e","host":["www.ovex.io"],"path":["api/v2","beneficiaries","coin","create"],"query":[{"key":"name","value":"My Beneficiary","description":"A name for the new beneficiary"},{"key":"currency_id","value":"eth","description":"Any supported coin currencies: btc, eth, tusd, BTC, ETH, TUSD."},{"key":"network_name","value":"ethereum","description":"Get supported networks from `GET /currencies/withdraw_requirements`"},{"key":"crypto_wallet_address","value":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e","description":"Valid coin address"},{"key":null,"value":"0x0xxxxxxxxxxxxxxxxxxxxx","disabled":true},{"key":"carf_transfer_type","value":"CARF601","description":"(Optional) Default CARF transfer type code for withdrawals from this beneficiary.","disabled":true},{"key":"carf_other_description","value":"","description":"(Optional) Free-text description when carf_transfer_type is 'Other' (CARF605).","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"beneficiary_id\": 570,\n \"sn\": \"SN33C4E36BFF\",\n \"email\": \"test@ovex.io\",\n \"name\": \"My Beneficiary\",\n \"currency_id\": \"eth\",\n \"withdraw_data\": {\n \"crypto_wallet_address\": \"0x742d35Cc6634C0532925a3b844Bc454e4438f44e\",\n \"network_name\": \"ethereum\"\n },\n \"network_name\": \"ethereum\",\n \"reference_no\": null,\n \"confirmed\": false,\n \"default_carf_transfer_type\": null,\n \"default_carf_other_description\": null\n}"}],"_postman_id":"cd522b24-ef55-4c6e-a0dc-42039624cd7d"},{"name":"Create Fiat Beneficiary","id":"3c35bd8e-a5f0-44cf-a41b-b18f9c830cdc","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"www.ovex.io/api/v2/beneficiaries/fiat/create?name=My beneficiary¤cy_id=gbp&payment_method=SWIFT&account_holder_name=John Doe&bank_name=Example Bank&bank_country=GB&iban=GB33BUKB20201555555555&street_address=1 Main Road&city=New York&postal_code=1234","description":"

Create a saved beneficiary for a specific currency (Fiats). Beneficiaries need to be confirmed via email before use.

To create a new fiat beneficiary:

Pass currency_id to GET /currencies/withdraw_requirements to get the possible payment_method's and the additional required parameters for each payment method.
\n
Pass name, currency_id, payment_method and any additional parameters (GET /currencies/withdraw_requirements ) to the creation endpoint.
\n

NOTE: In the example below, the parameters account_holder_name ... postal_code come from (GET /currencies/withdraw_requirements)

(Always required) A name for the new beneficiary

\n","type":"text/plain"},"key":"name","value":"My beneficiary"},{"description":{"content":"

(Always required) Any supported fiat currencies: zar, usd, ZAR, USD

\n","type":"text/plain"},"key":"currency_id","value":"gbp"},{"description":{"content":"

(Always required) Get supported payment methods from GET /currencies/withdraw_requirements

\n","type":"text/plain"},"key":"payment_method","value":"SWIFT"},{"description":{"content":"

A valid bank account holder name

\n","type":"text/plain"},"key":"account_holder_name","value":"John Doe"},{"description":{"content":"

A valid bank name

\n","type":"text/plain"},"key":"bank_name","value":"Example Bank"},{"description":{"content":"

Bank's country

\n","type":"text/plain"},"key":"bank_country","value":"GB"},{"description":{"content":"

A valid Iban

\n","type":"text/plain"},"key":"iban","value":"GB33BUKB20201555555555"},{"description":{"content":"

Account holder physical address

\n","type":"text/plain"},"key":"street_address","value":"1 Main Road"},{"description":{"content":"

Account holder city

\n","type":"text/plain"},"key":"city","value":"New York"},{"description":{"content":"

Account holder postal code

\n","type":"text/plain"},"key":"postal_code","value":"1234"}],"variable":[]}},"response":[{"id":"947d2bdf-3913-46fb-a4b1-9e2202f806fd","name":"Create Fiat Beneficiary","originalRequest":{"method":"POST","header":[],"url":{"raw":"www.ovex.io/api/v2/beneficiaries/fiat/create?name=My beneficiary¤cy_id=gbp&payment_method=SWIFT&account_holder_name=John Doe&bank_name=Example Bank&bank_country=GB&iban=GB33BUKB20201555555555&street_address=1 Main Road&city=London&postal_code=1234","host":["www.ovex.io"],"path":["api/v2","beneficiaries","fiat","create"],"query":[{"key":"name","value":"My beneficiary","description":"(Always required) A name for the new beneficiary"},{"key":"currency_id","value":"gbp","description":"(Always required) Any supported fiat currencies: zar, usd, ZAR, USD"},{"key":"payment_method","value":"SWIFT","description":"(Always required) Get supported payment methods from `GET /currencies/withdraw_requirements`"},{"key":"account_holder_name","value":"John Doe","description":"A valid bank account holder name"},{"key":"bank_name","value":"Example Bank","description":"A valid bank name"},{"key":"bank_country","value":"GB","description":"Bank's country"},{"key":"iban","value":"GB33BUKB20201555555555","description":"A valid Iban"},{"key":"street_address","value":"1 Main Road","description":"Account holder physical address"},{"key":"city","value":"London","description":"Account holder city"},{"key":"postal_code","value":"1234","description":"Account holder postal code"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"beneficiary_id\": 569,\n \"sn\": \"SN33C4E36BFF\",\n \"email\": \"test@ovex.io\",\n \"name\": \"My beneficiary\",\n \"currency_id\": \"gbp\",\n \"withdraw_data\": {\n \"payment_method\": \"SWIFT\",\n \"account_holder_name\": \"John Doe\",\n \"bank_name\": \"Example Bank\",\n \"bank_country\": \"GB\",\n \"iban\": \"GB33BUKB20201555555555\",\n \"street_address\": \"1 Main Road\",\n \"city\": \"London\",\n \"postal_code\": \"1234\"\n },\n \"network_name\": \"default\",\n \"reference_no\": null,\n \"confirmed\": false\n}"}],"_postman_id":"3c35bd8e-a5f0-44cf-a41b-b18f9c830cdc"}],"id":"ce1947a1-865a-42ed-b095-e401d8a0769c","description":"

NOTE: When creating a beneficiary, first utilize the endpoint,

GET /currencies/withdraw_requirements,

to get the required parameters (per payment_method (fiat) or network_name (coin)). These parameters are used in the beneficiary create endpoints.

\n","_postman_id":"ce1947a1-865a-42ed-b095-e401d8a0769c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"CARF","item":[{"name":"Transfer Types","id":"4299f0e6-45ce-42c4-8fc9-7782d79914b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/carf_transfer_types","description":"

Get the available CARF transfer types for deposits and withdrawals.

Returns two arrays grouped by direction:

deposit: Types like Airdrop (CARF501), Staking Income (CARF502), etc.
withdraw: Types like Transfer to Exchange (CARF601), Crypto Loan (CARF602), etc.

Only user-facing types are returned (internal 'Unknown' types are excluded).

Get your OTC trade history as a paginated collection. Supports CSV and PDF export via the alt_format parameter.

\n","urlObject":{"path":["api/v2","trades","history"],"host":["{{BASE_URL}}"],"query":[{"disabled":true,"description":{"content":"

Start date (ISO 8601)

\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"

End date (ISO 8601)

\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"

Filter by currency

\n","type":"text/plain"},"key":"currency","value":""},{"disabled":true,"description":{"content":"

Filter by RFQ (true/false)

\n","type":"text/plain"},"key":"rfq","value":""},{"disabled":true,"description":{"content":"

Nest child trades under parent

\n","type":"text/plain"},"key":"nest_children","value":"true"},{"disabled":true,"description":{"content":"

External client SNR

\n","type":"text/plain"},"key":"snr","value":""},{"disabled":true,"description":{"content":"

Page number

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Results per page

\n","type":"text/plain"},"key":"limit","value":"25"},{"disabled":true,"description":{"content":"

Sort order

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

csv or pdf for export

\n","type":"text/plain"},"key":"alt_format","value":""}],"variable":[]}},"response":[{"id":"6a47fafa-e99d-4908-9e28-8a67ac74a775","name":"Success","originalRequest":{"header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"trades\": [\n {\n \"id\": 1234,\n \"from_currency\": \"zar\",\n \"to_currency\": \"btc\",\n \"from_amount\": \"100000.0\",\n \"to_amount\": \"0.05\",\n \"rate\": \"2000000.0\",\n \"rate_is_from_currency\": true,\n \"fee\": \"0.1\",\n \"state\": \"confirmed\",\n \"rfq\": true,\n \"created_at\": \"2026-03-15T10:30:00Z\",\n \"confirmed_at\": \"2026-03-15T10:30:05Z\",\n \"children\": []\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"limit\": 25,\n \"total\": 1\n }\n}"}],"_postman_id":"28125f1e-a697-4c2c-a1c3-9e9b5dff4ffa"}],"id":"233fb80d-e850-4308-b887-d30d35ff5bba","_postman_id":"233fb80d-e850-4308-b887-d30d35ff5bba","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}},{"name":"Timestamp","id":"f85924be-233e-4048-bf14-1c542d75755e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.ovex.io/api/v2/timestamp","description":"

Get server current time, in seconds since Unix epoch.

OVEX Digital Asset Exchange API

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"96793d2d-e991-4362-a712-424483444a00"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f123f081-4a64-444f-a375-77ae3cb9dd52"}}],"_postman_id":"a66e5bdc-b8c1-45fe-9151-54e0fe141cc6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]},"isInherited":true,"source":{"_postman_id":"182ec62b-7745-473a-8330-2de33d1de54e","id":"182ec62b-7745-473a-8330-2de33d1de54e","name":"OVEX Public API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt_token}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"51992b44-8ec4-420c-a4a8-4447f733aa9c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"21327cf3-626f-4f19-bcbe-c5b916770ed9"}}],"variable":[{"key":"OVEX_BASE_URL","value":"www.ovex.io"},{"key":"API_PATH","value":"api/v2"},{"key":"snr","value":""},{"key":"quote_token","value":""}]}