{"info":{"_postman_id":"597ac57e-40cd-4a43-a571-66829543eda2","name":"Guardarian API","description":"

Introduction

\n

Guardarian API

\n

Authentication

\n

Guardarian API uses token authentication.\nToken generated for each partner and must be submitted with x-api-key header for successful authentication.

\n

Error Codes

\n\n

Rate limit

\n

Only one request per minute from the same IP address is allowed for create transaction endpoint.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"12908416","collectionId":"597ac57e-40cd-4a43-a571-66829543eda2","publishedId":"TVRhaoYL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-10-06T10:32:25.000Z"},"item":[{"name":"1. Get API status","id":"665b4b8a-1583-4ec9-be4d-5a21f7e932dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/status","description":"

This is API healthcheck endpoint

\n","urlObject":{"path":["v1","status"],"query":[],"variable":[]}},"response":[{"id":"4871e737-95d1-4d9c-99d4-68eab62a6eb9","name":"/v1/status","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/status"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"OK\"\n}"}],"_postman_id":"665b4b8a-1583-4ec9-be4d-5a21f7e932dc"},{"name":"2. Get fiat currencies","id":"65211f87-ec01-40cc-af05-f2b7d55bd6d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/currencies/fiat","description":"

This is a method for obtaining information about the fiat currencies that can be used to buy cryptocurrencies.

\n","urlObject":{"path":["v1","currencies","fiat"],"query":[],"variable":[]}},"response":[{"id":"0cc1fa4e-4503-4d06-891f-d58044107771","name":"/v1/currencies/fiat","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/currencies/fiat"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 42,\n \"code\": \"EUR\",\n \"name\": \"EUR\",\n \"enable\": true,\n \"priority\": 2,\n \"logoUrl\": \"https://somewhere.com\",\n \"created_at\": \"2019-04-18T13:39:27.982Z\",\n \"updated_at\": \"2019-04-18T13:39:27.982Z\"\n}"}],"_postman_id":"65211f87-ec01-40cc-af05-f2b7d55bd6d9"},{"name":"3. Get cryptocurrencies","id":"53281a9f-a60a-43df-a2cb-bacdbfe7e1b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/currencies/crypto","description":"

This is a method for obtaining information about the cryptocurrencies that a customer can buy using fiat currencies.

\n","urlObject":{"path":["v1","currencies","crypto"],"query":[],"variable":[]}},"response":[{"id":"19f94931-ddc2-49d7-9f3a-95ace3c3fa60","name":"/v1/currencies/crypto","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/currencies/crypto"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 43,\n \"code\": \"BTC\",\n \"name\": \"BTC\",\n \"enable\": true,\n \"priority\": 2,\n \"logoUrl\": \"https://somewhere.com\",\n \"created_at\": \"2019-04-18T13:39:27.982Z\",\n \"updated_at\": \"2019-04-18T13:39:27.982Z\",\n \"walletRegex\": \"^.*$\",\n \"extraIdExists\": true,\n \"extraIdRegex\": \"^.*$\"\n}"}],"_postman_id":"53281a9f-a60a-43df-a2cb-bacdbfe7e1b4"},{"name":"4. Create transaction","id":"774f1480-1914-4fa1-baf3-f3e455415664","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"","description":"

Your API token

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"/v1/transaction","description":"

This is a method for creating a fiat-to-cryptocurrency exchange transaction.

\n","urlObject":{"path":["v1","transaction"],"query":[],"variable":[]}},"response":[{"id":"2e593098-f37c-482e-82f6-ee6b129ad290","name":"/v1/transaction","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"","description":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fiat_currency\": \"EUR\",\n \"fiat_amount\": 1200.24,\n \"crypto_currency\": \"BTC\",\n \"crypto_amount\": 0.144,\n \"payout_address\": \"mtXWDB6k5yC5v7TcwKZHB89SUp85yCKshy\",\n \"email\": \"jdoe@gmail.com\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/transaction"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 4213516662,\n \"status\": \"finished\",\n \"status_details\": \"Completely finished\",\n \"fiat_currency\": \"EUR\",\n \"fiat_amount\": 1200.24,\n \"crypto_currency\": \"BTC\",\n \"crypto_amount\": 0.144,\n \"payout_address\": \"mtXWDB6k5yC5v7TcwKZHB89SUp85yCKshy\",\n \"output_hash\": \"6146ccf6a66d994f7c363db875e31ca35581450a4bf6d3be6cc9ac79233a69d0\",\n \"estimated_amount\": 0.144,\n \"created_at\": \"2019-04-18T13:39:27.982Z\",\n \"updated_at\": \"2019-04-18T13:39:27.982Z\",\n \"location\": \"Somewhere\",\n \"redirect_url\": \"https://example.com\"\n}"}],"_postman_id":"774f1480-1914-4fa1-baf3-f3e455415664"},{"name":"5. Get transaction by ID","id":"f22340ea-6564-4de9-a652-50e9cfb769bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"","description":"

Your API token

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"/v1/transaction/","description":"

This is a method for obtaining information about the submitted transaction by its identifier.

\n

Parameters:

\n
    \n
  • transaction_id - transaction ID
    • \n
\n","urlObject":{"path":["v1","transaction",""],"query":[],"variable":[]}},"response":[{"id":"27acaee7-4ae6-4195-9865-f8273e2b97a3","name":"/v1/transaction/","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":""},"url":"/v1/transaction/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 4213516662,\n \"status\": \"finished\",\n \"status_details\": \"Completely finished\",\n \"fiat_currency\": \"EUR\",\n \"fiat_amount\": 1200.24,\n \"crypto_currency\": \"BTC\",\n \"crypto_amount\": 0.144,\n \"payout_address\": \"mtXWDB6k5yC5v7TcwKZHB89SUp85yCKshy\",\n \"output_hash\": \"6146ccf6a66d994f7c363db875e31ca35581450a4bf6d3be6cc9ac79233a69d0\",\n \"estimated_amount\": 0.144,\n \"created_at\": \"2019-04-18T13:39:27.982Z\",\n \"updated_at\": \"2019-04-18T13:39:27.982Z\",\n \"location\": \"Somewhere\"\n}"}],"_postman_id":"f22340ea-6564-4de9-a652-50e9cfb769bf"},{"name":"6. Update transaction by ID","id":"12e8448d-5504-4cd2-9cd0-55bb3568fc0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"","description":"

Your API token

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"/v1/transaction/","description":"

This is a method for updating transaction by its identifier.

\n

Updatable transaction parameters:

\n
    \n
  • payout_address - new payout address for requested cryptocurrency
    • \n
  • email - new email address
    • \n
\n

Parameters:

\n
    \n
  • transaction_id - transaction ID
    • \n
\n","urlObject":{"path":["v1","transaction",""],"query":[],"variable":[]}},"response":[{"id":"8061a648-140f-4926-a1f9-99fdb24bcd8d","name":"/v1/transaction/","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payout_address\": \"mtXWDB6k5yC5v7TcwKZHB89SUp85yCKshy\",\n \"email\": \"jdoe@gmail.com\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/transaction/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 4213516662,\n \"status\": \"finished\",\n \"status_details\": \"Completely finished\",\n \"fiat_currency\": \"EUR\",\n \"fiat_amount\": 1200.24,\n \"crypto_currency\": \"BTC\",\n \"crypto_amount\": 0.144,\n \"payout_address\": \"mtXWDB6k5yC5v7TcwKZHB89SUp85yCKshy\",\n \"output_hash\": \"6146ccf6a66d994f7c363db875e31ca35581450a4bf6d3be6cc9ac79233a69d0\",\n \"estimated_amount\": 0.144,\n \"created_at\": \"2019-04-18T13:39:27.982Z\",\n \"updated_at\": \"2019-04-18T13:39:27.982Z\",\n \"location\": \"Somewhere\",\n \"redirect_url\": \"https://example.com\"\n}"}],"_postman_id":"12e8448d-5504-4cd2-9cd0-55bb3568fc0f"},{"name":"7. Estimate","id":"fb733188-a922-481f-a2d2-41796d9c6dfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"","description":"

Your API token

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"/v1/estimate","description":"

This is a method for estimating the exchange amount.

\n","urlObject":{"path":["v1","estimate"],"query":[],"variable":[]}},"response":[{"id":"909a107e-5c63-48c8-9038-9d13481b0b35","name":"/v1/estimate","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fiat_currency\": \"EUR\",\n \"crypto_currency\": \"BTC\",\n \"fiat_amount\": 1000\n}","options":{"raw":{"language":"json"}}},"url":"/v1/estimate"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"fiat_currency\": \"EUR\",\n \"crypto_currency\": \"BTC\",\n \"value\": 0.1\n}"}],"_postman_id":"fb733188-a922-481f-a2d2-41796d9c6dfd"}]}