{ "openapi": "3.1.0", "info": { "title": "v2", "version": "2" }, "servers": [ { "url": "https://api.coingate.com/api/v2" } ], "components": { "securitySchemes": {} }, "security": [ {} ], "paths": { "/orders": { "post": { "summary": "Create Order", "description": "Create order at CoinGate and redirect shopper to invoice (payment_url).", "operationId": "create-order", "responses": { "200": { "description": "200", "content": { "text/plain": { "examples": { "Result": { "value": "{\n \"id\": 538,\n \"status\": \"new\",\n \"title\": \"Order #111\",\n \"do_not_convert\": false,\n \"orderable_type\": \"ApiApp\",\n \"orderable_id\": 3,\n \"price_currency\": \"EUR\",\n \"price_amount\": \"10.0\",\n \"lightning_network\": false,\n \"receive_currency\": \"EUR\",\n \"receive_amount\": \"0\",\n \"created_at\": \"2022-12-09T14:02:41+00:00\",\n \"order_id\": \"111\",\n \"payment_url\": \"http://localhost:3000/invoice/a275c4a1-fc54-45b1-a98a-66652e338fb2\",\n \"underpaid_amount\": \"0\",\n \"overpaid_amount\": \"0\",\n \"is_refundable\": false,\n \"refunds\": [],\n \"voids\": [],\n \"fees\": [],\n \"token\": \"PsPXSa46uohMtMWqfzTrnwy3p3sNmQ\",\n\t\"blockchain_transactions\": []\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 538, "default": 0 }, "status": { "type": "string", "example": "new" }, "title": { "type": "string", "example": "Order #111" }, "do_not_convert": { "type": "boolean", "example": false, "default": true }, "orderable_type": { "type": "string", "example": "ApiApp" }, "orderable_id": { "type": "integer", "example": 3, "default": 0 }, "price_currency": { "type": "string", "example": "EUR" }, "price_amount": { "type": "string", "example": "10.0" }, "lightning_network": { "type": "boolean", "example": false, "default": true }, "receive_currency": { "type": "string", "example": "EUR" }, "receive_amount": { "type": "string", "example": "0" }, "created_at": { "type": "string", "example": "2022-12-09T14:02:41+00:00" }, "order_id": { "type": "string", "example": "111" }, "payment_url": { "type": "string", "example": "http://localhost:3000/invoice/a275c4a1-fc54-45b1-a98a-66652e338fb2" }, "underpaid_amount": { "type": "string", "example": "0" }, "overpaid_amount": { "type": "string", "example": "0" }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "refunds": { "type": "array" }, "voids": { "type": "array" }, "fees": { "type": "array" }, "token": { "type": "string", "example": "PsPXSa46uohMtMWqfzTrnwy3p3sNmQ" }, "blockchain_transactions": { "type": "array" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Order is not valid\",\n \"reason\": \"OrderIsNotValid\",\n \"errors\": [\n \"Price can't be blank\",\n \"Price is not a number\",\n \"Btc amount can't be blank\",\n \"Btc amount is not a number\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Order is not valid" }, "reason": { "type": "string", "example": "OrderIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Price can't be blank" } } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "## Create Order\ncurl -X \"POST\" \"http://localhost:3000/api/v2/orders\" \\\n -H 'Authorization: Token YOU_API_TOKEN' \\\n -H 'Content-Type: application/x-www-form-urlencoded; charset=utf-8' \\\n --data-urlencode \"title=My Store Order #111\" \\\n --data-urlencode \"price_amount=1369\" \\\n --data-urlencode \"price_currency=EUR\" \\\n --data-urlencode \"receive_currency=USDC\" \\\n --data-urlencode \"callback_url=https://example.com/test\" \\\n --data-urlencode \"success_url=http://example.com/success\" \\\n --data-urlencode \"cancel_url=http://example.com/cancel\" \\\n --data-urlencode \"order_id=111\" \\\n --data-urlencode \"description=iPhone 16 Pro Max (256 GB)\" \\\n --data-urlencode \"shopper[type]=personal\" \\\n --data-urlencode \"shopper[ip_address]=127.0.0.1\" \\\n --data-urlencode \"shopper[email]=test@example.com\" \\\n --data-urlencode \"shopper[first_name]=Joe\" \\\n --data-urlencode \"shopper[last_name]=Doe\" \\\n --data-urlencode \"shopper[date_of_birth]=1987-02-12\"\n" }, { "language": "php", "code": " 'My Store Order #111',\n 'price_amount' => '1369',\n 'price_currency' => 'EUR',\n 'receive_currency' => 'USDC',\n 'callback_url' => 'https://example.com/test',\n 'success_url' => 'http://example.com/success',\n 'cancel_url' => 'http://example.com/cancel',\n 'order_id' => '111',\n 'description' => 'iPhone 16 Pro Max (256 GB)',\n 'shopper[type]' => 'personal',\n 'shopper[ip_address]' => '127.0.0.1',\n 'shopper[email]' => 'test@example.com',\n 'shopper[first_name]' => 'Joe',\n 'shopper[last_name]' => 'Doe',\n 'shopper[date_of_birth]' => '1987-02-12'\n]);\n\n// Initialize cURL session\n$ch = curl_init($url);\n\n// cURL options\ncurl_setopt($ch, CURLOPT_POST, true);\ncurl_setopt($ch, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $data);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n\n// Execute cURL request\n$response = curl_exec($ch);\n\n// Check for errors\nif (curl_errno($ch)) {\n echo 'cURL Error: ' . curl_error($ch);\n exit;\n}\n\n// Close cURL session\ncurl_close($ch);\n\n// Decode JSON response\n$responseData = json_decode($response, true);\n\n// Check if payment_url is present in response\nif (isset($responseData['payment_url'])) {\n $paymentUrl = $responseData['payment_url'];\n // Redirect to payment URL\n header(\"Location: $paymentUrl\");\n exit;\n} else {\n echo 'Payment URL not found in the response.';\n print_r($responseData); // For debugging purposes\n}" } ], "samples-languages": [ "curl", "php" ] }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "order_id": { "type": "string", "description": "Merchant's custom order ID. We recommend using a unique order ID. Example: CGORDER-12345." }, "price_amount": { "type": "number", "format": "double", "description": "The price set by the merchant. Example: 1050.99." }, "price_currency": { "type": "string", "description": "[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code which defines the currency in which you wish to price your merchandise used to define price parameter. [Supported currencies](https://developer.coingate.com/docs/currencies)" }, "receive_currency": { "type": "string", "description": "[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code specifying the currency in which you want to receive settlements. Currency conversions are handled by CoinGate. See [Supported Settlement Currencies](https://developer.coingate.com/reference/currencies) for available options, or use DO_NOT_CONVERT to keep the payment in its original currency. For setup instructions, see [How to Configure Settlement Currency](https://support.coingate.com/hc/en-us/articles/21208494395676)." }, "title": { "type": "string", "description": "Min 3 - Max 150 characters. Example: product title (Apple iPhone 6), order id (MyShop Order #12345), cart id (Cart #00004335)." }, "description": { "type": "string", "description": "More details about this order. Min 3 - Max 500 characters. It can be cart items, product details or other information. Example: 1 x Apple iPhone 6, 1 x Apple MacBook Air." }, "callback_url": { "type": "string", "description": "Send an automated message to Merchant URL when order status is changed. For testing you can use [requestcatcher.com](https://requestcatcher.com/) tool. URL must be direct without redirection." }, "cancel_url": { "type": "string", "description": "Redirect to Merchant URL when buyer cancels the order" }, "success_url": { "type": "string", "description": "Redirect to Merchant URL after successful payment" }, "token": { "type": "string", "description": "Your custom token to validate payment callback (notification)." }, "shopper": { "type": "object", "properties": { "type": { "type": "string", "description": "Shopper type. Must be 'personal' or 'business' ('company' is also accepted as an alias for 'business')." }, "email": { "type": "string", "description": "Shopper's e-mail address" }, "ip_address": { "type": "string", "description": "Shopper's IP address" }, "personal": { "type": "object", "properties": { "first_name": { "type": "string", "description": "Shopper's first name." }, "last_name": { "type": "string", "description": "Shopper's last name." }, "date_of_birth": { "type": "string", "format": "date", "description": "Shopper's date of birth. Must be a valid date in the format YYYY-MM-DD." }, "residence_country": { "type": "string", "description": "Shopper's country of residence. Must be a valid Alpha-2 country code." } }, "description": "Personal details of the shopper. Provide when the shopper type is 'personal'." }, "company": { "type": "object", "properties": { "name": { "type": "string", "description": "Company's legal name." }, "code": { "type": "string", "description": "Company code (or business ID number) assigned by the authority under which the company is registered." }, "registration_country": { "type": "string", "description": "Country where the company is registered. Must be a valid Alpha-2 country code." } }, "description": "Company details of the shopper. Provide when the shopper type is 'business'." } }, "description": "Optional object to enhance the shopper’s experience and prefill the Travel Rule form on the checkout page. Learn more about the [Travel Rule](https://coingate.com/blog/post/travel-rule-explained). All fields are optional." } }, "type": "object", "required": [ "price_amount", "price_currency", "title", "description" ] } } } } }, "get": { "summary": "List Orders", "description": "Retrieving information of all placed orders.", "operationId": "list-orders", "parameters": [ { "name": "per_page", "in": "query", "description": "How many orders per page. Max: 100. Default: 100.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "sort", "in": "query", "description": "Sort orders by field. Available sort options: created_at_asc, created_at_desc. Default: created_at_desc.", "schema": { "type": "string", "default": "created_at_desc" } }, { "name": "created_at[from]", "in": "query", "description": "Optional. Where order creation time is equal or greater. Example: 2018-09-01", "schema": { "type": "string" } }, { "name": "created_at[to]", "in": "query", "description": "Optional. Where order creation time is equal or less. Example: 2018-09-30", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by order status. [Order statuses](https://developer.coingate.com/reference/order-statuses)", "schema": { "type": "string" } }, { "name": "paid_at[from]", "in": "query", "description": "Optional. Where order paid at time is equal or greater. Example: 2018-09-01", "schema": { "type": "string" } }, { "name": "paid_at[to]", "in": "query", "description": "Optional. Where order creation time is equal or less. Example: 2018-09-30", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "current_page": 1, "per_page": 2, "total_orders": 455, "total_pages": 228, "orders": [ { "id": 537, "status": "canceled", "title": "test", "do_not_convert": false, "orderable_type": "Button", "orderable_id": 2, "price_currency": "EUR", "price_amount": "10.0", "lightning_network": false, "receive_currency": "", "receive_amount": "0", "created_at": "2022-12-09T13:53:43+00:00", "order_id": "", "payment_url": "http://localhost:3000/invoice/e386db94-d648-4b4b-9b19-1f2825f7eb32", "underpaid_amount": "0", "overpaid_amount": "0", "is_refundable": false, "refunds": [], "voids": [], "fees": [], "blockchain_transactions": [], "ledger_transactions": [] }, { "id": 536, "status": "canceled", "title": "test", "do_not_convert": false, "orderable_type": "Button", "orderable_id": 2, "price_currency": "EUR", "price_amount": "20.0", "pay_currency": "BTC", "pay_amount": "0.0009822", "lightning_network": false, "receive_currency": "USDT", "receive_amount": "0", "created_at": "2022-12-07T11:27:11+00:00", "expire_at": "2022-12-07T11:47:18+00:00", "payment_address": "00e5602a-3380-4437-b1df-483ff84c47de", "order_id": "", "payment_url": "http://localhost:3000/invoice/725ee4b4-4a75-45a5-8f3d-c8012546cda9", "underpaid_amount": "0.0009822", "overpaid_amount": "0", "is_refundable": false, "conversion_rate": "20566.0", "refunds": [], "voids": [], "fees": [], "blockchain_transactions": [], "ledger_transactions": [] } ] } } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 2, "default": 0 }, "total_orders": { "type": "integer", "example": 455, "default": 0 }, "total_pages": { "type": "integer", "example": 228, "default": 0 }, "orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 537, "default": 0 }, "status": { "type": "string", "example": "canceled" }, "title": { "type": "string", "example": "test" }, "do_not_convert": { "type": "boolean", "example": false, "default": true }, "orderable_type": { "type": "string", "example": "Button" }, "orderable_id": { "type": "integer", "example": 2, "default": 0 }, "price_currency": { "type": "string", "example": "EUR" }, "price_amount": { "type": "string", "example": "10.0" }, "lightning_network": { "type": "boolean", "example": false, "default": true }, "receive_currency": { "type": "string", "example": "" }, "receive_amount": { "type": "string", "example": "0" }, "created_at": { "type": "string", "example": "2022-12-09T13:53:43+00:00" }, "order_id": { "type": "string", "example": "" }, "payment_url": { "type": "string", "example": "http://localhost:3000/invoice/e386db94-d648-4b4b-9b19-1f2825f7eb32" }, "underpaid_amount": { "type": "string", "example": "0" }, "overpaid_amount": { "type": "string", "example": "0" }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "refunds": { "type": "array" }, "voids": { "type": "array" }, "fees": { "type": "array" }, "blockchain_transactions": { "type": "array" } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl -H \"Authorization: Token YOUR_APP_TOKEN\" https://api.coingate.com/v2/orders?per_page=2&page=1&sort=created_at_desc\n\n# Filter by created_at[from]=2022-01-01&created_at[to]=2022-12-31\ncurl -H 'Authorization: Token YOUR_APP_TOKEN' \"https://api.coingate.com/v2/orders?created_at%5Bfrom%5D=2022-01-01&created_at%5Bto%5D=2022-12-31\"\n " } ], "samples-languages": [ "curl" ] } } }, "/orders/{id}/checkout": { "post": { "summary": "Checkout", "description": "Placing [created order](https://developer.coingate.com/reference/create-order) with pre-selected payment currency (BTC, LTC, ETH, etc). Display payment_address and pay_amount for shopper or redirect to payment_url. Can be used to white-label invoices.", "operationId": "checkout", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "CoinGate order ID", "schema": { "type": "integer", "default": "" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 10568600,\n \"status\": \"pending\",\n \"title\": \"Merchant Title\",\n \"do_not_convert\": false,\n \"orderable_type\": \"ApiApp\",\n \"orderable_id\": 2,\n \"uuid\": \"a8cb2e9b-359b-4105-aa66-c88f89455567\",\n \"payment_gateway\": \"coingate\",\n \"price_currency\": \"EUR\",\n \"price_amount\": \"0.2\",\n \"pay_currency\": \"BTC\",\n \"pay_amount\": \"0.00001225\",\n \"lightning_network\": false,\n \"receive_currency\": \"BTC\",\n \"receive_amount\": \"0\",\n \"created_at\": \"2024-09-19T11:04:53+00:00\",\n \"expire_at\": \"2024-09-19T11:25:13+00:00\",\n \"payment_address\": \"tb1qjye4n592z2zrn8k4984cqlx7v6qyns89dx6cxh\",\n \"order_id\": \"96\",\n \"payment_url\": \"https://pay.coingate.com/invoice/a8cb2e9b-359b-4105-aa66-c88f89455567\",\n \"underpaid_amount\": \"0.00001225\",\n \"overpaid_amount\": \"0\",\n \"is_refundable\": false,\n \"conversion_rate\": \"53088.0\",\n \"payment_request_uri\": \"bitcoin:tb1qjye4n592z2zrn8k4984cqlx7v6qyns89dx6cxh?amount=0.00001225\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"refunds\": [],\n \"voids\": [],\n \"fees\": [],\n \"blockchain_transactions\": []\n\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 10568600, "default": 0 }, "status": { "type": "string", "example": "pending" }, "title": { "type": "string", "example": "Merchant Title" }, "do_not_convert": { "type": "boolean", "example": false, "default": true }, "orderable_type": { "type": "string", "example": "ApiApp" }, "orderable_id": { "type": "integer", "example": 2, "default": 0 }, "uuid": { "type": "string", "example": "a8cb2e9b-359b-4105-aa66-c88f89455567" }, "payment_gateway": { "type": "string", "example": "coingate" }, "price_currency": { "type": "string", "example": "EUR" }, "price_amount": { "type": "string", "example": "0.2" }, "pay_currency": { "type": "string", "example": "BTC" }, "pay_amount": { "type": "string", "example": "0.00001225" }, "lightning_network": { "type": "boolean", "example": false, "default": true }, "receive_currency": { "type": "string", "example": "BTC" }, "receive_amount": { "type": "string", "example": "0" }, "created_at": { "type": "string", "example": "2024-09-19T11:04:53+00:00" }, "expire_at": { "type": "string", "example": "2024-09-19T11:25:13+00:00" }, "payment_address": { "type": "string", "example": "tb1qjye4n592z2zrn8k4984cqlx7v6qyns89dx6cxh" }, "order_id": { "type": "string", "example": "96" }, "payment_url": { "type": "string", "example": "https://pay.coingate.com/invoice/a8cb2e9b-359b-4105-aa66-c88f89455567" }, "underpaid_amount": { "type": "string", "example": "0.00001225" }, "overpaid_amount": { "type": "string", "example": "0" }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "conversion_rate": { "type": "string", "example": "53088.0" }, "payment_request_uri": { "type": "string", "example": "bitcoin:tb1qjye4n592z2zrn8k4984cqlx7v6qyns89dx6cxh?amount=0.00001225" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 6, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "id_name": { "type": "string", "example": "bitcoin" } } }, "refunds": { "type": "array" }, "voids": { "type": "array" }, "fees": { "type": "array" }, "blockchain_transactions": { "type": "array" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Order does not exist\",\n \"reason\": \"OrderNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Order does not exist" }, "reason": { "type": "string", "example": "OrderNotFound" } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl -X \"POST\" \"https://api.coingate.com/v2/orders/10568600/checkout\" \\\n -H 'Authorization: Token 1234' \\\n -H 'Content-Type: application/x-www-form-urlencoded; charset=utf-8' \\\n --data-urlencode \"pay_currency=ETH\" \\\n --data-urlencode \"platform_id=2\"\n" } ], "samples-languages": [ "curl" ] }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "pay_currency": { "type": "string", "description": "The currency symbol of the cryptocurrency used for payment (e.g., BTC, USDC, LTC). To retrieve the full [list of supported payment currencies](https://api.coingate.com/v2/currencies?native=true&enabled=true&merchant_pay=true). " }, "platform_id": { "type": "integer", "description": "The blockchain platform ID associated with the selected `pay_currency`. A [list of supported platforms](https://developer.coingate.com/reference/platforms) is available." } }, "type": "object", "required": [ "pay_currency", "platform_id" ] } } } } } }, "/orders/{id}": { "get": { "summary": "Get Order", "description": "", "operationId": "get-order", "parameters": [ { "name": "id", "in": "path", "description": "CoinGate Order id", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": 535, "status": "paid", "title": "test", "do_not_convert": false, "orderable_type": "Button", "orderable_id": 2, "price_currency": "EUR", "price_amount": "100.0", "pay_currency": "BTC", "pay_amount": "0.00489886", "lightning_network": false, "receive_currency": "USDT", "receive_amount": "99.758162", "created_at": "2022-12-06T10:58:21+00:00", "expire_at": "2022-12-06T11:18:25+00:00", "paid_at": "2022-12-06T10:58:31+00:00", "payment_address": "c9a71333-2ab9-4e66-a50d-d111f732cb08", "payment_gateway": "coingate", "order_id": "", "payment_url": "http://localhost:3000/invoice/68d7e03c-6bd0-401e-b9c3-f891709b88d8", "payment_request_uri": "bitcoin:3KCtuihM6uPmRDtpELfBmnt9hVRQ8G9tUX?amount=1.43", "underpaid_amount": "0.00489886", "overpaid_amount": "0", "is_refundable": false, "conversion_rate": "20566.0", "refunds": [ { "id": 8, "request_amount": "10.0", "refund_amount": "0.0004862", "address": "3CCV3GjNvQip5ewsHhzYc136WhaeCzHigj", "status": "pending", "memo": null, "created_at": "2022-12-06T11:01:50+00:00", "order": { "id": 535 }, "refund_currency": { "id": 1, "title": "Bitcoin", "symbol": "BTC", "platform": { "id": 5, "title": "Bitcoin" } }, "transactions": [], "ledger_account": { "id": "01GJZBH2JZF3E369HT9GVM71CE", "currency": { "id": 1, "title": "Bitcoin", "symbol": "BTC" } } } ], "voids": [], "fees": [ { "type": "processing_fee", "amount": "1.007658", "currency": { "id": 21, "symbol": "USDT" } } ], "blockchain_transactions": [ { "id": 123, "txid": "5c1a0a92-9a3d-4107-9a00-8d6a2a4b6620", "amount": "0.00001234", "status": "confirming", "network_confirmations": 0, "currency": { "id": 1, "title": "Bitcoin", "symbol": "BTC", "platform": { "id": 6, "title": "Bitcoin" } } } ], "ledger_transactions": [ { "id": "01KQYT8NNTDN5M185MWNNSKJBN", "type": "merchant_order", "credited_amount": "0", "debited_amount": "100.0", "purpose": "Order ID #535 100.0 EUR" }, { "id": "01KQYT8PNSPFF7ZW9B51RJ7QJ4", "type": "fee", "credited_amount": "1.007658", "debited_amount": "0", "purpose": "Order ID #535 processing fee 1.007658 USDT" } ] } } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 535, "default": 0 }, "status": { "type": "string", "example": "paid" }, "title": { "type": "string", "example": "test" }, "do_not_convert": { "type": "boolean", "example": false, "default": true }, "orderable_type": { "type": "string", "example": "Button" }, "orderable_id": { "type": "integer", "example": 2, "default": 0 }, "price_currency": { "type": "string", "example": "EUR" }, "price_amount": { "type": "string", "example": "100.0" }, "pay_currency": { "type": "string", "example": "BTC" }, "pay_amount": { "type": "string", "example": "0.00489886" }, "lightning_network": { "type": "boolean", "example": false, "default": true }, "receive_currency": { "type": "string", "example": "USDT" }, "receive_amount": { "type": "string", "example": "99.758162" }, "created_at": { "type": "string", "example": "2022-12-06T10:58:21+00:00" }, "expire_at": { "type": "string", "example": "2022-12-06T11:18:25+00:00" }, "paid_at": { "type": "string", "example": "2022-12-06T10:58:31+00:00" }, "payment_address": { "type": "string", "example": "c9a71333-2ab9-4e66-a50d-d111f732cb08" }, "payment_gateway": { "type": "string", "example": "coingate" }, "order_id": { "type": "string", "example": "" }, "payment_url": { "type": "string", "example": "http://localhost:3000/invoice/68d7e03c-6bd0-401e-b9c3-f891709b88d8" }, "payment_request_uri": { "type": "string", "example": "bitcoin:3KCtuihM6uPmRDtpELfBmnt9hVRQ8G9tUX?amount=1.43" }, "underpaid_amount": { "type": "string", "example": "0.00489886" }, "overpaid_amount": { "type": "string", "example": "0" }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "conversion_rate": { "type": "string", "example": "20566.0" }, "refunds": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 8, "default": 0 }, "request_amount": { "type": "string", "example": "10.0" }, "refund_amount": { "type": "string", "example": "0.0004862" }, "address": { "type": "string", "example": "3CCV3GjNvQip5ewsHhzYc136WhaeCzHigj" }, "status": { "type": "string", "example": "pending" }, "memo": {}, "created_at": { "type": "string", "example": "2022-12-06T11:01:50+00:00" }, "order": { "type": "object", "properties": { "id": { "type": "integer", "example": 535, "default": 0 } } }, "refund_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" } } } } }, "transactions": { "type": "array" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01GJZBH2JZF3E369HT9GVM71CE" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" } } } } } } } }, "voids": { "type": "array" }, "fees": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "processing_fee" }, "amount": { "type": "string", "example": "1.007658" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 21, "default": 0 }, "symbol": { "type": "string", "example": "USDT" } } } } } }, "blockchain_transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 123, "default": 0 }, "txid": { "type": "string", "example": "5c1a0a92-9a3d-4107-9a00-8d6a2a4b6620" }, "amount": { "type": "string", "example": "0.00001234" }, "status": { "type": "string", "example": "confirming" }, "network_confirmations": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 6, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" } } } } } } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Order not found\",\n \"reason\": \"OrderNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Order not found" }, "reason": { "type": "string", "example": "OrderNotFound" } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl -H \"Authorization: Token YOUR_APP_TOKEN\" https://api.coingate.com/v2/orders/1195824" } ], "samples-languages": [ "curl" ] } } }, "/orders/{order_id}/blockchain_transactions": { "get": { "summary": "Get Order Transactions", "description": "Retrieves all blockchain transactions for an order. Before making a GET Order Blockchain Transactions request, a [POST Create Order](/reference/create-order) request should be made. After an order is created, you will get the order ID which will be used in the GET Order Blockchain Transactions request.", "operationId": "get-order-transactions", "parameters": [ { "name": "order_id", "in": "path", "description": "ID of the order to get blockchain transactions", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number", "default": 1, "format": "int32" }, "per_page": { "type": "integer", "description": "Number of blockchain transactions per page", "default": 100, "format": "int32" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n\t\"current_page\": 1,\n\t\"per_page\": 100,\n\t\"total_transactions\": 1,\n\t\"total_pages\": 1,\n\t\"transactions\": [\n\t\t{\n\t\t\t\"id\": 123,\n\t\t\t\"txid\": \"5c1a0a92-,9a3d-4107-9a00-8d6a2a4b6620\",\n\t\t\t\"amount\": \"0.00001234\",\n\t\t\t\"status\": \"confirming\",\n\t\t\t\"network_confirmations\": 0,\n\t\t\t\"currency\": {\n\t\t\t\t\"id\": 1,\n\t\t\t\t\"title\": \"Bitcoin\",\n\t\t\t\t\"symbol\": \"BTC\",\n\t\t\t\t\"platform\": {\n\t\t\t\t\t\"id\": 6,\n\t\t\t\t\t\"title\": \"Bitcoin\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t]\n}" } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 100, "default": 0 }, "total_transactions": { "type": "integer", "example": 1, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 123, "default": 0 }, "txid": { "type": "string", "example": "5c1a0a92-,9a3d-4107-9a00-8d6a2a4b6620" }, "amount": { "type": "string", "example": "0.00001234" }, "status": { "type": "string", "example": "confirming" }, "network_confirmations": { "type": "integer", "example": 0, "default": 0 }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 6, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" } } } } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/orders/{order_id}/blockchain_transactions/:id": { "get": { "summary": "Get Order Transaction", "description": "Retrieves a single order blockchain transaction for an order. Before making a GET Order Blockchain Transaction request, a [POST Create Order](/reference/create-order) request should be made. After an order is created, you will get the order ID which will be used in the GET Order Blockchain Transaction request.", "operationId": "get-order-transaction", "parameters": [ { "name": "order_id", "in": "path", "description": "ID of the order to get blockchain transactions", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": ":blockchain_transaction_id", "in": "path", "description": "Transaction ID of blockchain transaction in order information", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n\t\"id\": 123,\n\t\"txid\": \"5c1a0a92-9a3d-4107-9a00-8d6a2a4b6620\",\n\t\"amount\": \"0.00001234\",\n\t\"status\": \"confirming\",\n\t\"network_confirmations\": 6,\n\t\"currency\": {\n\t\t\"id\": 1,\n\t\t\"title\": \"Bitcoin\",\n\t\t\"symbol\": \"BTC\",\n\t\t\"platform\": {\n\t\t\t\"id\": 6,\n\t\t\t\"title\": \"Bitcoin\"\n\t\t}\n\t}\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 123, "default": 0 }, "txid": { "type": "string", "example": "5c1a0a92-9a3d-4107-9a00-8d6a2a4b6620" }, "amount": { "type": "string", "example": "0.00001234" }, "status": { "type": "string", "example": "confirming" }, "network_confirmations": { "type": "integer", "example": 6, "default": 0 }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 6, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/orders/{id}/binance/checkout": { "post": { "summary": "Checkout", "description": "", "operationId": "binance-checkout", "parameters": [ { "name": "id", "in": "path", "description": "ID of the order to be processed through Binance Pay", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "purchaser_email": { "type": "string", "description": "Email address of the purchaser (payee) provided will be pre-filled on the invoice." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 10568600,\n \"status\": \"pending\",\n \"title\": null,\n \"do_not_convert\": false,\n \"orderable_type\": \"ApiApp\",\n \"orderable_id\": 44,\n \"payment_gateway\": \"binance\",\n \"price_currency\": \"USD\",\n \"price_amount\": \"100.0\",\n \"pay_currency\": \"BUSD\",\n \"pay_amount\": \"101.7527\",\n \"lightning_network\": false,\n \"receive_currency\": \"USD\",\n \"receive_amount\": \"0\",\n \"created_at\": \"2023-04-19T11:56:47+00:00\",\n \"expire_at\": \"2023-04-19T12:18:56+00:00\",\n \"order_id\": \"\",\n \"payment_url\": \"https://pay.coingate.com/invoice/fad0f947-cb29-451e-8fdb-290a8d3c05bf\",\n \"underpaid_amount\": \"0\",\n \"overpaid_amount\": \"0\",\n \"is_refundable\": false,\n \"conversion_rate\": \"0.9999\",\n \"refunds\": [],\n \"voids\": [],\n \"fees\": [],\n \"binance\": {\n \"qr_code_link\": \"https://public.bnbstatic.com/static/payment/20230419/c1f93152-eb86-4a84-b22a-93a022847ad1.jpg\",\n \"qr_content\": \"https://app.binance.com/qr/dplk72ef8779aa5d4ea5a6f3ae109caeadba\",\n \"checkout_url\": \"https://pay.binance.com/en/checkout/f49488c95153402a882b792ec9e35a9c\",\n \"deep_link\": \"bnc://app.binance.com/payment/secpay?tempToken=3jfhFunnFwqnPFTm3EEGME3GNkxCWjUZ&returnLink=https://testing.requestcatcher.com/test&cancelLink=https://testing.requestcatcher.com/test\",\n \"universal_url\": \"https://app.binance.com/payment/secpay?linkToken=f49488c95153402a882b792ec9e35a9c&_dp=Ym5jOi8vYXBwLmJpbmFuY2UuY29tL3BheW1lbnQvc2VjcGF5P3RlbXBUb2tlbj0zamZoRnVubkZ3cW5QRlRtM0VFR01FM0dOa3hDV2pVWiZyZXR1cm5MaW5rPWh0dHBzOi8vdGVzdGluZy5yZXF1ZXN0Y2F0Y2hlci5jb20vdGVzdCZjYW5jZWxMaW5rPWh0dHBzOi8vdGVzdGluZy5yZXF1ZXN0Y2F0Y2hlci5jb20vdGVzdA\"\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 10568600, "default": 0 }, "status": { "type": "string", "example": "pending" }, "title": {}, "do_not_convert": { "type": "boolean", "example": false, "default": true }, "orderable_type": { "type": "string", "example": "ApiApp" }, "orderable_id": { "type": "integer", "example": 44, "default": 0 }, "payment_gateway": { "type": "string", "example": "binance" }, "price_currency": { "type": "string", "example": "USD" }, "price_amount": { "type": "string", "example": "100.0" }, "pay_currency": { "type": "string", "example": "BUSD" }, "pay_amount": { "type": "string", "example": "101.7527" }, "lightning_network": { "type": "boolean", "example": false, "default": true }, "receive_currency": { "type": "string", "example": "USD" }, "receive_amount": { "type": "string", "example": "0" }, "created_at": { "type": "string", "example": "2023-04-19T11:56:47+00:00" }, "expire_at": { "type": "string", "example": "2023-04-19T12:18:56+00:00" }, "order_id": { "type": "string", "example": "" }, "payment_url": { "type": "string", "example": "https://pay.coingate.com/invoice/fad0f947-cb29-451e-8fdb-290a8d3c05bf" }, "underpaid_amount": { "type": "string", "example": "0" }, "overpaid_amount": { "type": "string", "example": "0" }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "conversion_rate": { "type": "string", "example": "0.9999" }, "refunds": { "type": "array" }, "voids": { "type": "array" }, "fees": { "type": "array" }, "binance": { "type": "object", "properties": { "qr_code_link": { "type": "string", "example": "https://public.bnbstatic.com/static/payment/20230419/c1f93152-eb86-4a84-b22a-93a022847ad1.jpg" }, "qr_content": { "type": "string", "example": "https://app.binance.com/qr/dplk72ef8779aa5d4ea5a6f3ae109caeadba" }, "checkout_url": { "type": "string", "example": "https://pay.binance.com/en/checkout/f49488c95153402a882b792ec9e35a9c" }, "deep_link": { "type": "string", "example": "bnc://app.binance.com/payment/secpay?tempToken=3jfhFunnFwqnPFTm3EEGME3GNkxCWjUZ&returnLink=https://testing.requestcatcher.com/test&cancelLink=https://testing.requestcatcher.com/test" }, "universal_url": { "type": "string", "example": "https://app.binance.com/payment/secpay?linkToken=f49488c95153402a882b792ec9e35a9c&_dp=Ym5jOi8vYXBwLmJpbmFuY2UuY29tL3BheW1lbnQvc2VjcGF5P3RlbXBUb2tlbj0zamZoRnVubkZ3cW5QRlRtM0VFR01FM0dOa3hDV2pVWiZyZXR1cm5MaW5rPWh0dHBzOi8vdGVzdGluZy5yZXF1ZXN0Y2F0Y2hlci5jb20vdGVzdCZjYW5jZWxMaW5rPWh0dHBzOi8vdGVzdGluZy5yZXF1ZXN0Y2F0Y2hlci5jb20vdGVzdA" } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Order is not valid\",\n \"reason\": \"OrderIsNotValid\",\n \"errors\": [\n \"Order already settled\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Order is not valid" }, "reason": { "type": "string", "example": "OrderIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Order already settled" } } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl -X \"POST\" \"https://api.coingate.com/v2/orders/10568600/binance/checkout\" \\\n -H 'Authorization: Token 1234' \\\n -H 'Content-Type: application/x-www-form-urlencoded; charset=utf-8' \\\n --data-urlencode \"purchaser_email=shopperEmail@sample.com\" " } ], "samples-languages": [ "curl" ] } } }, "/orders/{id}/binance/cancel": { "post": { "summary": "Cancel Order", "description": "Cancels a Binance payment order from the merchant’s side. This stops the payment process and updates the CoinGate order’s status to canceled.", "operationId": "binance-cancel", "parameters": [ { "name": "id", "in": "path", "description": "ID of the order to be cancelled", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 10568600,\n \"status\": \"canceled\",\n \"title\": null,\n \"do_not_convert\": false,\n \"orderable_type\": \"ApiApp\",\n \"orderable_id\": 44,\n \"payment_gateway\": \"binance\",\n \"price_currency\": \"USD\",\n \"price_amount\": \"100.0\",\n \"pay_currency\": \"BUSD\",\n \"pay_amount\": \"101.7527\",\n \"lightning_network\": false,\n \"receive_currency\": \"USD\",\n \"receive_amount\": \"0\",\n \"created_at\": \"2023-04-19T11:56:47+00:00\",\n \"expire_at\": \"2023-04-19T12:18:56+00:00\",\n \"order_id\": \"\",\n \"payment_url\": \"https://pay.coingate.com/invoice/fad0f947-cb29-451e-8fdb-290a8d3c05bf\",\n \"underpaid_amount\": \"0\",\n \"overpaid_amount\": \"0\",\n \"is_refundable\": false,\n \"conversion_rate\": \"0.9999\",\n \"refunds\": [],\n \"voids\": [],\n \"fees\": []\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 10568600, "default": 0 }, "status": { "type": "string", "example": "canceled" }, "title": {}, "do_not_convert": { "type": "boolean", "example": false, "default": true }, "orderable_type": { "type": "string", "example": "ApiApp" }, "orderable_id": { "type": "integer", "example": 44, "default": 0 }, "payment_gateway": { "type": "string", "example": "binance" }, "price_currency": { "type": "string", "example": "USD" }, "price_amount": { "type": "string", "example": "100.0" }, "pay_currency": { "type": "string", "example": "BUSD" }, "pay_amount": { "type": "string", "example": "101.7527" }, "lightning_network": { "type": "boolean", "example": false, "default": true }, "receive_currency": { "type": "string", "example": "USD" }, "receive_amount": { "type": "string", "example": "0" }, "created_at": { "type": "string", "example": "2023-04-19T11:56:47+00:00" }, "expire_at": { "type": "string", "example": "2023-04-19T12:18:56+00:00" }, "order_id": { "type": "string", "example": "" }, "payment_url": { "type": "string", "example": "https://pay.coingate.com/invoice/fad0f947-cb29-451e-8fdb-290a8d3c05bf" }, "underpaid_amount": { "type": "string", "example": "0" }, "overpaid_amount": { "type": "string", "example": "0" }, "is_refundable": { "type": "boolean", "example": false, "default": true }, "conversion_rate": { "type": "string", "example": "0.9999" }, "refunds": { "type": "array" }, "voids": { "type": "array" }, "fees": { "type": "array" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Order is not valid\",\n \"reason\": \"OrderIsNotValid\",\n \"errors\": \"Status must be pending to cancel the order\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Order is not valid" }, "reason": { "type": "string", "example": "OrderIsNotValid" }, "errors": { "type": "string", "example": "Status must be pending to cancel the order" } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl -X \"POST\" \"https://api.coingate.com/v2/orders/10568600/binance/cancel\" \\\n -H 'Authorization: Token 1234' " } ], "samples-languages": [ "curl" ] } } }, "/orders/{id}/binance/refund": { "post": { "summary": "Refund Binance Order", "description": "", "operationId": "create-binance-order-refund", "parameters": [ { "name": "id", "in": "path", "description": "ID of the order to be refunded", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "amount", "reason", "email", "ledger_account_id" ], "properties": { "amount": { "type": "number", "description": "Requesting amount in order price currency to refund", "format": "double" }, "reason": { "type": "string", "description": "Reason for issuing the refund" }, "email": { "type": "string", "description": "Customer will receive updates on refund status to this email" }, "ledger_account_id": { "type": "string", "description": "ID of the trader balance associated with the currency in which the refund will be issued" }, "callback_url": { "type": "string", "description": "Send an automated message to Merchant URL when refund status is changed. For testing you can use requestcatcher.com tool. URL must be direct without redirection. Read about refund callbacks [here](/reference/refund-callback)." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 3,\n \"request_amount\": \"1.0\",\n \"refund_amount\": \"1.0892\",\n \"address\": null,\n \"status\": \"pending\",\n \"memo\": null,\n \"balance_debit_amount\": \"0.0000198\",\n \"callback_url\": \"https://testrefund.requestcatcher.com/test\",\n \"skip_user_address_confirmation\": null,\n \"created_at\": \"2024-09-26T13:38:56+00:00\",\n \"updated_at\": \"2024-09-26T13:38:56+00:00\",\n \"processor\": \"binance\",\n \"binance_refund_id\": 3,\n \"order\": {\n \"id\": 29,\n \"title\": \"Testing Order\",\n \"price_amount\": \"10.0\",\n \"created_at\": \"2024-06-20T10:36:07+00:00\",\n \"paid_at\": \"2024-06-20T10:51:34+00:00\",\n \"price_currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\"\n }\n },\n \"balance_debit_currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n },\n \"refund_currency\": {\n \"id\": 34,\n \"title\": \"USDC\",\n \"symbol\": \"USDC\"\n },\n \"transactions\": [],\n \"fees\": {\n \"service_fee\": {\n \"amount\": \"0.00000497\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n },\n \"ledger_account\": {\n \"id\": \"01HP6X6EP5YG76EQPTFBRWD6Y9\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\"\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 3, "default": 0 }, "request_amount": { "type": "string", "example": "1.0" }, "refund_amount": { "type": "string", "example": "1.0892" }, "address": {}, "status": { "type": "string", "example": "pending" }, "memo": {}, "balance_debit_amount": { "type": "string", "example": "0.0000198" }, "callback_url": { "type": "string", "example": "https://testrefund.requestcatcher.com/test" }, "skip_user_address_confirmation": {}, "created_at": { "type": "string", "example": "2024-09-26T13:38:56+00:00" }, "updated_at": { "type": "string", "example": "2024-09-26T13:38:56+00:00" }, "processor": { "type": "string", "example": "binance" }, "binance_refund_id": { "type": "integer", "example": 3, "default": 0 }, "order": { "type": "object", "properties": { "id": { "type": "integer", "example": 29, "default": 0 }, "title": { "type": "string", "example": "Testing Order" }, "price_amount": { "type": "string", "example": "10.0" }, "created_at": { "type": "string", "example": "2024-06-20T10:36:07+00:00" }, "paid_at": { "type": "string", "example": "2024-06-20T10:51:34+00:00" }, "price_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } } } }, "balance_debit_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "refund_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 34, "default": 0 }, "title": { "type": "string", "example": "USDC" }, "symbol": { "type": "string", "example": "USDC" } } }, "transactions": { "type": "array" }, "fees": { "type": "object", "properties": { "service_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00000497" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } } } }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01HP6X6EP5YG76EQPTFBRWD6Y9" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" } } } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n\t\"message\": \"Refund is not valid\",\n\t\"reason\": \"RefundIsNotValid\",\n\t\"errors\": [\n\t\t\"Request amount can't be blank\",\n\t\t\"Request amount must be higher than 1.0 EUR\",\n\t\t\"Request amount is not a number\",\n\t\t\"Refund amount can't be blank\",\n\t\t\"Refund amount is not a number\",\n\t\t\"Balance debit amount can't be blank\",\n\t\t\"Balance debit amount is not a number\"\n\t]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Refund is not valid" }, "reason": { "type": "string", "example": "RefundIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Request amount can't be blank" } } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl -X \"POST\" \"https://api.coingate.com/v2/orders/:id/binance/refund\" \\\n -H 'Authorization: Token 1234' \\\n -H 'Content-Type: application/x-www-form-urlencoded; charset=utf-8' \\\n--data-urlencode \"amount=0.00005\" \\\n--data-urlencode \"email=shopperEmail@sampleshopperemail.com\" \\\n--data-urlencode \"reason=Reason\" \\\n--data-urlencode \"ledger_account_id=01H0PZMJ3BX29DGW86ESX0HNXW\"" } ], "samples-languages": [ "curl" ] } } }, "/orders/{order_id}/refunds": { "post": { "summary": "Create Order Refund", "description": "", "operationId": "create-refund", "parameters": [ { "name": "order_id", "in": "path", "description": "ID of the order to be refunded", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "amount", "address", "currency_id", "platform_id", "reason", "email", "ledger_account_id" ], "properties": { "amount": { "type": "number", "description": "Requesting amount in order price currency to refund", "format": "double" }, "address": { "type": "string", "description": "Cryptocurrency address to which the refund will be sent" }, "address_memo": { "type": "string" }, "currency_id": { "type": "integer", "description": "ID of the currency in which the refund will be issued. [Supported refund currencies](https://developer.coingate.com/reference/refund-supported-currencies).", "format": "int32" }, "platform_id": { "type": "integer", "description": "Platform ID associated with the selected refund currency. [Supported refund platforms](https://developer.coingate.com/reference/refund-supported-currencies).", "format": "int32" }, "reason": { "type": "string", "description": "Reason for issuing the refund" }, "email": { "type": "string", "description": "Customer will receive updates on refund status to this email" }, "ledger_account_id": { "type": "string", "description": "Specifies the ledger balance from which the refund amount will be deducted. If the ledger account currency differs from the refund currency (currency_id), a conversion will be applied automatically. Learn more here: [Merchant refund conversions](coingate.com/blog/post/merchant-refund). API endpoint to list all ledger accounts: [API Ledger Overview](https://developer.coingate.com/reference/ledger-overview)." }, "callback_url": { "type": "string", "description": "Send an automated message to Merchant URL when refund status is changed. For testing you can use requestcatcher.com tool. URL must be direct without redirection. Read about refund callbacks [here](/reference/refund-callback)." }, "skip_user_address_confirmation": { "type": "boolean", "description": "You confirm that refund address is correct and email to confirm crypto address will not be sent to the shopper email.", "default": false } } }, "examples": { "Request Example": { "value": { "amount": 50, "address": "tb1qparagdh9h884lptjmlt20ugc05xrvhu32qa05z6", "currency_id": 1, "platform_id": 5, "reason": "Reason", "email": "example@example.com", "ledger_account_id": "01G130Q2T06NYKC9F3STKANAD1" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\":2,\n \"request_amount\":\"1.0\",\n \"refund_amount\":\"1.0553\",\n \"address\":\"0x165E05749951AB88B5F17bd1f2080eC3dFB442E6\",\n \"status\":\"pending\",\n \"memo\":null,\n \"created_at\":\"2022-05-04T13:30:38+00:00\",\n \"updated_at\":\"2022-05-04T13:30:38+00:00\",\n \"skip_user_address_confirmation\": true,\n \"processor\": \"coingate\",\t\t\n\t \"binance_refund_id\": null,\n \"order\":{\n \"id\":11874016,\n \"title\":null,\n \"price_amount\":\"2.0\",\n \"created_at\":\"2022-05-04T10:50:01+00:00\",\n \"price_currency\":{\n \"id\":11,\n \"title\":\"Euro\",\n \"kind\":\"fiat\",\n \"symbol\":\"EUR\"\n }\n },\n \"refund_currency\":{\n \"id\":97,\n \"title\":\"Tether\",\n \"symbol\":\"USDT\",\n \"platform\":{\n \"id\":1,\n \"title\":\"Ethereum\"\n }\n },\n \"transactions\":[],\n \"ledger_account\":{\n \"id\":\"01G27GBKX653FKV2S0SCXXDBES\",\n \"currency\":{\n \"id\":97,\n \"title\":\"Tether\",\n \"symbol\":\"USDT\"\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "request_amount": { "type": "string", "example": "1.0" }, "refund_amount": { "type": "string", "example": "1.0553" }, "address": { "type": "string", "example": "0x165E05749951AB88B5F17bd1f2080eC3dFB442E6" }, "status": { "type": "string", "example": "pending" }, "memo": {}, "created_at": { "type": "string", "example": "2022-05-04T13:30:38+00:00" }, "updated_at": { "type": "string", "example": "2022-05-04T13:30:38+00:00" }, "skip_user_address_confirmation": { "type": "boolean", "example": true, "default": true }, "processor": { "type": "string", "example": "coingate" }, "binance_refund_id": {}, "order": { "type": "object", "properties": { "id": { "type": "integer", "example": 11874016, "default": 0 }, "title": {}, "price_amount": { "type": "string", "example": "2.0" }, "created_at": { "type": "string", "example": "2022-05-04T10:50:01+00:00" }, "price_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 11, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } } } }, "refund_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 97, "default": 0 }, "title": { "type": "string", "example": "Tether" }, "symbol": { "type": "string", "example": "USDT" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Ethereum" } } } } }, "transactions": { "type": "array" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01G27GBKX653FKV2S0SCXXDBES" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 97, "default": 0 }, "title": { "type": "string", "example": "Tether" }, "symbol": { "type": "string", "example": "USDT" } } } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n\t\"message\": \"Refund is not valid\",\n\t\"reason\": \"RefundIsNotValid\",\n\t\"errors\": [\n\t\t\"Request amount can't be blank\",\n\t\t\"Request amount must be higher than 1.0 EUR\",\n\t\t\"Request amount is not a number\",\n\t\t\"Refund amount can't be blank\",\n\t\t\"Refund amount is not a number\",\n\t\t\"Balance debit amount can't be blank\",\n\t\t\"Balance debit amount is not a number\",\n \"Skip user address confirmation must be boolean or not present\"\n\t]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Refund is not valid" }, "reason": { "type": "string", "example": "RefundIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Request amount can't be blank" } } } } } } } }, "deprecated": false }, "get": { "summary": "Get Order Refunds", "description": "Retrieves all refunds for an order.\n\nBefore making a GET Order Refunds request, a [POST Create Order](/reference/create-order) request should be made. \n\nAfter an order is created, you will get the order ID which will be used in the GET Order Refunds request.", "operationId": "get-refund", "parameters": [ { "name": "order_id", "in": "path", "description": "ID of the order to be refunded", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number", "default": 1, "format": "int32" }, "per_page": { "type": "integer", "description": "Number of refunds per page", "default": 100, "format": "int32" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "current_page": 1, "per_page": 100, "total_refunds": 2, "total_pages": 1, "refunds": [ { "id": 3, "request_amount": "1.0", "refund_amount": "1.0553", "address": "0x165E05749951AB88B5F17bd1f2080eC3dFB442E6", "status": "rejected", "memo": null, "skip_user_address_confirmation": false, "created_at": "2022-05-04T13:30:38+00:00", "updated_at": "2022-05-04T13:30:38+00:00", "order": { "id": 11874016, "title": null, "price_amount": "2.0", "created_at": "2022-05-04T10:50:01+00:00", "processor": "coingate", "binance_refund_id": null, "price_currency": { "id": 11, "title": "Euro", "kind": "fiat", "symbol": "EUR" } }, "refund_currency": { "id": 97, "title": "Tether", "symbol": "USDT", "platform": { "id": 1, "title": "Ethereum" } }, "transactions": [], "ledger_account": { "id": "01G27GBKX653FKV2S0SCXXDBES", "currency": { "id": 97, "title": "Tether", "symbol": "USDT" } }, "rejection_type": "shopper", "rejection_reason": "Shopper did not complete email verification in time." }, { "id": 2, "request_amount": "1.0", "refund_amount": "1.0553", "address": "0x165E05749951AB88B5F17bd1f2080eC3dFB442E6", "status": "pending", "memo": null, "skip_user_address_confirmation": true, "created_at": "2022-05-04T13:30:38+00:00", "updated_at": "2022-05-04T13:30:38+00:00", "order": { "id": 11874016, "title": null, "price_amount": "2.0", "created_at": "2022-05-04T10:50:01+00:00", "processor": "coingate", "binance_refund_id": null, "price_currency": { "id": 11, "title": "Euro", "kind": "fiat", "symbol": "EUR" } }, "refund_currency": { "id": 97, "title": "Tether", "symbol": "USDT", "platform": { "id": 1, "title": "Ethereum" } }, "transactions": [], "ledger_account": { "id": "01G27GBKX653FKV2S0SCXXDBES", "currency": { "id": 97, "title": "Tether", "symbol": "USDT" } } }, { "id": 1, "request_amount": "1.0", "refund_amount": "1.0541", "address": "0x165E05749951AB88B5F17bd1f2080eC3dFB442E6", "status": "completed", "memo": null, "created_at": "2022-05-04T12:33:33+00:00", "updated_at": "2022-05-04T13:33:33+00:00", "processor": "coingate", "binance_refund_id": null, "order": { "id": 11874016, "title": null, "price_amount": "2.0", "created_at": "2022-05-04T10:50:01+00:00", "price_currency": { "id": 11, "title": "Euro", "kind": "fiat", "symbol": "EUR" } }, "refund_currency": { "id": 97, "title": "Tether", "symbol": "USDT", "platform": { "id": 1, "title": "Ethereum" } }, "transactions": [], "ledger_account": { "id": "01G27GBKX653FKV2S0SCXXDBES", "currency": { "id": 97, "title": "Tether", "symbol": "USDT" } } } ] } } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 100, "default": 0 }, "total_refunds": { "type": "integer", "example": 2, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 }, "refunds": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "request_amount": { "type": "string", "example": "1.0" }, "refund_amount": { "type": "string", "example": "1.0553" }, "address": { "type": "string", "example": "0x165E05749951AB88B5F17bd1f2080eC3dFB442E6" }, "status": { "type": "string", "example": "pending" }, "memo": {}, "skip_user_address_confirmation": { "type": "boolean", "example": true, "default": true }, "created_at": { "type": "string", "example": "2022-05-04T13:30:38+00:00" }, "updated_at": { "type": "string", "example": "2022-05-04T13:30:38+00:00" }, "order": { "type": "object", "properties": { "id": { "type": "integer", "example": 11874016, "default": 0 }, "title": {}, "price_amount": { "type": "string", "example": "2.0" }, "created_at": { "type": "string", "example": "2022-05-04T10:50:01+00:00" }, "processor": { "type": "string", "example": "coingate" }, "binance_refund_id": {}, "price_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 11, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } } } }, "refund_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 97, "default": 0 }, "title": { "type": "string", "example": "Tether" }, "symbol": { "type": "string", "example": "USDT" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Ethereum" } } } } }, "transactions": { "type": "array" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01G27GBKX653FKV2S0SCXXDBES" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 97, "default": 0 }, "title": { "type": "string", "example": "Tether" }, "symbol": { "type": "string", "example": "USDT" } } } } }, "rejection_type": { "type": "string" }, "rejection_reason": { "type": "string" } } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Order not found\",\n \"reason\": \"OrderNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Order not found" }, "reason": { "type": "string", "example": "OrderNotFound" } } } } } } }, "deprecated": false } }, "/orders/{order_id}/refunds/{id}": { "get": { "summary": "Get Order Refund", "description": "Retrieves a specific refund for an order.\n\nBefore making a GET Order Refund request, a [POST Create Order](/reference/create-order) request should be made. \n\nAfter an order is created, you will get the order ID which will be used in the GET Order Refund request.\n\nBefore making a GET Order Refund request, a [POST Create Order Refund](/reference/create-refund) request should be made.\n\nAfter creating a refund for an order, you will get the refund ID which will be used in the GET Order Refund request.", "operationId": "get-order-refund", "parameters": [ { "name": "order_id", "in": "path", "description": "ID of the order to be refunded", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "ID of the refund", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": 2, "request_amount": "1.0", "refund_amount": "1.0553", "address": "0x165E05749951AB88B5F17bd1f2080eC3dFB442E6", "status": "pending", "skip_user_address_confirmation": true, "memo": null, "created_at": "2022-05-04T13:30:38+00:00", "updated_at": "2022-05-04T13:30:38+00:00", "order": { "id": 11874016, "title": null, "price_amount": "2.0", "created_at": "2022-05-04T10:50:01+00:00", "processor": "coingate", "binance_refund_id": null, "price_currency": { "id": 11, "title": "Euro", "kind": "fiat", "symbol": "EUR" } }, "refund_currency": { "id": 97, "title": "Tether", "symbol": "USDT", "platform": { "id": 1, "title": "Ethereum" } }, "transactions": [], "ledger_account": { "id": "01G27GBKX653FKV2S0SCXXDBES", "currency": { "id": 97, "title": "Tether", "symbol": "USDT" } }, "rejection_type": "shopper", "rejection_reason": "Shopper did not complete email verification in time." } } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "request_amount": { "type": "string", "example": "1.0" }, "refund_amount": { "type": "string", "example": "1.0553" }, "address": { "type": "string", "example": "0x165E05749951AB88B5F17bd1f2080eC3dFB442E6" }, "status": { "type": "string", "example": "pending" }, "skip_user_address_confirmation": { "type": "boolean", "example": true, "default": true }, "memo": {}, "created_at": { "type": "string", "example": "2022-05-04T13:30:38+00:00" }, "updated_at": { "type": "string", "example": "2022-05-04T13:30:38+00:00" }, "order": { "type": "object", "properties": { "id": { "type": "integer", "example": 11874016, "default": 0 }, "title": {}, "price_amount": { "type": "string", "example": "2.0" }, "created_at": { "type": "string", "example": "2022-05-04T10:50:01+00:00" }, "processor": { "type": "string", "example": "coingate" }, "binance_refund_id": {}, "price_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 11, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } } } }, "refund_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 97, "default": 0 }, "title": { "type": "string", "example": "Tether" }, "symbol": { "type": "string", "example": "USDT" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Ethereum" } } } } }, "transactions": { "type": "array" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01G27GBKX653FKV2S0SCXXDBES" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 97, "default": 0 }, "title": { "type": "string", "example": "Tether" }, "symbol": { "type": "string", "example": "USDT" } } } } }, "rejection_type": { "type": "string", "example": "The refund cannot be processed due to exceeded information submission timeframe." }, "rejection_reason": { "type": "string" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Refund not found\",\n \"reason\": \"RefundNotFound\"\n}" } }, "schema": { "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "example": "Order not found" }, "reason": { "type": "string", "example": "OrderNotFound" } } }, { "type": "object", "properties": { "message": { "type": "string", "example": "Refund not found" }, "reason": { "type": "string", "example": "RefundNotFound" } } } ] } } } } }, "deprecated": false } }, "/refunds": { "get": { "summary": "Get Refunds", "description": "", "operationId": "get-refunds", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page number", "default": 1, "format": "int32" }, "per_page": { "type": "integer", "description": "Number of refunds per page (max - 100)", "default": 100, "format": "int32" }, "created_at": { "properties": { "from": { "type": "string", "description": "Optional. Where refund creation time is equal or greater. Example: 2018-09-01" }, "to": { "type": "string", "description": "Optional. Where refund creation time is equal or less. Example: 2018-09-30" } }, "required": [], "type": "object" }, "updated_at": { "properties": { "from": { "type": "string", "description": "Optional. Where refund updated time is equal or greater. Example: 2018-09-01" }, "at": { "type": "string", "description": "Optional. Where refund updated time is equal or less. Example: 2018-09-30" } }, "required": [], "type": "object" }, "sort": { "type": "string", "description": "Sort orders by field. Available sort options: created_at_asc, created_at_desc, updated_at_asc, updated_at_desc. Default: created_at_desc.", "default": "created_at_desc" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "current_page": 1, "per_page": 100, "total_refunds": 2, "total_pages": 1, "refunds": [ { "id": 3, "request_amount": "1.0", "refund_amount": "1.0553", "address": "0x165E05749951AB88B5F17bd1f2080eC3dFB442E6", "status": "rejected", "memo": null, "skip_user_address_confirmation": false, "created_at": "2022-05-04T13:30:38+00:00", "updated_at": "2022-05-04T13:30:38+00:00", "order": { "id": 11874016, "title": null, "price_amount": "2.0", "created_at": "2022-05-04T10:50:01+00:00", "processor": "coingate", "binance_refund_id": null, "price_currency": { "id": 11, "title": "Euro", "kind": "fiat", "symbol": "EUR" } }, "refund_currency": { "id": 97, "title": "Tether", "symbol": "USDT", "platform": { "id": 1, "title": "Ethereum" } }, "transactions": [], "ledger_account": { "id": "01G27GBKX653FKV2S0SCXXDBES", "currency": { "id": 97, "title": "Tether", "symbol": "USDT" } }, "rejection_type": "shopper", "rejection_reason": "Shopper did not complete email verification in time." }, { "id": 2, "request_amount": "1.0", "refund_amount": "1.0553", "address": "0x165E05749951AB88B5F17bd1f2080eC3dFB442E6", "status": "pending", "memo": null, "created_at": "2022-05-04T13:30:38+00:00", "updated_at": "2022-05-04T13:30:38+00:00", "processor": "coingate", "binance_refund_id": null, "order": { "id": 11874016, "title": null, "price_amount": "2.0", "created_at": "2022-05-04T10:50:01+00:00", "price_currency": { "id": 11, "title": "Euro", "kind": "fiat", "symbol": "EUR" } }, "refund_currency": { "id": 97, "title": "Tether", "symbol": "USDT", "platform": { "id": 1, "title": "Ethereum" } }, "transactions": [], "ledger_account": { "id": "01G27GBKX653FKV2S0SCXXDBES", "currency": { "id": 97, "title": "Tether", "symbol": "USDT" } } }, { "id": 1, "request_amount": "1.0", "refund_amount": "1.0541", "address": "0x165E05749951AB88B5F17bd1f2080eC3dFB442E6", "status": "completed", "memo": null, "created_at": "2022-05-04T12:33:33+00:00", "updated_at": "2022-05-04T13:33:33+00:00", "order": { "id": 11874016, "title": null, "price_amount": "2.0", "created_at": "2022-05-04T10:50:01+00:00", "processor": "coingate", "binance_refund_id": null, "price_currency": { "id": 11, "title": "Euro", "kind": "fiat", "symbol": "EUR" } }, "refund_currency": { "id": 97, "title": "Tether", "symbol": "USDT", "platform": { "id": 1, "title": "Ethereum" } }, "transactions": [], "ledger_account": { "id": "01G27GBKX653FKV2S0SCXXDBES", "currency": { "id": 97, "title": "Tether", "symbol": "USDT" } } } ] } } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 100, "default": 0 }, "total_refunds": { "type": "integer", "example": 2, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 }, "refunds": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "request_amount": { "type": "string", "example": "1.0" }, "refund_amount": { "type": "string", "example": "1.0553" }, "address": { "type": "string", "example": "0x165E05749951AB88B5F17bd1f2080eC3dFB442E6" }, "status": { "type": "string", "example": "pending" }, "memo": {}, "created_at": { "type": "string", "example": "2022-05-04T13:30:38+00:00" }, "updated_at": { "type": "string", "example": "2022-05-04T13:30:38+00:00" }, "processor": { "type": "string", "example": "coingate" }, "binance_refund_id": {}, "order": { "type": "object", "properties": { "id": { "type": "integer", "example": 11874016, "default": 0 }, "title": {}, "price_amount": { "type": "string", "example": "2.0" }, "created_at": { "type": "string", "example": "2022-05-04T10:50:01+00:00" }, "price_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 11, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } } } }, "refund_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 97, "default": 0 }, "title": { "type": "string", "example": "Tether" }, "symbol": { "type": "string", "example": "USDT" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Ethereum" } } } } }, "transactions": { "type": "array" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01G27GBKX653FKV2S0SCXXDBES" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 97, "default": 0 }, "title": { "type": "string", "example": "Tether" }, "symbol": { "type": "string", "example": "USDT" } } } } }, "rejection_type": { "type": "string" }, "rejection_reason": { "type": "string" } } } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n\t\"message\": \"Auth Token is not valid\",\n\t\"reason\": \"BadAuthToken\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Auth Token is not valid" }, "reason": { "type": "string", "example": "BadAuthToken" } } } } } } }, "deprecated": false } }, "/refunds/supported-currencies": { "get": { "summary": "Supported Currencies", "description": "", "operationId": "refund-supported-currencies", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"id\":8,\n \"title\":\"Bitcoin\",\n \"kind\":\"crypto\",\n \"symbol\":\"BTC\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":5,\n \"id_name\":\"bitcoin\",\n \"title\":\"Bitcoin\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":11,\n \"title\":\"Euro\",\n \"kind\":\"fiat\",\n \"symbol\":\"EUR\",\n \"enabled\":true,\n \"disabled_message\":null\n },\n {\n \"id\":49,\n \"title\":\"Litecoin\",\n \"kind\":\"crypto\",\n \"symbol\":\"LTC\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":6,\n \"id_name\":\"litecoin\",\n \"title\":\"Litecoin\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":50,\n \"title\":\"Ethereum\",\n \"kind\":\"crypto\",\n \"symbol\":\"ETH\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":40,\n \"id_name\":\"arbitrum\",\n \"title\":\"Arbitrum\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":52,\n \"title\":\"Bitcoin Cash\",\n \"kind\":\"crypto\",\n \"symbol\":\"BCH\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":8,\n \"id_name\":\"bitcoin_cash\",\n \"title\":\"Bitcoin Cash\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":53,\n \"title\":\"XRP\",\n \"kind\":\"crypto\",\n \"symbol\":\"XRP\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":9,\n \"id_name\":\"ripple\",\n \"title\":\"XRP\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":60,\n \"title\":\"TRON\",\n \"kind\":\"crypto\",\n \"symbol\":\"TRX\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":4,\n \"id_name\":\"tron\",\n \"title\":\"Tron\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":61,\n \"title\":\"Dai\",\n \"kind\":\"crypto\",\n \"symbol\":\"DAI\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n },\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":64,\n \"title\":\"Dogecoin\",\n \"kind\":\"crypto\",\n \"symbol\":\"DOGE\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":7,\n \"id_name\":\"dogecoin\",\n \"title\":\"Dogecoin\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":91,\n \"title\":\"Binance Coin\",\n \"kind\":\"crypto\",\n \"symbol\":\"BNB\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":97,\n \"title\":\"USDT\",\n \"kind\":\"crypto\",\n \"symbol\":\"USDT\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n },\n {\n \"id\":4,\n \"id_name\":\"tron\",\n \"title\":\"Tron\",\n \"enabled\":true\n },\n {\n \"id\":20,\n \"id_name\":\"solana\",\n \"title\":\"Solana\",\n \"enabled\":true\n },\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n },\n {\n \"id\":40,\n \"id_name\":\"arbitrum\",\n \"title\":\"Arbitrum\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":112,\n \"title\":\"Polygon\",\n \"kind\":\"crypto\",\n \"symbol\":\"POL\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":113,\n \"title\":\"USDC\",\n \"kind\":\"crypto\",\n \"symbol\":\"USDC\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n },\n {\n \"id\":4,\n \"id_name\":\"tron\",\n \"title\":\"Tron\",\n \"enabled\":true\n },\n {\n \"id\":20,\n \"id_name\":\"solana\",\n \"title\":\"Solana\",\n \"enabled\":true\n },\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n },\n {\n \"id\":40,\n \"id_name\":\"arbitrum\",\n \"title\":\"Arbitrum\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":117,\n \"title\":\"Solana\",\n \"kind\":\"crypto\",\n \"symbol\":\"SOL\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":20,\n \"id_name\":\"solana\",\n \"title\":\"Solana\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":165,\n \"title\":\"SHIBA INU\",\n \"kind\":\"crypto\",\n \"symbol\":\"SHIB\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n },\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n }\n ]\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 8, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {}, "platforms": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "id_name": { "type": "string", "example": "bitcoin" }, "title": { "type": "string", "example": "Bitcoin" }, "enabled": { "type": "boolean", "example": true, "default": true } } } } } } } } } } }, "deprecated": false } }, "/ledger/accounts": { "get": { "summary": "List Accounts", "description": "List the ledger accounts that belong to the authenticated account. Ledger accounts hold your funds on CoinGate, with one account per currency and account type. Only visible accounts are returned — those with status `active` or `suspended` — and each includes its current balance and currency details. Results are paginated, 100 per page by default.", "operationId": "ledger-accounts", "parameters": [ { "name": "page", "in": "query", "description": "Page number. Defaults to 1.", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Values below 1 are set to 1.", "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "A paginated list of ledger accounts.", "content": { "application/json": { "examples": { "Result": { "value": { "current_page": 1, "per_page": 100, "total_accounts": 2, "total_pages": 1, "accounts": [ { "id": "01KS2DT6X277ZEERSGKRPW8YZV", "balance": "10.88", "status": "active", "account_type": "main", "title": "Euro main account", "currency": { "id": 2, "title": "Euro", "kind": "fiat", "symbol": "EUR", "enabled": true, "disabled_message": null } }, { "id": "01KJZ0PM6K2V3ZFV416S17Q6MH", "balance": "1443.060408", "status": "active", "account_type": "main", "title": "USDC main account", "currency": { "id": 22, "title": "USDC", "kind": "crypto", "symbol": "USDC", "enabled": true, "disabled_message": null } } ] } } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "description": "Current page number.", "example": 1 }, "per_page": { "type": "integer", "description": "Records per page.", "example": 100 }, "total_accounts": { "type": "integer", "description": "Total number of visible accounts.", "example": 2 }, "total_pages": { "type": "integer", "description": "Total number of pages.", "example": 1 }, "accounts": { "type": "array", "description": "The ledger accounts on this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The ledger account ID (ULID).", "example": "01KS2DT6X277ZEERSGKRPW8YZV" }, "balance": { "type": "string", "description": "Current balance, floored to the currency's precision. Returned as a string to preserve precision.", "example": "10.88" }, "status": { "type": "string", "enum": [ "active", "disabled", "error_creating", "suspended" ], "description": "Account state. Only active/suspended accounts are listed.", "example": "active" }, "account_type": { "type": "string", "enum": [ "main", "secondary", "tertiary" ], "description": "Type of the ledger account.", "example": "main" }, "title": { "type": [ "string", "null" ], "description": "Account title. Defaults to \"{currency title} {account_type} account\" when not set explicitly.", "example": "Euro main account" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "description": "Currency ID.", "example": 2 }, "title": { "type": "string", "description": "Currency name.", "example": "Euro" }, "kind": { "type": "string", "enum": [ "fiat", "crypto" ], "description": "Whether the currency is fiat or crypto.", "example": "fiat" }, "symbol": { "type": "string", "description": "ISO symbol of the currency.", "example": "EUR" }, "enabled": { "type": "boolean", "description": "Whether the currency is currently enabled (not temporarily disabled).", "example": true }, "disabled_message": { "type": [ "string", "null" ], "description": "Reason the currency is temporarily disabled, or null when enabled.", "example": null } } } } } } } } } } }, "401": { "description": "Missing or invalid API token.", "content": { "application/json": { "examples": { "Result": { "value": { "message": "Auth Token is not valid", "reason": "BadAuthToken" } } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Auth Token is not valid" }, "reason": { "type": "string", "example": "BadAuthToken" } } } } } } }, "deprecated": false } }, "/ledger/transactions": { "get": { "summary": "List Transactions", "description": "This endpoint allows you to retrieve a list of all ledger transactions associated with your CoinGate account. This is crucial for reconciliation purposes, enabling you to track all movements of funds (credits and debits) and maintain an accurate ledger of your financial activities within the CoinGate system.", "operationId": "list-transactions", "parameters": [ { "name": "page", "in": "query", "description": "Current page number", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Number of refunds per page (max - 100)", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "sort", "in": "query", "description": "One of \"created_at_desc\", \"created_at_asc\"", "schema": { "type": "string", "default": "created_at_desc" } }, { "name": "date_from", "in": "query", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "ISO 4217 currency code, e.g. BTC, EUR, USD", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Filter by transaction type (e.g. fee, merchant_order, withdrawal). See the type field for the full list of values.", "schema": { "type": "string", "enum": [ "trader_order_buy", "trader_order_sell", "trader_order_swap", "withdrawal", "fee", "withdrawal_revert", "fee_revert", "merchant_refund", "merchant_refund_revert", "merchant_order", "merchant_order_revert", "funds_transfer", "deposit", "exchange_addition", "exchange_deduction", "balance_deduction", "mass_payout", "mass_payout_entry_refund", "merchant_order_pfb_deduction", "mass_payout_entry_service_fee_refund", "send_request", "send_request_revert", "flat_fee", "outgoing_fee", "conversion_fee", "fx_revenue", "exchange_fee", "claim_transaction_fee", "order_unclaimed_funds_addition", "order_unclaimed_funds_deduction", "abandonment_fee", "abandonment_balance", "deposit_revert", "usdt_usdc_conversion", "fx_revenue_revert", "tx_network_fee", "batch_payout", "batch_payout_revert", "payout_link", "payout_link_revert" ] } }, { "in": "query", "name": "source_type", "schema": { "type": "string" }, "description": "Type of the associated record (e.g. Order, Withdrawal). Must be provided together with `source_id`" }, { "in": "query", "name": "source_id", "schema": { "type": "string" }, "description": "Identifier of the associated record. Must be provided together with `source_type`" } ], "responses": { "200": { "description": "A paginated list of ledger transactions.", "content": { "application/json": { "examples": { "Result": { "value": { "current_page": 1, "per_page": 100, "sort": "created_at_desc", "date_from": "", "date_to": "", "currency": "all", "total_entries": 22, "total_pages": 1, "entries": [ { "id": "01KS2DT7051V73P3A64P71GMBE", "created_at": "2026-05-20T10:10:01.862Z", "purpose": "Order ID #67983 processing fee 0.11 EUR", "type": "fee", "source_type": "Fee", "source_id": "139981", "account": { "id": "01KS2DT6X277ZEERSGKRPW8YZV", "balance": "10.88", "status": "active", "account_type": "main", "title": "Euro main account", "currency": { "id": 2, "title": "Euro", "kind": "fiat", "symbol": "EUR", "enabled": true, "disabled_message": null } }, "currency": { "id": 2, "title": "Euro", "kind": "fiat", "symbol": "EUR", "enabled": true, "disabled_message": null }, "credited_amount": "0.11", "debited_amount": "0", "closing_balance": "10.88" }, { "id": "01KS2DT6XRJ210SZHYT36HWYS9", "created_at": "2026-05-20T10:10:01.784Z", "purpose": "Order ID #67983 10.99 EUR", "type": "merchant_order", "source_type": "Order", "source_id": "67983", "account": { "id": "01KS2DT6X277ZEERSGKRPW8YZV", "balance": "10.88", "status": "active", "account_type": "main", "title": "Euro main account", "currency": { "id": 2, "title": "Euro", "kind": "fiat", "symbol": "EUR", "enabled": true, "disabled_message": null } }, "currency": { "id": 2, "title": "Euro", "kind": "fiat", "symbol": "EUR", "enabled": true, "disabled_message": null }, "credited_amount": "0", "debited_amount": "10.99", "closing_balance": "10.99" } ] } } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "description": "Current page number.", "example": 1 }, "per_page": { "type": "integer", "description": "Records per page.", "example": 100 }, "sort": { "type": "string", "description": "The sort order applied.", "example": "created_at_desc" }, "date_from": { "type": "string", "description": "The date_from filter applied (empty string if none).", "example": "" }, "date_to": { "type": "string", "description": "The date_to filter applied (empty string if none).", "example": "" }, "currency": { "type": "string", "description": "The currency filter applied (all if none).", "example": "all" }, "total_entries": { "type": "integer", "description": "Total number of matching transactions.", "example": 22 }, "total_pages": { "type": "integer", "description": "Total number of pages.", "example": 1 }, "entries": { "type": "array", "description": "The transactions on this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The transaction (ledger entry) ID (ULID). Sortable by creation time.", "example": "01KS2DT7051V73P3A64P71GMBE" }, "created_at": { "type": "string", "format": "date-time", "description": "When the transaction was created (ISO 8601, UTC).", "example": "2026-05-20T10:10:01.862Z" }, "purpose": { "type": [ "string", "null" ], "description": "Free-text note describing the transaction, or null.", "example": "Order ID #67983 processing fee 0.11 EUR" }, "type": { "type": "string", "enum": [ "trader_order_buy", "trader_order_sell", "trader_order_swap", "withdrawal", "fee", "withdrawal_revert", "fee_revert", "merchant_refund", "merchant_refund_revert", "merchant_order", "merchant_order_revert", "funds_transfer", "deposit", "exchange_addition", "exchange_deduction", "balance_deduction", "mass_payout", "mass_payout_entry_refund", "merchant_order_pfb_deduction", "mass_payout_entry_service_fee_refund", "send_request", "send_request_revert", "flat_fee", "outgoing_fee", "conversion_fee", "fx_revenue", "exchange_fee", "claim_transaction_fee", "order_unclaimed_funds_addition", "order_unclaimed_funds_deduction", "abandonment_fee", "abandonment_balance", "deposit_revert", "usdt_usdc_conversion", "fx_revenue_revert", "tx_network_fee", "batch_payout", "batch_payout_revert", "payout_link", "payout_link_revert" ], "description": "The kind of ledger transaction.", "example": "fee" }, "source_type": { "type": [ "string", "null" ], "description": "Type of the record that produced this transaction (e.g. Order, Fee, Withdrawal), or null.", "example": "Fee" }, "source_id": { "type": [ "string", "null" ], "description": "ID of the record that produced this transaction, or null.", "example": "139981" }, "account": { "type": "object", "properties": { "id": { "type": "string", "description": "The ledger account ID (ULID).", "example": "01KS2DT6X277ZEERSGKRPW8YZV" }, "balance": { "type": "string", "description": "Current balance, floored to the currency's precision. Returned as a string to preserve precision.", "example": "10.88" }, "status": { "type": "string", "enum": [ "active", "disabled", "error_creating", "suspended" ], "description": "Account state.", "example": "active" }, "account_type": { "type": "string", "enum": [ "main", "secondary", "tertiary" ], "description": "Type of the ledger account.", "example": "main" }, "title": { "type": [ "string", "null" ], "description": "Account title. Defaults to \"{currency title} {account_type} account\" when not set explicitly.", "example": "Euro main account" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "description": "Currency ID.", "example": 2 }, "title": { "type": "string", "description": "Currency name.", "example": "Euro" }, "kind": { "type": "string", "enum": [ "fiat", "crypto" ], "description": "Whether the currency is fiat or crypto.", "example": "fiat" }, "symbol": { "type": "string", "description": "ISO symbol of the currency.", "example": "EUR" }, "enabled": { "type": "boolean", "description": "Whether the currency is currently enabled (not temporarily disabled).", "example": true }, "disabled_message": { "type": [ "string", "null" ], "description": "Reason the currency is temporarily disabled, or null when enabled.", "example": null } } } } }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "description": "Currency ID.", "example": 2 }, "title": { "type": "string", "description": "Currency name.", "example": "Euro" }, "kind": { "type": "string", "enum": [ "fiat", "crypto" ], "description": "Whether the currency is fiat or crypto.", "example": "fiat" }, "symbol": { "type": "string", "description": "ISO symbol of the currency.", "example": "EUR" }, "enabled": { "type": "boolean", "description": "Whether the currency is currently enabled (not temporarily disabled).", "example": true }, "disabled_message": { "type": [ "string", "null" ], "description": "Reason the currency is temporarily disabled, or null when enabled.", "example": null } } }, "credited_amount": { "type": "string", "description": "Amount credited in this transaction, as a positive decimal string. Credits reduce the account balance (e.g. a fee or withdrawal). \"0\" when the transaction is a debit.", "example": "0.11" }, "debited_amount": { "type": "string", "description": "Amount debited in this transaction, as a positive decimal string. Debits increase the account balance (e.g. an incoming merchant_order). \"0\" when the transaction is a credit.", "example": "0" }, "closing_balance": { "type": "string", "description": "Account balance immediately after this transaction was applied.", "example": "10.88" } } } } } } } } }, "401": { "description": "Missing or invalid API token.", "content": { "application/json": { "examples": { "Result": { "value": { "message": "Auth Token is not valid", "reason": "BadAuthToken" } } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Auth Token is not valid" }, "reason": { "type": "string", "example": "BadAuthToken" } } } } } }, "422": { "description": "A date filter is not a valid YYYY-MM-DD date.", "content": { "application/json": { "examples": { "Result": { "value": { "message": "Please correct date format 2026-13-99", "reason": "IncorrectDateRangeError" } } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Please correct date format 2026-13-99" }, "reason": { "type": "string", "example": "IncorrectDateRangeError" } } } } } } }, "deprecated": false } }, "/send_requests": { "post": { "summary": "Create Send Request", "description": "", "operationId": "create-send", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "ledger_account_id", "beneficiary_payout_setting_id", "amount", "amount_currency_id", "purpose" ], "properties": { "ledger_account_id": { "type": "string", "description": "Ledger account ID can be retrieved from https://api.coingate.com/api/v2/ledger/accounts" }, "beneficiary_payout_setting_id": { "type": "integer", "description": "Beneficiary payout setting ID can be retrieved from https://api.coingate.com/api/v2/beneficiaries", "format": "int32" }, "amount": { "type": "string", "description": "Amount to send" }, "amount_currency_id": { "type": "integer", "description": "Currency of amount. Currency ID's can be seen on https://developer.coingate.com/reference/currencies", "format": "int32" }, "purpose": { "type": "string", "description": "Purpose of sending" }, "callback_url": { "type": "string", "description": "Send an automated message to Merchant URL when request status is changed. For testing you can use requestcatcher.com tool. URL must be direct without redirection. Read about billing request callbacks here." }, "external_id": { "type": "string", "description": "This field allows merchants to associate the record with their own internal reference. If provided, it must be unique.. (max length: 50)" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 11,\n \"status\": \"draft\",\n \"purpose\": \"Sending 100 EUR Value\",\n \"callback_url\": \"https://example.com/callback_url\",\n \"created_at\": \"2025-03-13T00:45:17.250Z\",\n \"external_id\": \"1\",\n \"ledger_account\": {\n \"id\": \"01JNQWKKJ6WXN8BZT1Y66B6G9H\",\n \"balance\": \"1.0\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\"\n }\n },\n \"input_amount\": \"100.0\",\n \"input_currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\"\n },\n \"sending_amount\": \"0.049422\",\n \"sending_currency\": {\n \"id\": 5,\n \"title\": \"Ethereum\",\n \"kind\": \"crypto\",\n \"symbol\": \"ETH\"\n },\n \"input_to_sending_rate\": \"0.00049422\",\n \"sending_to_balance_debit_rate\": \"40.3258\",\n \"balance_debit_amount\": \"0.00122557\",\n \"balance_debit_currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n },\n \"beneficiary_payout_setting\": {\n \"id\": 2,\n \"created_at\": \"2025-03-07T10:39:33.152Z\",\n \"beneficiary_id\": 1,\n \"platform\": {\n \"id\": 2,\n \"title\": \"Ethereum\",\n \"id_name\": \"ethereum\"\n },\n \"crypto_address\": \"tb1qcq670zweall6zz4f96flfrefhr8myfxz9ll9l2\",\n \"crypto_address_metadata\": null,\n \"currency\": {\n \"id\": 5,\n \"title\": \"Ethereum\",\n \"kind\": \"crypto\",\n \"symbol\": \"ETH\"\n }\n },\n \"fees\": {\n \"service_fee\": {\n \"amount\": \"0.00001226\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n },\n \"conversion_fee\": {\n \"amount\": \"0.00001226\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n },\n \"blockchain_transactions\": [],\n \"actions_required\": {\n \"confirm\": \"https://api.coingate.com/api/v2/send_requests/11/confirm\",\n \"cancel\": \"https://api.coingate.com/api/v2/send_requests/11/cancel\"\n },\n \"requires_2fa_confirmation\": true\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 11, "default": 0 }, "status": { "type": "string", "example": "draft" }, "purpose": { "type": "string", "example": "Sending 100 EUR Value" }, "callback_url": { "type": "string", "example": "https://example.com/callback_url" }, "created_at": { "type": "string", "example": "2025-03-13T00:45:17.250Z" }, "external_id": { "type": "string", "example": "1" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JNQWKKJ6WXN8BZT1Y66B6G9H" }, "balance": { "type": "string", "example": "1.0" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "input_amount": { "type": "string", "example": "100.0" }, "input_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } }, "sending_amount": { "type": "string", "example": "0.049422" }, "sending_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "ETH" } } }, "input_to_sending_rate": { "type": "string", "example": "0.00049422" }, "sending_to_balance_debit_rate": { "type": "string", "example": "40.3258" }, "balance_debit_amount": { "type": "string", "example": "0.00122557" }, "balance_debit_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "beneficiary_payout_setting": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "created_at": { "type": "string", "example": "2025-03-07T10:39:33.152Z" }, "beneficiary_id": { "type": "integer", "example": 1, "default": 0 }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "id_name": { "type": "string", "example": "ethereum" } } }, "crypto_address": { "type": "string", "example": "tb1qcq670zweall6zz4f96flfrefhr8myfxz9ll9l2" }, "crypto_address_metadata": {}, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "ETH" } } } } }, "fees": { "type": "object", "properties": { "service_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001226" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "conversion_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001226" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } } } }, "blockchain_transactions": { "type": "array" }, "actions_required": { "type": "object", "properties": { "confirm": { "type": "string", "example": "https://api.coingate.com/api/v2/send_requests/11/confirm" }, "cancel": { "type": "string", "example": "https://api.coingate.com/api/v2/send_requests/11/cancel" } } }, "requires_2fa_confirmation": { "type": "boolean", "example": true, "default": true } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"SendRequest is not valid\",\n \"reason\": \"SendRequestIsNotValid\",\n \"errors\": [\n \"Ledger account is invalid\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "SendRequest is not valid" }, "reason": { "type": "string", "example": "SendRequestIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Ledger account is invalid" } } } } } } } }, "deprecated": false }, "get": { "summary": "List Send Requests", "description": "", "operationId": "list-send", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "per_page": { "type": "integer", "description": "Records per page you would like to see", "default": 100, "format": "int32" }, "page": { "type": "integer", "description": "Current page number", "default": 1, "format": "int32" } } }, "examples": { "Request Example": { "value": { "per_page": 100, "page": 1 } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 1,\n \"per_page\": 100,\n \"total_records\": 1,\n \"total_pages\": 1,\n \"send_requests\": [\n {\n \"id\": 11,\n \"status\": \"draft\",\n \"purpose\": \"Sending 100 EUR Value\",\n \"callback_url\": \"https://example.com/callback_url\",\n \"created_at\": \"2025-03-13T00:45:17.250Z\",\n \"external_id\": \"1\",\n \"ledger_account\": {\n \"id\": \"01JNQWKKJ6WXN8BZT1Y66B6G9H\",\n \"balance\": \"1.0\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\"\n }\n },\n \"input_amount\": \"100.0\",\n \"input_currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\"\n },\n \"sending_amount\": \"0.049422\",\n \"sending_currency\": {\n \"id\": 5,\n \"title\": \"Ethereum\",\n \"kind\": \"crypto\",\n \"symbol\": \"ETH\"\n },\n \"input_to_sending_rate\": \"0.00049422\",\n \"sending_to_balance_debit_rate\": \"40.3258\",\n \"balance_debit_amount\": \"0.00122557\",\n \"balance_debit_currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n },\n \"beneficiary_payout_setting\": {\n \"id\": 2,\n \"created_at\": \"2025-03-07T10:39:33.152Z\",\n \"beneficiary_id\": 1,\n \"platform\": {\n \"id\": 2,\n \"title\": \"Ethereum\",\n \"id_name\": \"ethereum\"\n },\n \"crypto_address\": \"tb1qcq670zweall6zz4f96flfrefhr8myfxz9ll9l2\",\n \"crypto_address_metadata\": null,\n \"currency\": {\n \"id\": 5,\n \"title\": \"Ethereum\",\n \"kind\": \"crypto\",\n \"symbol\": \"ETH\"\n }\n },\n \"fees\": {\n \"service_fee\": {\n \"amount\": \"0.00001226\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n },\n \"conversion_fee\": {\n \"amount\": \"0.00001226\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n },\n \"blockchain_transactions\": [],\n \"actions_required\": {\n \"confirm\": \"https://api.coingate.com/api/v2/send_requests/11/confirm\",\n \"cancel\": \"https://api.coingate.com/api/v2/send_requests/11/cancel\"\n },\n \"requires_2fa_confirmation\": true\n}\n ]\n}" } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 100, "default": 0 }, "total_records": { "type": "integer", "example": 1, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 }, "send_requests": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 11, "default": 0 }, "status": { "type": "string", "example": "draft" }, "purpose": { "type": "string", "example": "Sending 100 EUR Value" }, "callback_url": { "type": "string", "example": "https://example.com/callback_url" }, "created_at": { "type": "string", "example": "2025-03-13T00:45:17.250Z" }, "external_id": { "type": "string", "example": "1" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JNQWKKJ6WXN8BZT1Y66B6G9H" }, "balance": { "type": "string", "example": "1.0" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "input_amount": { "type": "string", "example": "100.0" }, "input_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } }, "sending_amount": { "type": "string", "example": "0.049422" }, "sending_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "ETH" } } }, "input_to_sending_rate": { "type": "string", "example": "0.00049422" }, "sending_to_balance_debit_rate": { "type": "string", "example": "40.3258" }, "balance_debit_amount": { "type": "string", "example": "0.00122557" }, "balance_debit_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "beneficiary_payout_setting": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "created_at": { "type": "string", "example": "2025-03-07T10:39:33.152Z" }, "beneficiary_id": { "type": "integer", "example": 1, "default": 0 }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "id_name": { "type": "string", "example": "ethereum" } } }, "crypto_address": { "type": "string", "example": "tb1qcq670zweall6zz4f96flfrefhr8myfxz9ll9l2" }, "crypto_address_metadata": {}, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "ETH" } } } } }, "fees": { "type": "object", "properties": { "service_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001226" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "conversion_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001226" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } } } }, "blockchain_transactions": { "type": "array" }, "actions_required": { "type": "object", "properties": { "confirm": { "type": "string", "example": "https://api.coingate.com/api/v2/send_requests/11/confirm" }, "cancel": { "type": "string", "example": "https://api.coingate.com/api/v2/send_requests/11/cancel" } } }, "requires_2fa_confirmation": { "type": "boolean", "example": true, "default": true } } } } } } } } } }, "deprecated": false } }, "/send_requests/:id": { "get": { "summary": "Get Send Request", "description": "", "operationId": "get-send", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 11,\n \"status\": \"draft\",\n \"purpose\": \"Sending 100 EUR Value\",\n \"callback_url\": \"https://example.com/callback_url\",\n \"created_at\": \"2025-03-13T00:45:17.250Z\",\n \"external_id\": null,\n \"ledger_account\": {\n \"id\": \"01JNQWKKJ6WXN8BZT1Y66B6G9H\",\n \"balance\": \"1.0\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\"\n }\n },\n \"input_amount\": \"100.0\",\n \"input_currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\"\n },\n \"sending_amount\": \"0.049422\",\n \"sending_currency\": {\n \"id\": 5,\n \"title\": \"Ethereum\",\n \"kind\": \"crypto\",\n \"symbol\": \"ETH\"\n },\n \"input_to_sending_rate\": \"0.00049422\",\n \"sending_to_balance_debit_rate\": \"40.3258\",\n \"balance_debit_amount\": \"0.00122557\",\n \"balance_debit_currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n },\n \"beneficiary_payout_setting\": {\n \"id\": 2,\n \"created_at\": \"2025-03-07T10:39:33.152Z\",\n \"beneficiary_id\": 1,\n \"platform\": {\n \"id\": 2,\n \"title\": \"Ethereum\",\n \"id_name\": \"ethereum\"\n },\n \"crypto_address\": \"tb1qcq670zweall6zz4f96flfrefhr8myfxz9ll9l2\",\n \"crypto_address_metadata\": null,\n \"currency\": {\n \"id\": 5,\n \"title\": \"Ethereum\",\n \"kind\": \"crypto\",\n \"symbol\": \"ETH\"\n }\n },\n \"fees\": {\n \"service_fee\": {\n \"amount\": \"0.00001226\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n },\n \"conversion_fee\": {\n \"amount\": \"0.00001226\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n },\n \"blockchain_transactions\": [],\n \"actions_required\": {\n \"confirm\": \"https://api.coingate.com/api/v2/send_requests/11/confirm\",\n \"cancel\": \"https://api.coingate.com/api/v2/send_requests/11/cancel\"\n },\n \"requires_2fa_confirmation\": true\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 11, "default": 0 }, "status": { "type": "string", "example": "draft" }, "purpose": { "type": "string", "example": "Sending 100 EUR Value" }, "callback_url": { "type": "string", "example": "https://example.com/callback_url" }, "created_at": { "type": "string", "example": "2025-03-13T00:45:17.250Z" }, "external_id": {}, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JNQWKKJ6WXN8BZT1Y66B6G9H" }, "balance": { "type": "string", "example": "1.0" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "input_amount": { "type": "string", "example": "100.0" }, "input_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } }, "sending_amount": { "type": "string", "example": "0.049422" }, "sending_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "ETH" } } }, "input_to_sending_rate": { "type": "string", "example": "0.00049422" }, "sending_to_balance_debit_rate": { "type": "string", "example": "40.3258" }, "balance_debit_amount": { "type": "string", "example": "0.00122557" }, "balance_debit_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "beneficiary_payout_setting": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "created_at": { "type": "string", "example": "2025-03-07T10:39:33.152Z" }, "beneficiary_id": { "type": "integer", "example": 1, "default": 0 }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "id_name": { "type": "string", "example": "ethereum" } } }, "crypto_address": { "type": "string", "example": "tb1qcq670zweall6zz4f96flfrefhr8myfxz9ll9l2" }, "crypto_address_metadata": {}, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "ETH" } } } } }, "fees": { "type": "object", "properties": { "service_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001226" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "conversion_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001226" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } } } }, "blockchain_transactions": { "type": "array" }, "actions_required": { "type": "object", "properties": { "confirm": { "type": "string", "example": "https://api.coingate.com/api/v2/send_requests/11/confirm" }, "cancel": { "type": "string", "example": "https://api.coingate.com/api/v2/send_requests/11/cancel" } } }, "requires_2fa_confirmation": { "type": "boolean", "example": true, "default": true } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Send request not found\",\n \"reason\": \"SendRequestNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Send request not found" }, "reason": { "type": "string", "example": "SendRequestNotFound" } } } } } } }, "deprecated": false } }, "/send_requests/:id/confirm": { "patch": { "summary": "Send Request Exchange Confirm", "description": "", "operationId": "send-request-exchange-confirm", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 11,\n \"status\": \"draft\",\n \"purpose\": \"Sending 100 EUR Value\",\n \"callback_url\": \"https://example.com/callback_url\",\n \"created_at\": \"2025-03-13T00:45:17.250Z\",\n \"ledger_account\": {\n \"id\": \"01JNQWKKJ6WXN8BZT1Y66B6G9H\",\n \"balance\": \"1.0\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\"\n }\n },\n \"input_amount\": \"100.0\",\n \"input_currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\"\n },\n \"sending_amount\": \"0.049422\",\n \"sending_currency\": {\n \"id\": 5,\n \"title\": \"Ethereum\",\n \"kind\": \"crypto\",\n \"symbol\": \"ETH\"\n },\n \"input_to_sending_rate\": \"0.00049422\",\n \"sending_to_balance_debit_rate\": \"40.3258\",\n \"balance_debit_amount\": \"0.00122557\",\n \"balance_debit_currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n },\n \"beneficiary_payout_setting\": {\n \"id\": 2,\n \"created_at\": \"2025-03-07T10:39:33.152Z\",\n \"beneficiary_id\": 1,\n \"platform\": {\n \"id\": 2,\n \"title\": \"Ethereum\",\n \"id_name\": \"ethereum\"\n },\n \"crypto_address\": \"tb1qcq670zweall6zz4f96flfrefhr8myfxz9ll9l2\",\n \"crypto_address_metadata\": null,\n \"currency\": {\n \"id\": 5,\n \"title\": \"Ethereum\",\n \"kind\": \"crypto\",\n \"symbol\": \"ETH\"\n }\n },\n \"fees\": {\n \"service_fee\": {\n \"amount\": \"0.00001226\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n },\n \"conversion_fee\": {\n \"amount\": \"0.00001226\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n },\n \"blockchain_transactions\": [],\n \"actions_required\": {\n \"confirm\": \"https://api.coingate.com/api/v2/send_requests/11/confirm\",\n \"cancel\": \"https://api.coingate.com/api/v2/send_requests/11/cancel\"\n },\n \"requires_2fa_confirmation\": true\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 11, "default": 0 }, "status": { "type": "string", "example": "draft" }, "purpose": { "type": "string", "example": "Sending 100 EUR Value" }, "callback_url": { "type": "string", "example": "https://example.com/callback_url" }, "created_at": { "type": "string", "example": "2025-03-13T00:45:17.250Z" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JNQWKKJ6WXN8BZT1Y66B6G9H" }, "balance": { "type": "string", "example": "1.0" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "input_amount": { "type": "string", "example": "100.0" }, "input_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } }, "sending_amount": { "type": "string", "example": "0.049422" }, "sending_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "ETH" } } }, "input_to_sending_rate": { "type": "string", "example": "0.00049422" }, "sending_to_balance_debit_rate": { "type": "string", "example": "40.3258" }, "balance_debit_amount": { "type": "string", "example": "0.00122557" }, "balance_debit_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "beneficiary_payout_setting": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "created_at": { "type": "string", "example": "2025-03-07T10:39:33.152Z" }, "beneficiary_id": { "type": "integer", "example": 1, "default": 0 }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "id_name": { "type": "string", "example": "ethereum" } } }, "crypto_address": { "type": "string", "example": "tb1qcq670zweall6zz4f96flfrefhr8myfxz9ll9l2" }, "crypto_address_metadata": {}, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "ETH" } } } } }, "fees": { "type": "object", "properties": { "service_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001226" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "conversion_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001226" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } } } }, "blockchain_transactions": { "type": "array" }, "actions_required": { "type": "object", "properties": { "confirm": { "type": "string", "example": "https://api.coingate.com/api/v2/send_requests/11/confirm" }, "cancel": { "type": "string", "example": "https://api.coingate.com/api/v2/send_requests/11/cancel" } } }, "requires_2fa_confirmation": { "type": "boolean", "example": true, "default": true } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Send request not found\",\n \"reason\": \"SendRequestNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Send request not found" }, "reason": { "type": "string", "example": "SendRequestNotFound" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"SendRequest is not valid\",\n \"reason\": \"SendRequestIsNotValid\",\n \"errors\": [\n \"Transaction expired.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "SendRequest is not valid" }, "reason": { "type": "string", "example": "SendRequestIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Transaction expired." } } } } } } } }, "deprecated": false } }, "/send_requests/:id/cancel": { "patch": { "summary": "Send Request Exchange Cancel", "description": "", "operationId": "send-request-exchange-cancel", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 11,\n \"status\": \"canceled\",\n \"purpose\": \"Sending 100 EUR Value\",\n \"callback_url\": \"https://example.com/callback_url\",\n \"created_at\": \"2025-03-13T00:45:17.250Z\",\n \"ledger_account\": {\n \"id\": \"01JNQWKKJ6WXN8BZT1Y66B6G9H\",\n \"balance\": \"1.0\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\"\n }\n },\n \"input_amount\": \"100.0\",\n \"input_currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\"\n },\n \"sending_amount\": \"0.049422\",\n \"sending_currency\": {\n \"id\": 5,\n \"title\": \"Ethereum\",\n \"kind\": \"crypto\",\n \"symbol\": \"ETH\"\n },\n \"input_to_sending_rate\": \"0.00049422\",\n \"sending_to_balance_debit_rate\": \"40.3258\",\n \"balance_debit_amount\": \"0.00122557\",\n \"balance_debit_currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n },\n \"beneficiary_payout_setting\": {\n \"id\": 2,\n \"created_at\": \"2025-03-07T10:39:33.152Z\",\n \"beneficiary_id\": 1,\n \"platform\": {\n \"id\": 2,\n \"title\": \"Ethereum\",\n \"id_name\": \"ethereum\"\n },\n \"crypto_address\": \"tb1qcq670zweall6zz4f96flfrefhr8myfxz9ll9l2\",\n \"crypto_address_metadata\": null,\n \"currency\": {\n \"id\": 5,\n \"title\": \"Ethereum\",\n \"kind\": \"crypto\",\n \"symbol\": \"ETH\"\n }\n },\n \"fees\": {\n \"service_fee\": {\n \"amount\": \"0.00001226\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n },\n \"conversion_fee\": {\n \"amount\": \"0.00001226\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n },\n \"blockchain_transactions\": [],\n \"actions_required\": {\n \"confirm\": \"https://api.coingate.com/api/v2/send_requests/11/confirm\",\n \"cancel\": \"https://api.coingate.com/api/v2/send_requests/11/cancel\"\n },\n \"requires_2fa_confirmation\": true\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 11, "default": 0 }, "status": { "type": "string", "example": "canceled" }, "purpose": { "type": "string", "example": "Sending 100 EUR Value" }, "callback_url": { "type": "string", "example": "https://example.com/callback_url" }, "created_at": { "type": "string", "example": "2025-03-13T00:45:17.250Z" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JNQWKKJ6WXN8BZT1Y66B6G9H" }, "balance": { "type": "string", "example": "1.0" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "input_amount": { "type": "string", "example": "100.0" }, "input_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } }, "sending_amount": { "type": "string", "example": "0.049422" }, "sending_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "ETH" } } }, "input_to_sending_rate": { "type": "string", "example": "0.00049422" }, "sending_to_balance_debit_rate": { "type": "string", "example": "40.3258" }, "balance_debit_amount": { "type": "string", "example": "0.00122557" }, "balance_debit_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "beneficiary_payout_setting": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "created_at": { "type": "string", "example": "2025-03-07T10:39:33.152Z" }, "beneficiary_id": { "type": "integer", "example": 1, "default": 0 }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "id_name": { "type": "string", "example": "ethereum" } } }, "crypto_address": { "type": "string", "example": "tb1qcq670zweall6zz4f96flfrefhr8myfxz9ll9l2" }, "crypto_address_metadata": {}, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "ETH" } } } } }, "fees": { "type": "object", "properties": { "service_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001226" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "conversion_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001226" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } } } }, "blockchain_transactions": { "type": "array" }, "actions_required": { "type": "object", "properties": { "confirm": { "type": "string", "example": "https://api.coingate.com/api/v2/send_requests/11/confirm" }, "cancel": { "type": "string", "example": "https://api.coingate.com/api/v2/send_requests/11/cancel" } } }, "requires_2fa_confirmation": { "type": "boolean", "example": true, "default": true } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Send request not found\",\n \"reason\": \"SendRequestNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Send request not found" }, "reason": { "type": "string", "example": "SendRequestNotFound" } } } } } } }, "deprecated": false } }, "/send_requests/supported-currencies": { "get": { "summary": "Supported Currencies", "description": "List Supported Payout Currencies and Crypto Platforms", "operationId": "supported-payout-currencies-and-crypto-platforms", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"id\":50,\n \"title\":\"Ethereum\",\n \"kind\":\"crypto\",\n \"symbol\":\"ETH\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":40,\n \"id_name\":\"arbitrum\",\n \"title\":\"Arbitrum\",\n \"enabled\":true\n },\n {\n \"id\":42,\n \"id_name\":\"base\",\n \"title\":\"Base\",\n \"enabled\":true\n },\n {\n \"id\":44,\n \"id_name\":\"optimism\",\n \"title\":\"Optimism\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":61,\n \"title\":\"Dai\",\n \"kind\":\"crypto\",\n \"symbol\":\"DAI\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n },\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":97,\n \"title\":\"USDT\",\n \"kind\":\"crypto\",\n \"symbol\":\"USDT\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n },\n {\n \"id\":4,\n \"id_name\":\"tron\",\n \"title\":\"Tron\",\n \"enabled\":true\n },\n {\n \"id\":20,\n \"id_name\":\"solana\",\n \"title\":\"Solana\",\n \"enabled\":true\n },\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n },\n {\n \"id\":40,\n \"id_name\":\"arbitrum\",\n \"title\":\"Arbitrum\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":113,\n \"title\":\"USDC\",\n \"kind\":\"crypto\",\n \"symbol\":\"USDC\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n },\n {\n \"id\":20,\n \"id_name\":\"solana\",\n \"title\":\"Solana\",\n \"enabled\":true\n },\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n },\n {\n \"id\":40,\n \"id_name\":\"arbitrum\",\n \"title\":\"Arbitrum\",\n \"enabled\":true\n },\n {\n \"id\":42,\n \"id_name\":\"base\",\n \"title\":\"Base\",\n \"enabled\":true\n },\n {\n \"id\":44,\n \"id_name\":\"optimism\",\n \"title\":\"Optimism\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":165,\n \"title\":\"SHIBA INU\",\n \"kind\":\"crypto\",\n \"symbol\":\"SHIB\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n },\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":91,\n \"title\":\"Binance Coin\",\n \"kind\":\"crypto\",\n \"symbol\":\"BNB\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":60,\n \"title\":\"TRON\",\n \"kind\":\"crypto\",\n \"symbol\":\"TRX\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":4,\n \"id_name\":\"tron\",\n \"title\":\"Tron\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":8,\n \"title\":\"Bitcoin\",\n \"kind\":\"crypto\",\n \"symbol\":\"BTC\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":5,\n \"id_name\":\"bitcoin\",\n \"title\":\"Bitcoin\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":49,\n \"title\":\"Litecoin\",\n \"kind\":\"crypto\",\n \"symbol\":\"LTC\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":6,\n \"id_name\":\"litecoin\",\n \"title\":\"Litecoin\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":117,\n \"title\":\"Solana\",\n \"kind\":\"crypto\",\n \"symbol\":\"SOL\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":20,\n \"id_name\":\"solana\",\n \"title\":\"Solana\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":112,\n \"title\":\"Polygon\",\n \"kind\":\"crypto\",\n \"symbol\":\"POL\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n }\n ]\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 50, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "ETH" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {}, "platforms": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "id_name": { "type": "string", "example": "ethereum" }, "title": { "type": "string", "example": "Ethereum" }, "enabled": { "type": "boolean", "example": true, "default": true } } } } } } } } } } }, "deprecated": false, "security": [] } }, "/ledger/conversions": { "post": { "summary": "Create Conversion", "description": "", "operationId": "create-conversion", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ledger_account_id": { "type": "string", "description": "The ID of the ledger account from which the balance will be converted. Can be retrieved from https://api.coingate.com/api/v2/ledger/accounts" }, "quote_currency_id": { "type": "integer", "description": "The ID of the currency to which the balance will be converted. Can be retrieved from https://developer.coingate.com/reference/conversion-rates" }, "base_amount": { "type": "string", "description": "Amount to convert, expressed in the currency of the ledger account" } }, "required": [ "ledger_account_id", "quote_currency_id", "base_amount" ] } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"01JWDJNDPFYC04ZCPC9VC568SP\",\n \"status\": \"pending\",\n \"base_amount\": \"0.001\",\n \"base_ledger_account\": {\n \"id\": \"01JRFQJ16HTQTT969F3G81F185\",\n \"balance\": \"0.93534066\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"quote_amount\": \"81.67\",\n \"quote_ledger_account\": {\n \"id\": \"01JS1EHJDFEF9KD5J9FFV2A1S0\",\n \"balance\": \"1387.13\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"fees\": {\n \"conversion_fee\": {\n \"amount\": \"0.00001\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n }\n },\n \"actions_required\": {\n \"confirm\": \"https://api.coingate.com/api/v2/ledger/conversions/01JWDJNDPFYC04ZCPC9VC568SP/confirm\",\n \"cancel\": \"https://api.coingate.com/api/v2/ledger/conversions/01JWDJNDPFYC04ZCPC9VC568SP/cancel\"\n },\n \"created_at\": \"2025-05-29T08:31:13.622Z\",\n \"expires_at\": \"2025-05-29T08:32:18.615Z\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "01JWDJNDPFYC04ZCPC9VC568SP" }, "status": { "type": "string", "example": "pending" }, "base_amount": { "type": "string", "example": "0.001" }, "base_ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JRFQJ16HTQTT969F3G81F185" }, "balance": { "type": "string", "example": "0.93534066" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } }, "quote_amount": { "type": "string", "example": "81.67" }, "quote_ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JS1EHJDFEF9KD5J9FFV2A1S0" }, "balance": { "type": "string", "example": "1387.13" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } }, "fees": { "type": "object", "properties": { "conversion_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } } } }, "actions_required": { "type": "object", "properties": { "confirm": { "type": "string", "example": "https://api.coingate.com/api/v2/ledger/conversions/01JWDJNDPFYC04ZCPC9VC568SP/confirm" }, "cancel": { "type": "string", "example": "https://api.coingate.com/api/v2/ledger/conversions/01JWDJNDPFYC04ZCPC9VC568SP/cancel" } } }, "created_at": { "type": "string", "example": "2025-05-29T08:31:13.622Z" }, "expires_at": { "type": "string", "example": "2025-05-29T08:32:18.615Z" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Ledger Conversion is not valid\",\n \"reason\": \"LedgerConversionIsNotValid\",\n \"errors\": [\n \"The BTC/GBP conversion pair is not supported on CoinGate.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Ledger Conversion is not valid" }, "reason": { "type": "string", "example": "LedgerConversionIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "The BTC/GBP conversion pair is not supported on CoinGate." } } } } } } } }, "deprecated": false }, "get": { "summary": "List Conversions", "description": "", "operationId": "list-conversions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "per_page": { "type": "integer", "description": "Records per page you would like to see", "default": 100, "format": "int32" }, "page": { "type": "integer", "description": "Current page number", "default": 1, "format": "int32" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 1,\n \"per_page\": 5,\n \"total_records\": 34,\n \"total_pages\": 7,\n \"exchange_transactions\": [\n {\n \"id\": \"01JW6EM5M1PDKHWW865WJXS8TG\",\n \"status\": \"canceled\",\n \"base_amount\": \"0.001\",\n \"base_ledger_account\": {\n \"id\": \"01JRFQJ16HTQTT969F3G81F185\",\n \"balance\": \"0.93534066\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"quote_amount\": \"81.67\",\n \"quote_ledger_account\": {\n \"id\": \"01JS1EHJDFEF9KD5J9FFV2A1S0\",\n \"balance\": \"1387.13\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"fees\": {\n \"conversion_fee\": {\n \"amount\": \"0.00001\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n }\n },\n \"created_at\": \"2025-05-26T14:05:57.273Z\",\n \"expires_at\": \"2025-05-26T14:07:02.251Z\"\n },\n {\n \"id\": \"01JW6EMXNPVJN56C0MBZJNT030\",\n \"status\": \"completed\",\n \"base_amount\": \"0.001\",\n \"base_ledger_account\": {\n \"id\": \"01JRFQJ16HTQTT969F3G81F185\",\n \"balance\": \"0.93534066\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"quote_amount\": \"81.67\",\n \"quote_ledger_account\": {\n \"id\": \"01JS1EHJDFEF9KD5J9FFV2A1S0\",\n \"balance\": \"1387.13\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"fees\": {\n \"conversion_fee\": {\n \"amount\": \"0.00001\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n }\n },\n \"created_at\": \"2025-05-26T14:06:21.885Z\",\n \"expires_at\": \"2025-05-26T14:07:26.878Z\"\n },\n {\n \"id\": \"01JW8B2AYED0FMKW6X4CKB58F3\",\n \"status\": \"completed\",\n \"base_amount\": \"100.0\",\n \"base_ledger_account\": {\n \"id\": \"01JS1EHJDFEF9KD5J9FFV2A1S0\",\n \"balance\": \"1387.13\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"quote_amount\": \"0.001225\",\n \"quote_ledger_account\": {\n \"id\": \"01JRFQJ16HTQTT969F3G81F185\",\n \"balance\": \"0.93534066\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"fees\": {\n \"conversion_fee\": {\n \"amount\": \"1.0\",\n \"currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n }\n },\n \"created_at\": \"2025-05-27T07:42:16.040Z\",\n \"expires_at\": \"2025-05-27T07:43:21.014Z\"\n },\n {\n \"id\": \"01JW94AMCJK51Z00K5DHWTD4S1\",\n \"status\": \"pending\",\n \"base_amount\": \"0.01\",\n \"base_ledger_account\": {\n \"id\": \"01JRFQJ16HTQTT969F3G81F185\",\n \"balance\": \"0.93534066\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"quote_amount\": \"816.66\",\n \"quote_ledger_account\": {\n \"id\": \"01JS1EHJDFEF9KD5J9FFV2A1S0\",\n \"balance\": \"1387.13\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"fees\": {\n \"conversion_fee\": {\n \"amount\": \"0.0001\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n }\n },\n \"actions_required\": {\n \"confirm\": \"https://api.coingate.com/api/v2/ledger/conversions/01JW94AMCJK51Z00K5DHWTD4S1/confirm\",\n \"cancel\": \"https://api.coingate.com/api/v2/ledger/conversions/01JW94AMCJK51Z00K5DHWTD4S1/cancel\"\n },\n \"created_at\": \"2025-05-27T15:03:42.256Z\",\n \"expires_at\": \"2025-05-27T15:04:47.226Z\"\n },\n {\n \"id\": \"01JW94F88NBY2RYMZV46HK182W\",\n \"status\": \"pending\",\n \"base_amount\": \"0.01\",\n \"base_ledger_account\": {\n \"id\": \"01JRFQJ16HTQTT969F3G81F185\",\n \"balance\": \"0.93534066\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"quote_amount\": \"816.66\",\n \"quote_ledger_account\": {\n \"id\": \"01JS1EHJDFEF9KD5J9FFV2A1S0\",\n \"balance\": \"1387.13\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"fees\": {\n \"conversion_fee\": {\n \"amount\": \"0.0001\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n }\n },\n \"actions_required\": {\n \"confirm\": \"https://api.coingate.com/api/v2/ledger/conversions/01JW94F88NBY2RYMZV46HK182W/confirm\",\n \"cancel\": \"https://api.coingate.com/api/v2/ledger/conversions/01JW94F88NBY2RYMZV46HK182W/cancel\"\n },\n \"created_at\": \"2025-05-27T15:06:13.700Z\",\n \"expires_at\": \"2025-05-27T15:07:18.654Z\"\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 5, "default": 0 }, "total_records": { "type": "integer", "example": 34, "default": 0 }, "total_pages": { "type": "integer", "example": 7, "default": 0 }, "exchange_transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "01JW6EM5M1PDKHWW865WJXS8TG" }, "status": { "type": "string", "example": "canceled" }, "base_amount": { "type": "string", "example": "0.001" }, "base_ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JRFQJ16HTQTT969F3G81F185" }, "balance": { "type": "string", "example": "0.93534066" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } }, "quote_amount": { "type": "string", "example": "81.67" }, "quote_ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JS1EHJDFEF9KD5J9FFV2A1S0" }, "balance": { "type": "string", "example": "1387.13" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } }, "fees": { "type": "object", "properties": { "conversion_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } } } }, "created_at": { "type": "string", "example": "2025-05-26T14:05:57.273Z" }, "expires_at": { "type": "string", "example": "2025-05-26T14:07:02.251Z" } } } } } } } } } }, "deprecated": false } }, "/ledger/conversions/{id}/confirm": { "patch": { "summary": "Confirm Conversion", "description": "", "operationId": "confirm-conversion", "parameters": [ { "name": "id", "in": "path", "description": "Conversion ID", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"01JWDJX0KJE1D3BP97R2TKTED6\",\n \"status\": \"completed\",\n \"base_amount\": \"0.001\",\n \"base_ledger_account\": {\n \"id\": \"01JRFQJ16HTQTT969F3G81F185\",\n \"balance\": \"0.93534066\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"quote_amount\": \"81.67\",\n \"quote_ledger_account\": {\n \"id\": \"01JS1EHJDFEF9KD5J9FFV2A1S0\",\n \"balance\": \"1387.13\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"fees\": {\n \"conversion_fee\": {\n \"amount\": \"0.00001\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n }\n },\n \"created_at\": \"2025-05-29T08:35:22.364Z\",\n \"expires_at\": \"2025-05-29T08:36:27.355Z\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "01JWDJX0KJE1D3BP97R2TKTED6" }, "status": { "type": "string", "example": "completed" }, "base_amount": { "type": "string", "example": "0.001" }, "base_ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JRFQJ16HTQTT969F3G81F185" }, "balance": { "type": "string", "example": "0.93534066" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } }, "quote_amount": { "type": "string", "example": "81.67" }, "quote_ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JS1EHJDFEF9KD5J9FFV2A1S0" }, "balance": { "type": "string", "example": "1387.13" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } }, "fees": { "type": "object", "properties": { "conversion_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } } } }, "created_at": { "type": "string", "example": "2025-05-29T08:35:22.364Z" }, "expires_at": { "type": "string", "example": "2025-05-29T08:36:27.355Z" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Ledger conversion not found\",\n \"reason\": \"LedgerConversionNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Ledger conversion not found" }, "reason": { "type": "string", "example": "LedgerConversionNotFound" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Ledger Conversion is not valid\",\n \"reason\": \"LedgerConversionIsNotValid\",\n \"errors\": [\n \"Conversion can only be confirmed when in 'pending' state. Current state: completed.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Ledger Conversion is not valid" }, "reason": { "type": "string", "example": "LedgerConversionIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Conversion can only be confirmed when in 'pending' state. Current state: completed." } } } } } } } }, "deprecated": false } }, "/ledger/conversions/{id}/cancel": { "patch": { "summary": "Cancel Conversion", "description": "", "operationId": "cancel-conversion", "parameters": [ { "name": "id", "in": "path", "description": "Conversion ID", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"01JWDK7X1CCB0NATRJQMMM7995\",\n \"status\": \"canceled\",\n \"base_amount\": \"0.001\",\n \"base_ledger_account\": {\n \"id\": \"01JRFQJ16HTQTT969F3G81F185\",\n \"balance\": \"0.93433066\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"quote_amount\": \"81.67\",\n \"quote_ledger_account\": {\n \"id\": \"01JS1EHJDFEF9KD5J9FFV2A1S0\",\n \"balance\": \"1468.8\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"fees\": {\n \"conversion_fee\": {\n \"amount\": \"0.00001\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n }\n },\n \"created_at\": \"2025-05-29T08:41:19.159Z\",\n \"expires_at\": \"2025-05-29T08:42:24.149Z\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "01JWDK7X1CCB0NATRJQMMM7995" }, "status": { "type": "string", "example": "canceled" }, "base_amount": { "type": "string", "example": "0.001" }, "base_ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JRFQJ16HTQTT969F3G81F185" }, "balance": { "type": "string", "example": "0.93433066" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } }, "quote_amount": { "type": "string", "example": "81.67" }, "quote_ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JS1EHJDFEF9KD5J9FFV2A1S0" }, "balance": { "type": "string", "example": "1468.8" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } }, "fees": { "type": "object", "properties": { "conversion_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } } } }, "created_at": { "type": "string", "example": "2025-05-29T08:41:19.159Z" }, "expires_at": { "type": "string", "example": "2025-05-29T08:42:24.149Z" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Ledger conversion not found\",\n \"reason\": \"LedgerConversionNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Ledger conversion not found" }, "reason": { "type": "string", "example": "LedgerConversionNotFound" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Ledger Conversion is not valid\",\n \"reason\": \"LedgerConversionIsNotValid\",\n \"errors\": [\n \"Conversion can only be canceled when in 'pending' state. Current state: completed.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Ledger Conversion is not valid" }, "reason": { "type": "string", "example": "LedgerConversionIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Conversion can only be canceled when in 'pending' state. Current state: completed." } } } } } } } }, "deprecated": false } }, "/ledger/conversions/{id}": { "get": { "summary": "Get Conversion", "description": "", "operationId": "get-conversion", "parameters": [ { "name": "id", "in": "path", "description": "Conversion ID", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"01JW6EM5M1PDKHWW865WJXS8TG\",\n \"status\": \"canceled\",\n \"base_amount\": \"0.001\",\n \"base_ledger_account\": {\n \"id\": \"01JRFQJ16HTQTT969F3G81F185\",\n \"balance\": \"0.93534066\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"quote_amount\": \"81.67\",\n \"quote_ledger_account\": {\n \"id\": \"01JS1EHJDFEF9KD5J9FFV2A1S0\",\n \"balance\": \"1387.13\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n },\n \"fees\": {\n \"conversion_fee\": {\n \"amount\": \"0.00001\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"disabled_message\": null\n }\n }\n },\n \"created_at\": \"2025-05-26T14:05:57.273Z\",\n \"expires_at\": \"2025-05-26T14:07:02.251Z\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "01JW6EM5M1PDKHWW865WJXS8TG" }, "status": { "type": "string", "example": "canceled" }, "base_amount": { "type": "string", "example": "0.001" }, "base_ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JRFQJ16HTQTT969F3G81F185" }, "balance": { "type": "string", "example": "0.93534066" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } }, "quote_amount": { "type": "string", "example": "81.67" }, "quote_ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01JS1EHJDFEF9KD5J9FFV2A1S0" }, "balance": { "type": "string", "example": "1387.13" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } }, "fees": { "type": "object", "properties": { "conversion_fee": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.00001" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {} } } } } } }, "created_at": { "type": "string", "example": "2025-05-26T14:05:57.273Z" }, "expires_at": { "type": "string", "example": "2025-05-26T14:07:02.251Z" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Ledger conversion not found\",\n \"reason\": \"LedgerConversionNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Ledger conversion not found" }, "reason": { "type": "string", "example": "LedgerConversionNotFound" } } } } } } }, "deprecated": false } }, "/ledger/conversions/rates": { "get": { "summary": "Conversion Rates", "description": "List Supported Conversion Rates", "operationId": "conversion-rates", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"rates\": {\n \"BTC\": {\n \"USD\": \"108822.41\",\n \"EUR\": \"96048.7\",\n \"GBP\": \"80657.4\",\n \"DAI\": \"108899\",\n \"USDC\": \"108829\",\n \"LTC\": \"1128.41\",\n \"ETH\": \"41.0877\",\n \"BCH\": \"261.1716\",\n \"XRP\": \"47258.98\",\n \"TRX\": \"395257\",\n \"DOGE\": \"487805\",\n \"BNB\": \"158.6043\",\n \"AVA\": \"112867\",\n \"POL\": \"471698\",\n \"ADA\": \"143472\",\n \"SOL\": \"626.4487\",\n \"AVAX\": \"2240.65\"\n },\n \"LTC\": {\n \"USD\": \"96.74\",\n \"BTC\": \"0.0008862\",\n \"EUR\": \"85.39\",\n \"GBP\": \"71.7\",\n \"ETH\": \"0.03646\",\n \"USDC\": \"96.73\"\n },\n \"ETH\": {\n \"USD\": \"2648.6\",\n \"BTC\": \"0.02433819\",\n \"EUR\": \"2338.55\",\n \"GBP\": \"1964.0\",\n \"DAI\": \"2651.18\",\n \"USDC\": \"2648.29\",\n \"LTC\": \"27.4273\",\n \"SOL\": \"15.2138\"\n },\n \"BCH\": {\n \"USD\": \"419.71\",\n \"BTC\": \"0.0038289\",\n \"EUR\": \"370.31\",\n \"GBP\": \"310.78\",\n \"USDC\": \"419.8\"\n },\n \"XRP\": {\n \"USD\": \"2.31\",\n \"BTC\": \"0.00002116\",\n \"EUR\": \"2.04\",\n \"GBP\": \"1.71\",\n \"USDC\": \"2.30616\"\n },\n \"TRX\": {\n \"BTC\": \"0.00000253\",\n \"EUR\": \"0.2433\",\n \"USDC\": \"0.2757\"\n },\n \"DAI\": {\n \"EUR\": \"0.882\",\n \"BTC\": \"0.00000918\",\n \"ETH\": \"0.00037719\"\n },\n \"DOGE\": {\n \"BTC\": \"0.00000205\",\n \"EUR\": \"0.1972\",\n \"GBP\": \"0.1655\",\n \"USDC\": \"0.22309\"\n },\n \"BNB\": {\n \"BTC\": \"0.006305\",\n \"EUR\": \"606.2\",\n \"GBP\": \"508.77\",\n \"POL\": \"2984.18\"\n },\n \"AVA\": {\n \"BTC\": \"0.00000886\"\n },\n \"POL\": {\n \"USD\": \"0.2312\",\n \"BTC\": \"0.00000212\",\n \"EUR\": \"0.2041\",\n \"GBP\": \"0.1713\",\n \"BNB\": \"0.0003351\"\n },\n \"USDC\": {\n \"USD\": \"0.9998\",\n \"EUR\": \"0.8827\",\n \"GBP\": \"0.7411\",\n \"BTC\": \"0.00000919\",\n \"LTC\": \"0.01033805\",\n \"ETH\": \"0.0003776\",\n \"BCH\": \"0.00238209\",\n \"XRP\": \"0.433621\",\n \"TRX\": \"3.627131\",\n \"DOGE\": \"4.482496\",\n \"ADA\": \"1.316619\",\n \"SOL\": \"0.00574515\",\n \"SHIB\": \"69979.01\"\n },\n \"ADA\": {\n \"USD\": \"0.759\",\n \"BTC\": \"0.00000697\",\n \"EUR\": \"0.67\",\n \"GBP\": \"0.5624\",\n \"USDC\": \"0.759521\"\n },\n \"SOL\": {\n \"BTC\": \"0.0015963\",\n \"EUR\": \"153.72\",\n \"GBP\": \"129.01\",\n \"ETH\": \"0.06573\",\n \"USDC\": \"174.06\"\n },\n \"SHIB\": {\n \"EUR\": \"0.00001264\",\n \"USDC\": \"0.00001429\"\n },\n \"AVAX\": {\n \"BTC\": \"0.0004463\",\n \"EUR\": \"23.82\"\n },\n \"USD\": {\n \"BTC\": \"0.00000919\",\n \"LTC\": \"0.010337\",\n \"ETH\": \"0.00037756\",\n \"BCH\": \"0.002383\",\n \"XRP\": \"0.4333\",\n \"POL\": \"4.3253\",\n \"USDC\": \"1.0002\",\n \"ADA\": \"1.3176\"\n },\n \"EUR\": {\n \"BTC\": \"0.00001041\",\n \"LTC\": \"0.011711\",\n \"ETH\": \"0.00042762\",\n \"BCH\": \"0.0027\",\n \"XRP\": \"0.491\",\n \"TRX\": \"4.1101\",\n \"DAI\": \"1.1338\",\n \"DOGE\": \"5.0715\",\n \"BNB\": \"0.00165\",\n \"POL\": \"4.9005\",\n \"USDC\": \"1.1329\",\n \"ADA\": \"1.4924\",\n \"SOL\": \"0.006505\",\n \"SHIB\": \"79114\",\n \"AVAX\": \"0.041982\"\n },\n \"GBP\": {\n \"BTC\": \"0.0000124\",\n \"LTC\": \"0.013947\",\n \"ETH\": \"0.00050916\",\n \"BCH\": \"0.003218\",\n \"XRP\": \"0.585\",\n \"DOGE\": \"6.0427\",\n \"BNB\": \"0.001966\",\n \"POL\": \"5.839\",\n \"USDC\": \"1.3493\",\n \"ADA\": \"1.7782\",\n \"SOL\": \"0.007751\"\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "rates": { "type": "object", "properties": { "BTC": { "type": "object", "properties": { "USD": { "type": "string", "example": "108822.41" }, "EUR": { "type": "string", "example": "96048.7" }, "GBP": { "type": "string", "example": "80657.4" }, "DAI": { "type": "string", "example": "108899" }, "USDC": { "type": "string", "example": "108829" }, "LTC": { "type": "string", "example": "1128.41" }, "ETH": { "type": "string", "example": "41.0877" }, "BCH": { "type": "string", "example": "261.1716" }, "XRP": { "type": "string", "example": "47258.98" }, "TRX": { "type": "string", "example": "395257" }, "DOGE": { "type": "string", "example": "487805" }, "BNB": { "type": "string", "example": "158.6043" }, "AVA": { "type": "string", "example": "112867" }, "POL": { "type": "string", "example": "471698" }, "ADA": { "type": "string", "example": "143472" }, "SOL": { "type": "string", "example": "626.4487" }, "AVAX": { "type": "string", "example": "2240.65" } } }, "LTC": { "type": "object", "properties": { "USD": { "type": "string", "example": "96.74" }, "BTC": { "type": "string", "example": "0.0008862" }, "EUR": { "type": "string", "example": "85.39" }, "GBP": { "type": "string", "example": "71.7" }, "ETH": { "type": "string", "example": "0.03646" }, "USDC": { "type": "string", "example": "96.73" } } }, "ETH": { "type": "object", "properties": { "USD": { "type": "string", "example": "2648.6" }, "BTC": { "type": "string", "example": "0.02433819" }, "EUR": { "type": "string", "example": "2338.55" }, "GBP": { "type": "string", "example": "1964.0" }, "DAI": { "type": "string", "example": "2651.18" }, "USDC": { "type": "string", "example": "2648.29" }, "LTC": { "type": "string", "example": "27.4273" }, "SOL": { "type": "string", "example": "15.2138" } } }, "BCH": { "type": "object", "properties": { "USD": { "type": "string", "example": "419.71" }, "BTC": { "type": "string", "example": "0.0038289" }, "EUR": { "type": "string", "example": "370.31" }, "GBP": { "type": "string", "example": "310.78" }, "USDC": { "type": "string", "example": "419.8" } } }, "XRP": { "type": "object", "properties": { "USD": { "type": "string", "example": "2.31" }, "BTC": { "type": "string", "example": "0.00002116" }, "EUR": { "type": "string", "example": "2.04" }, "GBP": { "type": "string", "example": "1.71" }, "USDC": { "type": "string", "example": "2.30616" } } }, "TRX": { "type": "object", "properties": { "BTC": { "type": "string", "example": "0.00000253" }, "EUR": { "type": "string", "example": "0.2433" }, "USDC": { "type": "string", "example": "0.2757" } } }, "DAI": { "type": "object", "properties": { "EUR": { "type": "string", "example": "0.882" }, "BTC": { "type": "string", "example": "0.00000918" }, "ETH": { "type": "string", "example": "0.00037719" } } }, "DOGE": { "type": "object", "properties": { "BTC": { "type": "string", "example": "0.00000205" }, "EUR": { "type": "string", "example": "0.1972" }, "GBP": { "type": "string", "example": "0.1655" }, "USDC": { "type": "string", "example": "0.22309" } } }, "BNB": { "type": "object", "properties": { "BTC": { "type": "string", "example": "0.006305" }, "EUR": { "type": "string", "example": "606.2" }, "GBP": { "type": "string", "example": "508.77" }, "POL": { "type": "string", "example": "2984.18" } } }, "AVA": { "type": "object", "properties": { "BTC": { "type": "string", "example": "0.00000886" } } }, "POL": { "type": "object", "properties": { "USD": { "type": "string", "example": "0.2312" }, "BTC": { "type": "string", "example": "0.00000212" }, "EUR": { "type": "string", "example": "0.2041" }, "GBP": { "type": "string", "example": "0.1713" }, "BNB": { "type": "string", "example": "0.0003351" } } }, "USDC": { "type": "object", "properties": { "USD": { "type": "string", "example": "0.9998" }, "EUR": { "type": "string", "example": "0.8827" }, "GBP": { "type": "string", "example": "0.7411" }, "BTC": { "type": "string", "example": "0.00000919" }, "LTC": { "type": "string", "example": "0.01033805" }, "ETH": { "type": "string", "example": "0.0003776" }, "BCH": { "type": "string", "example": "0.00238209" }, "XRP": { "type": "string", "example": "0.433621" }, "TRX": { "type": "string", "example": "3.627131" }, "DOGE": { "type": "string", "example": "4.482496" }, "ADA": { "type": "string", "example": "1.316619" }, "SOL": { "type": "string", "example": "0.00574515" }, "SHIB": { "type": "string", "example": "69979.01" } } }, "ADA": { "type": "object", "properties": { "USD": { "type": "string", "example": "0.759" }, "BTC": { "type": "string", "example": "0.00000697" }, "EUR": { "type": "string", "example": "0.67" }, "GBP": { "type": "string", "example": "0.5624" }, "USDC": { "type": "string", "example": "0.759521" } } }, "SOL": { "type": "object", "properties": { "BTC": { "type": "string", "example": "0.0015963" }, "EUR": { "type": "string", "example": "153.72" }, "GBP": { "type": "string", "example": "129.01" }, "ETH": { "type": "string", "example": "0.06573" }, "USDC": { "type": "string", "example": "174.06" } } }, "SHIB": { "type": "object", "properties": { "EUR": { "type": "string", "example": "0.00001264" }, "USDC": { "type": "string", "example": "0.00001429" } } }, "AVAX": { "type": "object", "properties": { "BTC": { "type": "string", "example": "0.0004463" }, "EUR": { "type": "string", "example": "23.82" } } }, "USD": { "type": "object", "properties": { "BTC": { "type": "string", "example": "0.00000919" }, "LTC": { "type": "string", "example": "0.010337" }, "ETH": { "type": "string", "example": "0.00037756" }, "BCH": { "type": "string", "example": "0.002383" }, "XRP": { "type": "string", "example": "0.4333" }, "POL": { "type": "string", "example": "4.3253" }, "USDC": { "type": "string", "example": "1.0002" }, "ADA": { "type": "string", "example": "1.3176" } } }, "EUR": { "type": "object", "properties": { "BTC": { "type": "string", "example": "0.00001041" }, "LTC": { "type": "string", "example": "0.011711" }, "ETH": { "type": "string", "example": "0.00042762" }, "BCH": { "type": "string", "example": "0.0027" }, "XRP": { "type": "string", "example": "0.491" }, "TRX": { "type": "string", "example": "4.1101" }, "DAI": { "type": "string", "example": "1.1338" }, "DOGE": { "type": "string", "example": "5.0715" }, "BNB": { "type": "string", "example": "0.00165" }, "POL": { "type": "string", "example": "4.9005" }, "USDC": { "type": "string", "example": "1.1329" }, "ADA": { "type": "string", "example": "1.4924" }, "SOL": { "type": "string", "example": "0.006505" }, "SHIB": { "type": "string", "example": "79114" }, "AVAX": { "type": "string", "example": "0.041982" } } }, "GBP": { "type": "object", "properties": { "BTC": { "type": "string", "example": "0.0000124" }, "LTC": { "type": "string", "example": "0.013947" }, "ETH": { "type": "string", "example": "0.00050916" }, "BCH": { "type": "string", "example": "0.003218" }, "XRP": { "type": "string", "example": "0.585" }, "DOGE": { "type": "string", "example": "6.0427" }, "BNB": { "type": "string", "example": "0.001966" }, "POL": { "type": "string", "example": "5.839" }, "USDC": { "type": "string", "example": "1.3493" }, "ADA": { "type": "string", "example": "1.7782" }, "SOL": { "type": "string", "example": "0.007751" } } } } } } } } } } }, "deprecated": false, "security": [] } }, "/deposits/supported-currencies": { "get": { "summary": "Supported Currencies", "description": "List Supported Deposit Currencies and Crypto Platforms", "operationId": "deposit-supported-currencies", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"id\":50,\n \"title\":\"Ethereum\",\n \"kind\":\"crypto\",\n \"symbol\":\"ETH\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":40,\n \"id_name\":\"arbitrum\",\n \"title\":\"Arbitrum\",\n \"enabled\":true\n },\n {\n \"id\":42,\n \"id_name\":\"base\",\n \"title\":\"Base\",\n \"enabled\":true\n },\n {\n \"id\":44,\n \"id_name\":\"optimism\",\n \"title\":\"Optimism\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":61,\n \"title\":\"Dai\",\n \"kind\":\"crypto\",\n \"symbol\":\"DAI\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n },\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":91,\n \"title\":\"Binance Coin\",\n \"kind\":\"crypto\",\n \"symbol\":\"BNB\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":97,\n \"title\":\"USDT\",\n \"kind\":\"crypto\",\n \"symbol\":\"USDT\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n },\n {\n \"id\":4,\n \"id_name\":\"tron\",\n \"title\":\"Tron\",\n \"enabled\":true\n },\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n },\n {\n \"id\":40,\n \"id_name\":\"arbitrum\",\n \"title\":\"Arbitrum\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":103,\n \"title\":\"Mysterium\",\n \"kind\":\"crypto\",\n \"symbol\":\"MYST\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":113,\n \"title\":\"USDC\",\n \"kind\":\"crypto\",\n \"symbol\":\"USDC\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n },\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n },\n {\n \"id\":42,\n \"id_name\":\"base\",\n \"title\":\"Base\",\n \"enabled\":true\n },\n {\n \"id\":44,\n \"id_name\":\"optimism\",\n \"title\":\"Optimism\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":165,\n \"title\":\"SHIBA INU\",\n \"kind\":\"crypto\",\n \"symbol\":\"SHIB\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":1,\n \"id_name\":\"ethereum\",\n \"title\":\"Ethereum\",\n \"enabled\":true\n },\n {\n \"id\":3,\n \"id_name\":\"binance_smart_chain\",\n \"title\":\"Binance Smart Chain\",\n \"enabled\":true\n },\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":60,\n \"title\":\"TRON\",\n \"kind\":\"crypto\",\n \"symbol\":\"TRX\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":4,\n \"id_name\":\"tron\",\n \"title\":\"Tron\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":8,\n \"title\":\"Bitcoin\",\n \"kind\":\"crypto\",\n \"symbol\":\"BTC\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":5,\n \"id_name\":\"bitcoin\",\n \"title\":\"Bitcoin\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":49,\n \"title\":\"Litecoin\",\n \"kind\":\"crypto\",\n \"symbol\":\"LTC\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":6,\n \"id_name\":\"litecoin\",\n \"title\":\"Litecoin\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":64,\n \"title\":\"Dogecoin\",\n \"kind\":\"crypto\",\n \"symbol\":\"DOGE\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":7,\n \"id_name\":\"dogecoin\",\n \"title\":\"Dogecoin\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":52,\n \"title\":\"Bitcoin Cash\",\n \"kind\":\"crypto\",\n \"symbol\":\"BCH\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":8,\n \"id_name\":\"bitcoin_cash\",\n \"title\":\"Bitcoin Cash\",\n \"enabled\":true\n }\n ]\n },\n {\n \"id\":112,\n \"title\":\"Polygon\",\n \"kind\":\"crypto\",\n \"symbol\":\"POL\",\n \"enabled\":true,\n \"disabled_message\":null,\n \"platforms\":[\n {\n \"id\":39,\n \"id_name\":\"polygon\",\n \"title\":\"Polygon\",\n \"enabled\":true\n }\n ]\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 50, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "ETH" }, "enabled": { "type": "boolean", "example": true, "default": true }, "disabled_message": {}, "platforms": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "id_name": { "type": "string", "example": "ethereum" }, "title": { "type": "string", "example": "Ethereum" }, "enabled": { "type": "boolean", "example": true, "default": true } } } } } } } } } } }, "deprecated": false, "security": [] } }, "/billing/contacts": { "post": { "summary": "Create Billing Contact", "description": "", "operationId": "create-billing-contact", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "contact_type", "email" ], "properties": { "contact_type": { "type": "string", "description": "Type of contact", "default": "\"person\"", "enum": [ "\"person\"", "\"business\"" ] }, "email": { "type": "string", "description": "Contact email address" }, "first_name": { "type": "string", "description": "First name of the contact (required if contact_type is \"person\")" }, "surname": { "type": "string", "description": "Surname of the contact (required if contact_type is \"person\")" }, "company_name": { "type": "string", "description": "Name of the company (required if contact_type is \"business\")" }, "external_contact_id": { "type": "string", "description": "External Contact ID that is used in your application (e.g. user or customer ID)." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 1,\n \"contact_type\": \"person\",\n \"email\": \"joe@doe.com\",\n \"first_name\": \"Joe\",\n \"surname\": \"Doe\",\n \"company_name\": null,\n \"external_contact_id\": \"AA1234\",\n \"created_at\": \"2024-10-15T15:38:35.787Z\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "contact_type": { "type": "string", "example": "person" }, "email": { "type": "string", "example": "joe@doe.com" }, "first_name": { "type": "string", "example": "Joe" }, "surname": { "type": "string", "example": "Doe" }, "company_name": {}, "external_contact_id": { "type": "string", "example": "AA1234" }, "created_at": { "type": "string", "example": "2024-10-15T15:38:35.787Z" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Billing contact is not valid\",\n \"reason\": \"BillingContactIsNotValid\",\n \"errors\": {\n \"email\": [\n \"is not an email\",\n \"can't be blank\"\n ]\n }\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Billing contact is not valid" }, "reason": { "type": "string", "example": "BillingContactIsNotValid" }, "errors": { "type": "object", "properties": { "email": { "type": "array", "items": { "type": "string", "example": "is not an email" } } } } } } } } } }, "deprecated": false }, "get": { "summary": "List Billing Contacts", "description": "", "operationId": "list-billing-contacts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "per_page": { "type": "integer", "description": "Records per page", "default": 100, "format": "int32" }, "page": { "type": "integer", "description": "Current page number", "default": 1, "format": "int32" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 1,\n \"per_page\": 100,\n \"total_records\": 2,\n \"total_pages\": 1,\n \"billing_contacts\": [\n {\n \"id\": 1,\n \"contact_type\": \"business\",\n \"email\": \"example@company.com\",\n \"first_name\": null,\n \"surname\": null,\n \"company_name\": \"UAB Company Name\",\n \"created_at\": \"2024-10-15T13:52:31.587Z\"\n },\n {\n \"id\": 2,\n \"contact_type\": \"person\",\n \"email\": \"joe@doe.com\",\n \"first_name\": \"Joe\",\n \"surname\": \"Doe\",\n \"company_name\": null,\n \"created_at\": \"2024-10-15T15:38:35.787Z\"\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 100, "default": 0 }, "total_records": { "type": "integer", "example": 2, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 }, "billing_contacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "contact_type": { "type": "string", "example": "business" }, "email": { "type": "string", "example": "example@company.com" }, "first_name": {}, "surname": {}, "company_name": { "type": "string", "example": "UAB Company Name" }, "created_at": { "type": "string", "example": "2024-10-15T13:52:31.587Z" } } } } } } } } } }, "deprecated": false } }, "/billing/contacts/{id}": { "get": { "summary": "Get Billing Contact", "description": "", "operationId": "get-billing-contact", "parameters": [ { "name": "id", "in": "path", "description": "Billing Contact ID", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 1,\n \"contact_type\": \"person\",\n \"email\": \"joe@doe.com\",\n \"first_name\": \"Joe\",\n \"surname\": \"Doe\",\n \"company_name\": null,\n \"created_at\": \"2024-10-15T15:38:35.787Z\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "contact_type": { "type": "string", "example": "person" }, "email": { "type": "string", "example": "joe@doe.com" }, "first_name": { "type": "string", "example": "Joe" }, "surname": { "type": "string", "example": "Doe" }, "company_name": {}, "created_at": { "type": "string", "example": "2024-10-15T15:38:35.787Z" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Billing contact not found\",\n \"reason\": \"BillingContactNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Billing contact not found" }, "reason": { "type": "string", "example": "BillingContactNotFound" } } } } } } }, "deprecated": false }, "delete": { "summary": "Delete Billing Contact", "description": "", "operationId": "delete-billing-contact", "parameters": [ { "name": "id", "in": "path", "description": "Billing Contact ID", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 1,\n \"contact_type\": \"person\",\n \"email\": \"joe@doe.com\",\n \"first_name\": \"Joe\",\n \"surname\": \"Doe\",\n \"company_name\": null,\n \"created_at\": \"2024-10-15T15:38:35.787Z\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "contact_type": { "type": "string", "example": "person" }, "email": { "type": "string", "example": "joe@doe.com" }, "first_name": { "type": "string", "example": "Joe" }, "surname": { "type": "string", "example": "Doe" }, "company_name": {}, "created_at": { "type": "string", "example": "2024-10-15T15:38:35.787Z" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Billing contact not found\",\n \"reason\": \"BillingContactNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Billing contact not found" }, "reason": { "type": "string", "example": "BillingContactNotFound" } } } } } } }, "deprecated": false } }, "/billing/products": { "post": { "summary": "Create Billing Product", "description": "", "operationId": "create-billing-product", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "name", "price", "currency_id" ], "properties": { "name": { "type": "string", "description": "Product name" }, "price": { "type": "string", "description": "Product price" }, "currency_id": { "type": "integer", "description": "Currency ID's can be seen on https://developer.coingate.com/reference/currencies", "format": "int32" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 1,\n \"name\": \"Laptop\",\n \"price\": \"1000.0\",\n \"created_at\": \"2024-10-15T16:07:28.595Z\",\n \"currency\": {\n \"id\": 21,\n \"title\": \"USDT\",\n \"kind\": \"crypto\",\n \"symbol\": \"USDT\"\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Laptop" }, "price": { "type": "string", "example": "1000.0" }, "created_at": { "type": "string", "example": "2024-10-15T16:07:28.595Z" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 21, "default": 0 }, "title": { "type": "string", "example": "USDT" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "USDT" } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Billing product is not valid\",\n \"reason\": \"BillingProductIsNotValid\",\n \"errors\": {\n \"price\": [\n \"must be greater than 0\"\n ]\n }\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Billing product is not valid" }, "reason": { "type": "string", "example": "BillingProductIsNotValid" }, "errors": { "type": "object", "properties": { "price": { "type": "array", "items": { "type": "string", "example": "must be greater than 0" } } } } } } } } } }, "deprecated": false }, "get": { "summary": "List Billing Products", "description": "", "operationId": "list-billing-products", "parameters": [ { "name": "id", "in": "path", "description": "Billing Product ID", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "per_page": { "type": "integer", "description": "Records per page", "default": 100, "format": "int32" }, "page": { "type": "integer", "description": "Current page number", "default": 1, "format": "int32" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 1,\n \"per_page\": 100,\n \"total_records\": 2,\n \"total_pages\": 1,\n \"billing_products\": [\n {\n \"id\": 1,\n \"name\": \"Laptop\n \"price\": \"100\",\n \"created_at\": \"2024-10-15T13:52:54.665Z\",\n \"currency\": {\n \"id\": 21,\n \"title\": \"USDT\",\n \"kind\": \"crypto\",\n \"symbol\": \"USDT\"\n }\n },\n {\n \"id\": 2,\n \"name\": \"Mouse\",\n \"price\": \"25\",\n \"created_at\": \"2024-10-15T16:07:28.595Z\",\n \"currency\": {\n \"id\": 21,\n \"title\": \"USDT\",\n \"kind\": \"crypto\",\n \"symbol\": \"USDT\"\n }\n }\n ]\n}" } } } } } } } }, "/billing/products/{id}": { "get": { "summary": "Get Billing Product", "description": "", "operationId": "get-billing-product", "parameters": [ { "name": "id", "in": "path", "description": "Billing Product ID", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 1,\n \"name\": \"Laptop\",\n \"price\": \"1000.0\",\n \"created_at\": \"2024-10-15T16:07:28.595Z\",\n \"currency\": {\n \"id\": 21,\n \"title\": \"USDT\",\n \"kind\": \"crypto\",\n \"symbol\": \"USDT\"\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Laptop" }, "price": { "type": "string", "example": "1000.0" }, "created_at": { "type": "string", "example": "2024-10-15T16:07:28.595Z" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 21, "default": 0 }, "title": { "type": "string", "example": "USDT" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "USDT" } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Billing product not found\",\n \"reason\": \"BillingProductNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Billing product not found" }, "reason": { "type": "string", "example": "BillingProductNotFound" } } } } } } } }, "delete": { "summary": "Delete Billing Product", "description": "", "operationId": "delete-billing-product", "parameters": [ { "name": "id", "in": "path", "description": "Billign Product ID", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 1,\n \"name\": \"Laptop\",\n \"price\": \"1000.0\",\n \"created_at\": \"2024-10-15T16:07:28.595Z\",\n \"currency\": {\n \"id\": 21,\n \"title\": \"USDT\",\n \"kind\": \"crypto\",\n \"symbol\": \"USDT\"\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Laptop" }, "price": { "type": "string", "example": "1000.0" }, "created_at": { "type": "string", "example": "2024-10-15T16:07:28.595Z" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 21, "default": 0 }, "title": { "type": "string", "example": "USDT" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "USDT" } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Billing product not found\",\n \"reason\": \"BillingProductNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Billing product not found" }, "reason": { "type": "string", "example": "BillingProductNotFound" } } } } } } }, "deprecated": false } }, "/billing/requests": { "post": { "summary": "Create Billing Request", "description": "", "operationId": "create-billing-request", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 1,\n \"uuid\": \"f1d6b2ef-3024-4ea2-b046-60f96adc0fb5\",\n \"status\": \"pending\",\n \"title\": \"Lunch\",\n \"due_days\": 3,\n \"callback_url\": \"\",\n \"send_email\": false,\n \"underpaid_cover_pct\": \"0.0\",\n \"created_at\": \"2024-10-15T16:59:05.757Z\",\n \"billing_contact\": {\n \"id\": 1,\n \"contact_type\": \"person\",\n \"email\": \"joe@doe.com\",\n \"first_name\": \"Joe\",\n \"surname\": \"Doe\",\n \"external_contact_id\": \"AA1234\",\n \"created_at\": \"2024-10-15T14:13:47.730Z\"\n },\n \"price_currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\"\n },\n \"price_amount\": \"20.0\",\n \"receive_currency\": {\n \"id\": 2,\n \"title\": \"Euro\",\n \"kind\": \"fiat\",\n \"symbol\": \"EUR\"\n },\n \"receive_amount\": null,\n \"pay_currency\": null,\n \"pay_amount\": null,\n \"fees\": [],\n \"billing_request_items\": [],\n \"billing_request_url\": \"\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "uuid": { "type": "string", "example": "f1d6b2ef-3024-4ea2-b046-60f96adc0fb5" }, "status": { "type": "string", "example": "pending" }, "title": { "type": "string", "example": "Lunch" }, "due_days": { "type": "integer", "example": 3, "default": 0 }, "callback_url": { "type": "string", "example": "" }, "send_email": { "type": "boolean", "example": false, "default": true }, "underpaid_cover_pct": { "type": "string", "example": "0.0" }, "created_at": { "type": "string", "example": "2024-10-15T16:59:05.757Z" }, "billing_contact": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "contact_type": { "type": "string", "example": "person" }, "email": { "type": "string", "example": "joe@doe.com" }, "first_name": { "type": "string", "example": "Joe" }, "surname": { "type": "string", "example": "Doe" }, "external_contact_id": { "type": "string", "example": "AA1234" }, "created_at": { "type": "string", "example": "2024-10-15T14:13:47.730Z" } } }, "price_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } }, "price_amount": { "type": "string", "example": "20.0" }, "receive_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } }, "receive_amount": {}, "pay_currency": {}, "pay_amount": {}, "fees": { "type": "array" }, "billing_request_items": { "type": "array" }, "billing_request_url": { "type": "string", "example": "" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Billing request is not valid\",\n \"reason\": \"BillingRequestIsNotValid\",\n \"errors\": [\n \"Amount must be greater than 0\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Billing request is not valid" }, "reason": { "type": "string", "example": "BillingRequestIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Amount must be greater than 0" } } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "properties": { "billing_contact_id": { "type": "integer", "format": "int32", "description": "Billing Contact ID" }, "title": { "type": "string", "description": "Request title" }, "currency_id": { "type": "integer", "format": "int32", "description": "Currency of amount. Currency ID's can be seen on https://developer.coingate.com/reference/currencies" }, "amount": { "type": "string", "description": "Amount is required only when the request is created without associated products. If products are included, the amount is automatically calculated based on the product prices and quantities" }, "receive_currency_id": { "type": "integer", "format": "int32", "description": "Currency ID's can be seen on https://developer.coingate.com/reference/currencies" }, "due_days": { "type": "integer", "description": "Defines how many days the pay button remains active. Default: 0 won't expire. Example: A value of 3 means the pay button will remain active for 3 days after billing request has been created", "format": "int32", "default": "0" }, "send_email": { "type": "boolean", "default": "true", "description": "Will billing contact receive email about reqeust." }, "underpaid_cover_pct": { "type": "string", "description": "How much percentage of underpaid can be covered.", "default": "0" }, "callback_url": { "type": "string", "description": "Send an automated message to Merchant URL when request status is changed. For testing you can use requestcatcher.com tool. URL must be direct without redirection. Read about billing request callbacks [here](https://developer.coingate.com/reference/billing-request-callback)." }, "billing_request_items": { "type": "object", "properties": { "billing_product_id": { "type": "integer", "description": "Billing Product ID", "format": "int32" }, "quantity": { "type": "integer", "format": "int32", "description": "Quantity of product" } }, "description": "Billing Products and quantity. If present amount will calculated based on product price and quantity." } }, "type": "object", "required": [ "billing_contact_id", "currency_id", "receive_currency_id" ] } } } } }, "get": { "summary": "List Billing Requests", "description": "", "operationId": "list-billing-requests", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "per_page": { "type": "integer", "description": "Records per page", "default": 100, "format": "int32" }, "page": { "type": "integer", "description": "Current page number", "default": 1, "format": "int32" }, "sort": { "type": "string", "description": "Sort billing requests by field. Available sort options: created_at_asc, created_at_desc. Default: created_at_asc.", "default": "created_at_asc" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 1,\n \"per_page\": 100,\n \"total_records\": 2,\n \"total_pages\": 1,\n \"billing_requests\": [\n {\n \"id\": 1,\n \"uuid\": \"713177cf-49b7-4ad3-8927-06536f655168\",\n \"status\": \"pending\",\n \"title\": \"Sample Product\",\n \"due_days\": 15,\n \"callback_url\": \"https://callback.com/example\",\n \"send_email\": false,\n \"underpaid_cover_pct\": \"5.0\",\n \"created_at\": \"2024-10-15T13:54:17.642Z\",\n \"billing_contact\": {\n \"id\": 1,\n \"contact_type\": \"business\",\n \"email\": \"example@busines.com\",\n \"first_name\": null,\n \"surname\": null,\n \"company_name\": \"UAB Business\",\n \"created_at\": \"2024-10-15T13:52:31.587Z\"\n },\n \"price_currency\": {\n \"id\": 21,\n \"title\": \"USDT\",\n \"kind\": \"crypto\",\n \"symbol\": \"USDT\"\n },\n \"price_amount\": \"30.0\",\n \"receive_currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n },\n \"receive_amount\": null,\n\t\t\t\"pay_currency\": null,\n\t\t\t\"pay_amount\": null,\n \"fees\": [],\n \"billing_request_items\": [\n {\n \"id\": 1,\n \"billing_product_id\": 10,\n \"quantity\": 3\n }\n ],\n \"billing_request_url\": \"\"\n },\n {\n \"id\": 2,\n \"uuid\": \"f1d6b2ef-3024-4ea2-b046-60f96adc0fb5\",\n \"status\": \"completed\",\n \"title\": \"Lunch\",\n \"due_days\": 3,\n \"callback_url\": \"\",\n \"send_email\": true,\n \"underpaid_cover_pct\": \"0.0\",\n \"created_at\": \"2024-10-15T16:59:05.757Z\",\n \"billing_contact\": {\n \"id\": 2,\n \"contact_type\": \"person\",\n \"email\": \"joe@doe.com\",\n \"first_name\": \"Joe\",\n \"surname\": \"Doe\",\n \"company_name\": null,\n \"created_at\": \"2024-10-15T14:13:47.730Z\"\n },\n \"price_currency\": {\n\t\t\t\t\"id\": 2,\n\t\t\t\t\"title\": \"Euro\",\n\t\t\t\t\"kind\": \"fiat\",\n\t\t\t\t\"symbol\": \"EUR\"\n\t\t\t},\n\t\t\t\"price_amount\": \"20.0\",\n\t\t\t\"receive_currency\": {\n\t\t\t\t\"id\": 2,\n\t\t\t\t\"title\": \"Euro\",\n\t\t\t\t\"kind\": \"fiat\",\n\t\t\t\t\"symbol\": \"EUR\"\n\t\t\t},\n\t\t\t\"receive_amount\": \"19.8\",\n\t\t\t\"pay_currency\": {\n\t\t\t\t\"id\": 1,\n\t\t\t\t\"title\": \"Bitcoin\",\n\t\t\t\t\"kind\": \"crypto\",\n\t\t\t\t\"symbol\": \"BTC\"\n\t\t\t},\n\t\t\t\"pay_amount\": \"0.00022086\",\n\t\t\t\"fees\": [\n\t\t\t\t{\n\t\t\t\t\t\"type\": \"processing_fee\",\n\t\t\t\t\t\"amount\": \"0.2\",\n\t\t\t\t\t\"currency\": {\n\t\t\t\t\t\t\"id\": 2,\n\t\t\t\t\t\t\"symbol\": \"EUR\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t],\n \"billing_request_items\": [],\n \"billing_request_url\": \"\"\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 100, "default": 0 }, "total_records": { "type": "integer", "example": 2, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 }, "billing_requests": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "uuid": { "type": "string", "example": "713177cf-49b7-4ad3-8927-06536f655168" }, "status": { "type": "string", "example": "pending" }, "title": { "type": "string", "example": "Sample Product" }, "due_days": { "type": "integer", "example": 15, "default": 0 }, "callback_url": { "type": "string", "example": "https://callback.com/example" }, "send_email": { "type": "boolean", "example": false, "default": true }, "underpaid_cover_pct": { "type": "string", "example": "5.0" }, "created_at": { "type": "string", "example": "2024-10-15T13:54:17.642Z" }, "billing_contact": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "contact_type": { "type": "string", "example": "business" }, "email": { "type": "string", "example": "example@busines.com" }, "first_name": {}, "surname": {}, "company_name": { "type": "string", "example": "UAB Business" }, "created_at": { "type": "string", "example": "2024-10-15T13:52:31.587Z" } } }, "price_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 21, "default": 0 }, "title": { "type": "string", "example": "USDT" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "USDT" } } }, "price_amount": { "type": "string", "example": "30.0" }, "receive_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "receive_amount": {}, "pay_currency": {}, "pay_amount": {}, "fees": { "type": "array" }, "billing_request_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "billing_product_id": { "type": "integer", "example": 10, "default": 0 }, "quantity": { "type": "integer", "example": 3, "default": 0 } } } }, "billing_request_url": { "type": "string", "example": "" } } } } } } } } } }, "deprecated": false } }, "/billing/requests/{id}": { "get": { "summary": "Get Billing Request", "description": "", "operationId": "get-billing-request", "parameters": [ { "name": "id", "in": "path", "description": "Billing Request ID", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": 1, "uuid": "f1d6b2ef-3024-4ea2-b046-60f96adc0fb5", "status": "pending", "order_id": null, "title": "Lunch", "due_days": 3, "callback_url": "", "send_email": false, "underpaid_cover_pct": "0.0", "created_at": "2024-10-15T16:59:05.757Z", "billing_contact": { "id": 1, "contact_type": "person", "email": "joe@doe.com", "first_name": "Joe", "surname": "Doe", "external_contact_id": "AA1234", "created_at": "2024-10-15T14:13:47.730Z" }, "price_currency": { "id": 2, "title": "Euro", "kind": "fiat", "symbol": "EUR" }, "price_amount": "20.0", "receive_currency": { "id": 2, "title": "Euro", "kind": "fiat", "symbol": "EUR" }, "receive_amount": "19.8", "pay_currency": { "id": 1, "title": "Bitcoin", "kind": "crypto", "symbol": "BTC" }, "pay_amount": "0.00022086", "fees": [ { "type": "processing_fee", "amount": "0.2", "currency": { "id": 2, "symbol": "EUR" } } ], "billing_request_items": [], "billing_request_url": "" } } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "uuid": { "type": "string", "example": "f1d6b2ef-3024-4ea2-b046-60f96adc0fb5" }, "status": { "type": "string", "example": "pending" }, "order_id": { "type": "integer", "default": "", "description": "Order ID assigned to a paid billing request." }, "title": { "type": "string", "example": "Lunch" }, "due_days": { "type": "integer", "example": 3, "default": 0 }, "callback_url": { "type": "string", "example": "" }, "send_email": { "type": "boolean", "example": false, "default": true }, "underpaid_cover_pct": { "type": "string", "example": "0.0" }, "created_at": { "type": "string", "example": "2024-10-15T16:59:05.757Z" }, "billing_contact": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "contact_type": { "type": "string", "example": "person" }, "email": { "type": "string", "example": "joe@doe.com" }, "first_name": { "type": "string", "example": "Joe" }, "surname": { "type": "string", "example": "Doe" }, "external_contact_id": { "type": "string", "example": "AA1234" }, "created_at": { "type": "string", "example": "2024-10-15T14:13:47.730Z" } } }, "price_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } }, "price_amount": { "type": "string", "example": "20.0" }, "receive_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "title": { "type": "string", "example": "Euro" }, "kind": { "type": "string", "example": "fiat" }, "symbol": { "type": "string", "example": "EUR" } } }, "receive_amount": { "type": "string", "example": "19.8" }, "pay_currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "pay_amount": { "type": "string", "example": "0.00022086" }, "fees": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "processing_fee" }, "amount": { "type": "string", "example": "0.2" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 2, "default": 0 }, "symbol": { "type": "string", "example": "EUR" } } } } } }, "billing_request_items": { "type": "array" }, "billing_request_url": { "type": "string", "example": "" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Billing request not found\",\n \"reason\": \"BillingRequestNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Billing request not found" }, "reason": { "type": "string", "example": "BillingRequestNotFound" } } } } } } }, "deprecated": false } }, "/mass_payouts": { "post": { "summary": "Create Mass Payout", "description": "", "operationId": "create-mass-payout", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "title", "currency_id", "ledger_account_id", "callback_url", "amount", "payouts" ], "properties": { "title": { "type": "string", "description": "Title of mass payout" }, "currency_id": { "type": "integer", "description": "Currency ID can be retrieved from https://api.coingate.com/api/v2/currencies", "format": "int32" }, "ledger_account_id": { "type": "string", "description": "Ledger account ID can be retrieved from https://api.coingate.com/api/v2/ledger/accounts" }, "callback_url": { "type": "string", "description": "We will send call back request about status change on your mass payout" }, "amount": { "type": "string", "description": "Amount of mass payout has to be sum of all mass payout entries amounts" }, "payouts": { "type": "array", "description": "Must contain at least one payout object", "items": { "properties": { "entry_type": { "type": "string", "description": "Entry type decides if first name surname and date of birth or company_name and company code fields will be required", "enum": [ "\"person\"", "\"business\"" ] }, "internal_id": { "type": "string", "description": "ID by which entry is recognised on merchant system" }, "address": { "type": "string", "description": "Crypto address" }, "amount": { "type": "number", "description": "Entry amount", "format": "double" }, "platform_id": { "type": "integer", "description": "Platform ID and it's supported currencies can be seen on https://api.coingate.com/api/v2/platforms. Platform must support mass payout currency", "format": "int32" }, "currency_id": { "type": "integer", "description": "Currency which should match ledger account currency as well as every mass payout entry currency. Currency ID's can be seen on https://developer.coingate.com/reference/currencies", "format": "int32" }, "country": { "type": "string", "description": "Three-letter country code" }, "purpose": { "type": "string", "description": "Payment purpose", "enum": [ "\"payroll\"", "\"commission\"", "\"withdrawal\"", "\"refund\"", "\"vendor_payment\"", "\"other\"" ] }, "first_name": { "type": "string", "description": "Required only if entry_type is \"person\"" }, "surname": { "type": "string", "description": "Required only if entry_type is \"person\"" }, "date_of_birth": { "type": "string", "description": "Required only if entry_type is \"person\"", "format": "date" }, "company_name": { "type": "string", "description": "Required only if entry_type is \"business\"" }, "company_code": { "type": "string", "description": "Required only if entry_type is \"business\"" } }, "required": [ "entry_type", "internal_id", "address", "amount", "platform_id", "currency_id", "country", "purpose" ], "type": "object" } } } }, "examples": { "Request Example": { "value": { "title": "Mass Payout #1", "currency_id": 1, "ledger_account_id": "01HBG17JWMSF3TAVSQCW3EYMTA", "callback_url": "https://my-callback-url.com/mass-payouts", "amount": "0.0002", "payouts": [ { "entry_type": "person", "internal_id": 11, "address": "mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa", "amount": "0.0001", "platform_id": 6, "currency_id": 1, "country": "DEU", "purpose": "payroll", "first_name": "Bob", "surname": "Bailey", "date_of_birth": "1983-08-14", "company_name": "ledai", "company_code": "LT-844741251151" }, { "entry_type": "business", "internal_id": 12, "address": "mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa", "amount": "0.0001", "platform_id": 6, "currency_id": 1, "country": "DEU", "purpose": "withdrawal", "company_name": "Gleichner Group", "company_code": "19-211-8140" } ] } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 71,\n \"status\": \"draft\",\n \"title\": \"Mass Payout #1\",\n \"amount\": \"0.0002\",\n \"confirmed_at\": null,\n \"created_at\": \"2023-10-02T11:57:24.691Z\",\n \"updated_at\": \"2023-10-02T11:57:24.691Z\",\n \"callback_url\": \"https://my-callback-url.com/mass-payouts\",\n \"ledger_account\": {\n \"id\": \"01HBG17JWMSF3TAVSQCW3EYMTA\",\n \"balance\": \"0.469332132\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\"\n }\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n },\n \"service_fee\": \"0.0000006\",\n \"total_amount\": \"0.0002006\",\n \"expires_at\": \"2023-10-03T11:57:24.691Z\",\n \"payouts\": [\n {\n \"id\": 1220,\n \"status\": \"draft\",\n \"compliance_status\": \"draft\",\n \"internal_id\": \"11\",\n \"address\": \"mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa\",\n \"amount\": \"0.0001\",\n \"created_at\": \"2023-10-02T11:57:24.721Z\",\n \"updated_at\": \"2023-10-02T11:57:24.721Z\",\n \"payout_type\": \"person\",\n \"first_name\": \"Bob\",\n \"surname\": \"Bailey\",\n \"date_of_birth\": \"1983-08-14\",\n \"txid\": null,\n \"country\": \"DEU\",\n \"purpose\": \"payroll\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n },\n {\n \"id\": 1221,\n \"status\": \"draft\",\n \"compliance_status\": \"draft\",\n \"internal_id\": \"12\",\n \"address\": \"mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa\",\n \"amount\": \"0.0001\",\n \"created_at\": \"2023-10-02T11:57:24.748Z\",\n \"updated_at\": \"2023-10-02T11:57:24.748Z\",\n \"payout_type\": \"business\",\n \"txid\": null,\n \"company_name\": \"Gleichner Group\",\n \"company_code\": \"19-211-8140\",\n \"country\": \"DEU\",\n \"purpose\": \"withdrawal\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 71, "default": 0 }, "status": { "type": "string", "example": "draft" }, "title": { "type": "string", "example": "Mass Payout #1" }, "amount": { "type": "string", "example": "0.0002" }, "confirmed_at": {}, "created_at": { "type": "string", "example": "2023-10-02T11:57:24.691Z" }, "updated_at": { "type": "string", "example": "2023-10-02T11:57:24.691Z" }, "callback_url": { "type": "string", "example": "https://my-callback-url.com/mass-payouts" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01HBG17JWMSF3TAVSQCW3EYMTA" }, "balance": { "type": "string", "example": "0.469332132" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "service_fee": { "type": "string", "example": "0.0000006" }, "total_amount": { "type": "string", "example": "0.0002006" }, "expires_at": { "type": "string", "example": "2023-10-03T11:57:24.691Z" }, "payouts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1220, "default": 0 }, "status": { "type": "string", "example": "draft" }, "compliance_status": { "type": "string", "example": "draft" }, "internal_id": { "type": "string", "example": "11" }, "address": { "type": "string", "example": "mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa" }, "amount": { "type": "string", "example": "0.0001" }, "created_at": { "type": "string", "example": "2023-10-02T11:57:24.721Z" }, "updated_at": { "type": "string", "example": "2023-10-02T11:57:24.721Z" }, "payout_type": { "type": "string", "example": "person" }, "first_name": { "type": "string", "example": "Bob" }, "surname": { "type": "string", "example": "Bailey" }, "date_of_birth": { "type": "string", "example": "1983-08-14" }, "txid": {}, "country": { "type": "string", "example": "DEU" }, "purpose": { "type": "string", "example": "payroll" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 6, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "id_name": { "type": "string", "example": "bitcoin" } } }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Mass Payout is not valid\",\n \"reason\": \"MassPayoutIsNotValid\",\n \"errors\": [\n \"Address is not valid for mass payout entry with internal_id 11 and with address mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspas\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Mass Payout is not valid" }, "reason": { "type": "string", "example": "MassPayoutIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Address is not valid for mass payout entry with internal_id 11 and with address mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspas" } } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl --location 'https://api.coingate.com/api/v2/mass_payouts' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer token' \\\n--data '{\n \"title\": \"Mass Payout #1\",\n \"currency_id\": 1,\n \"ledger_account_id\": \"01HBG17JWMSF3TAVSQCW3EYMTA\",\n \"callback_url\": \"https://my-callback-url.com/mass-payouts\",\n \"amount\": \"0.0002\",\n \"payouts\": [{\n \"entry_type\": \"person\",\n \"internal_id\": 11,\n \"address\" : \"mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa\",\n \"amount\" :\"0.0001\",\n \"platform_id\" : 6,\n \"currency_id\": 1,\n \"country\": \"DEU\",\n \"purpose\": \"payroll\",\n \"first_name\": \"Bob\",\n \"surname\" : \"Bailey\",\n \"date_of_birth\": \"1983-08-14\",\n \"company_name\": \"ledai\",\n \"company_code\": \"LT-844741251151\"\n },\n {\n \"entry_type\": \"business\",\n \"internal_id\": 12,\n \"address\" : \"mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa\",\n \"amount\" :\"0.0001\",\n \"platform_id\" : 6,\n \"currency_id\": 1,\n \"country\": \"DEU\",\n \"purpose\": \"withdrawal\",\n \"company_name\": \"Gleichner Group\",\n \"company_code\": \"19-211-8140\"\n }\n]\n}'" } ], "samples-languages": [ "curl" ] } }, "get": { "summary": "List Mass Payouts", "description": "Endpoint to list you mass payouts", "operationId": "list-mass-payouts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "per_page": { "type": "integer", "description": "Records per page you would like to see", "default": 100, "format": "int32" }, "page": { "type": "integer", "description": "Current page number", "default": 1, "format": "int32" }, "status": { "type": "string", "description": "Status of mass payout to filter", "enum": [ "\"draft\"", "\"pending\"", "\"confirmed\"", "\"in_progress\"", "\"done\"", "\"rejected\"", "\"expired\"" ] }, "created_at_from": { "type": "string", "description": "Filter mass payout to be created after date provided", "format": "date" }, "created_at_to": { "type": "string", "description": "Filter mass payout to be created before date provided", "format": "date" } } }, "examples": { "Request Example": { "value": { "per_page": 100, "page": 1, "status": "draft", "created_at_from": "2000-01-01", "created_at_to": "2025-01-01" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 1,\n \"per_page\": 100,\n \"total_records\": 25,\n \"total_pages\": 1,\n \"records\": [\n {\n \"id\": 71,\n \"status\": \"pending\",\n \"title\": \"Mass Payout #1\",\n \"amount\": \"0.0002\",\n \"confirmed_at\": null,\n \"created_at\": \"2023-10-02T11:57:24.691Z\",\n \"updated_at\": \"2023-10-02T12:01:12.925Z\",\n \"callback_url\": \"https://my-callback-url.com/mass-payouts\",\n \"ledger_account\": {\n \"id\": \"01HBG17JWMSF3TAVSQCW3EYMTA\",\n \"balance\": \"0.469332132\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\"\n }\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n },\n \"service_fee\": \"0.0000006\",\n \"total_amount\": \"0.0002006\",\n \"expires_at\": \"2023-10-03T11:57:24.691Z\"\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 100, "default": 0 }, "total_records": { "type": "integer", "example": 25, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 }, "records": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 71, "default": 0 }, "status": { "type": "string", "example": "pending" }, "title": { "type": "string", "example": "Mass Payout #1" }, "amount": { "type": "string", "example": "0.0002" }, "confirmed_at": {}, "created_at": { "type": "string", "example": "2023-10-02T11:57:24.691Z" }, "updated_at": { "type": "string", "example": "2023-10-02T12:01:12.925Z" }, "callback_url": { "type": "string", "example": "https://my-callback-url.com/mass-payouts" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01HBG17JWMSF3TAVSQCW3EYMTA" }, "balance": { "type": "string", "example": "0.469332132" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "service_fee": { "type": "string", "example": "0.0000006" }, "total_amount": { "type": "string", "example": "0.0002006" }, "expires_at": { "type": "string", "example": "2023-10-03T11:57:24.691Z" } } } } } } } } } }, "deprecated": false } }, "/mass_payouts/exchange": { "post": { "summary": "Create Mass Payout with quote currency", "description": "", "operationId": "create-mass-payout-exchange", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "title", "currency_id", "ledger_account_id", "callback_url", "amount", "payouts" ], "properties": { "title": { "type": "string", "description": "Title of mass payout" }, "currency_id": { "type": "integer", "description": "Currency ID can be retrieved from https://api.coingate.com/api/v2/currencies", "format": "int32" }, "ledger_account_id": { "type": "string", "description": "Ledger account ID can be retrieved from https://api.coingate.com/api/v2/ledger/accounts" }, "callback_url": { "type": "string", "description": "We will send call back request about status change on your mass payout" }, "amount": { "type": "string", "description": "Amount of mass payout has to be sum of all mass payout entries amounts" }, "payouts": { "type": "array", "description": "Must contain at least one payout object", "items": { "properties": { "entry_type": { "type": "string", "description": "Entry type decides if first name surname and date of birth or company_name and company code fields will be required", "enum": [ "\"person\"", "\"business\"" ] }, "internal_id": { "type": "string", "description": "ID by which entry is recognised on merchant system" }, "address": { "type": "string", "description": "Crypto address" }, "quote_amount": { "type": "number", "description": "Entry amount in quote currency", "format": "double" }, "currency_id": { "type": "integer", "description": "Payment currency ID", "format": "int32" }, "platform_id": { "type": "integer", "description": "Platform ID and it's supported currencies can be seen on https://api.coingate.com/api/v2/platforms. Platform must support mass payout currency", "format": "int32" }, "quote_currency_id": { "type": "integer", "description": "Quote currency which should match ledger account currency as well as every mass payout entry currency. Currency ID's can be seen on https://developer.coingate.com/reference/currencies", "format": "int32" }, "country": { "type": "string", "description": "Three-letter country code" }, "purpose": { "type": "string", "description": "Payment purpose", "enum": [ "\"payroll\"", "\"commission\"", "\"withdrawal\"", "\"refund\"", "\"vendor_payment\"", "\"other\"" ] }, "first_name": { "type": "string", "description": "Required only if entry_type is \"person\"" }, "surname": { "type": "string", "description": "Required only if entry_type is \"person\"" }, "date_of_birth": { "type": "string", "description": "Required only if entry_type is \"person\"", "format": "date" }, "company_name": { "type": "string", "description": "Required only if entry_type is \"business\"" }, "company_code": { "type": "string", "description": "Required only if entry_type is \"business\"" } }, "type": "object" } } } }, "examples": { "Request Example": { "value": { "title": "Mass Payout #1", "currency_id": 1, "ledger_account_id": "01HBG17JWMSF3TAVSQCW3EYMTA", "callback_url": "https://my-callback-url.com/mass-payouts", "amount": "0.0002", "payouts": [ { "entry_type": "person", "internal_id": 11, "address": "mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa", "quote_amount": "0.0001", "platform_id": 6, "currency_id": 1, "quote_currency_id": 2, "country": "DEU", "purpose": "payroll", "first_name": "Bob", "surname": "Bailey", "date_of_birth": "1983-08-14", "company_name": "ledai", "company_code": "LT-844741251151" }, { "entry_type": "business", "internal_id": 12, "address": "mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa", "quote_amount": "0.0001", "quote_currency_id": 2, "platform_id": 6, "currency_id": 1, "country": "DEU", "purpose": "withdrawal", "company_name": "Gleichner Group", "company_code": "19-211-8140" } ] } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 71,\n \"status\": \"draft\",\n \"title\": \"Mass Payout #1\",\n \"amount\": \"0.0002\",\n \"confirmed_at\": null,\n \"created_at\": \"2023-10-02T11:57:24.691Z\",\n \"updated_at\": \"2023-10-02T11:57:24.691Z\",\n \"callback_url\": \"https://my-callback-url.com/mass-payouts\",\n \"ledger_account\": {\n \"id\": \"01HBG17JWMSF3TAVSQCW3EYMTA\",\n \"balance\": \"0.469332132\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\"\n }\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n },\n \"service_fee\": \"0.0000006\",\n \"total_amount\": \"0.0002006\",\n \"expires_at\": \"2023-10-03T11:57:24.691Z\",\n \"payouts\": [\n {\n \"id\": 1220,\n \"status\": \"draft\",\n \"compliance_status\": \"draft\",\n \"internal_id\": \"11\",\n \"address\": \"mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa\",\n \"amount\": \"0.0001\",\n \"created_at\": \"2023-10-02T11:57:24.721Z\",\n \"updated_at\": \"2023-10-02T11:57:24.721Z\",\n \"payout_type\": \"person\",\n \"first_name\": \"Bob\",\n \"surname\": \"Bailey\",\n \"date_of_birth\": \"1983-08-14\",\n \"txid\": null,\n \"country\": \"DEU\",\n \t\"purpose\": \"payroll\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n },\n {\n \"id\": 1221,\n \"status\": \"draft\",\n \"compliance_status\": \"draft\",\n \"internal_id\": \"12\",\n \"address\": \"mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa\",\n \"amount\": \"0.0001\",\n \"created_at\": \"2023-10-02T11:57:24.748Z\",\n \"updated_at\": \"2023-10-02T11:57:24.748Z\",\n \"payout_type\": \"business\",\n \"txid\": null,\n \"company_name\": \"Gleichner Group\",\n \"company_code\": \"19-211-8140\",\n \"country\": \"DEU\",\n \t\"purpose\": \"withdrawal\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 71, "default": 0 }, "status": { "type": "string", "example": "draft" }, "title": { "type": "string", "example": "Mass Payout #1" }, "amount": { "type": "string", "example": "0.0002" }, "confirmed_at": {}, "created_at": { "type": "string", "example": "2023-10-02T11:57:24.691Z" }, "updated_at": { "type": "string", "example": "2023-10-02T11:57:24.691Z" }, "callback_url": { "type": "string", "example": "https://my-callback-url.com/mass-payouts" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01HBG17JWMSF3TAVSQCW3EYMTA" }, "balance": { "type": "string", "example": "0.469332132" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "service_fee": { "type": "string", "example": "0.0000006" }, "total_amount": { "type": "string", "example": "0.0002006" }, "expires_at": { "type": "string", "example": "2023-10-03T11:57:24.691Z" }, "payouts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1220, "default": 0 }, "status": { "type": "string", "example": "draft" }, "compliance_status": { "type": "string", "example": "draft" }, "internal_id": { "type": "string", "example": "11" }, "address": { "type": "string", "example": "mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa" }, "amount": { "type": "string", "example": "0.0001" }, "created_at": { "type": "string", "example": "2023-10-02T11:57:24.721Z" }, "updated_at": { "type": "string", "example": "2023-10-02T11:57:24.721Z" }, "payout_type": { "type": "string", "example": "person" }, "first_name": { "type": "string", "example": "Bob" }, "surname": { "type": "string", "example": "Bailey" }, "date_of_birth": { "type": "string", "example": "1983-08-14" }, "txid": {}, "country": { "type": "string", "example": "DEU" }, "purpose": { "type": "string", "example": "payroll" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 6, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "id_name": { "type": "string", "example": "bitcoin" } } }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Mass Payout is not valid\",\n \"reason\": \"MassPayoutIsNotValid\",\n \"errors\": [\n \"Address is not valid for mass payout entry with internal_id 11 and with address mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspas\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Mass Payout is not valid" }, "reason": { "type": "string", "example": "MassPayoutIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Address is not valid for mass payout entry with internal_id 11 and with address mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspas" } } } } } } } }, "deprecated": false } }, "/mass_payouts/{id}": { "get": { "summary": "Get Mass Payout", "description": "Get single mass payout by its ID", "operationId": "get-mass-payout", "parameters": [ { "name": "id", "in": "path", "description": "Mass payout ID", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 71,\n \"status\": \"pending\",\n \"title\": \"Mass Payout #1\",\n \"amount\": \"0.0002\",\n \"confirmed_at\": null,\n \"created_at\": \"2023-10-02T11:57:24.691Z\",\n \"updated_at\": \"2023-10-02T12:01:12.925Z\",\n \"callback_url\": \"https://my-callback-url.com/mass-payouts\",\n \"ledger_account\": {\n \"id\": \"01HBG17JWMSF3TAVSQCW3EYMTA\",\n \"balance\": \"0.469332132\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\"\n }\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n },\n \"service_fee\": \"0.0000006\",\n \"total_amount\": \"0.0002006\",\n \"expires_at\": \"2023-10-03T11:57:24.691Z\",\n \"payouts\": [\n {\n \"id\": 1220,\n \"status\": \"draft\",\n \"compliance_status\": \"draft\",\n \"internal_id\": \"11\",\n \"address\": \"mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa\",\n \"amount\": \"0.0001\",\n \"created_at\": \"2023-10-02T11:57:24.721Z\",\n \"updated_at\": \"2023-10-02T11:57:24.721Z\",\n \"payout_type\": \"person\",\n \"first_name\": \"Bob\",\n \"surname\": \"Bailey\",\n \"date_of_birth\": \"1983-08-14\",\n \"txid\": null,\n \"country\": \"DEU\",\n \t\"purpose\": \"payroll\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n },\n {\n \"id\": 1221,\n \"status\": \"draft\",\n \"compliance_status\": \"draft\",\n \"internal_id\": \"12\",\n \"address\": \"mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa\",\n \"amount\": \"0.0001\",\n \"created_at\": \"2023-10-02T11:57:24.748Z\",\n \"updated_at\": \"2023-10-02T11:57:24.748Z\",\n \"payout_type\": \"business\",\n \"txid\": null,\n \"company_name\": \"Gleichner Group\",\n \"company_code\": \"19-211-8140\",\n \"country\": \"DEU\",\n \"purpose\": \"withdrawal\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 71, "default": 0 }, "status": { "type": "string", "example": "pending" }, "title": { "type": "string", "example": "Mass Payout #1" }, "amount": { "type": "string", "example": "0.0002" }, "confirmed_at": {}, "created_at": { "type": "string", "example": "2023-10-02T11:57:24.691Z" }, "updated_at": { "type": "string", "example": "2023-10-02T12:01:12.925Z" }, "callback_url": { "type": "string", "example": "https://my-callback-url.com/mass-payouts" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01HBG17JWMSF3TAVSQCW3EYMTA" }, "balance": { "type": "string", "example": "0.469332132" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "service_fee": { "type": "string", "example": "0.0000006" }, "total_amount": { "type": "string", "example": "0.0002006" }, "expires_at": { "type": "string", "example": "2023-10-03T11:57:24.691Z" }, "payouts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1220, "default": 0 }, "status": { "type": "string", "example": "draft" }, "compliance_status": { "type": "string", "example": "draft" }, "internal_id": { "type": "string", "example": "11" }, "address": { "type": "string", "example": "mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa" }, "amount": { "type": "string", "example": "0.0001" }, "created_at": { "type": "string", "example": "2023-10-02T11:57:24.721Z" }, "updated_at": { "type": "string", "example": "2023-10-02T11:57:24.721Z" }, "payout_type": { "type": "string", "example": "person" }, "first_name": { "type": "string", "example": "Bob" }, "surname": { "type": "string", "example": "Bailey" }, "date_of_birth": { "type": "string", "example": "1983-08-14" }, "txid": {}, "country": { "type": "string", "example": "DEU" }, "purpose": { "type": "string", "example": "payroll" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 6, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "id_name": { "type": "string", "example": "bitcoin" } } }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Record not found\",\n \"reason\": \"RecordNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Record not found" }, "reason": { "type": "string", "example": "RecordNotFound" } } } } } } }, "deprecated": false } }, "/mass_payouts/{id}/confirm": { "patch": { "summary": "Confirm Mass Payout", "description": "", "operationId": "confirm-mass-payout", "parameters": [ { "name": "id", "in": "path", "description": "ID of mass payout", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 71,\n \"status\": \"in_progress\",\n \"title\": \"Mass Payout #1\",\n \"amount\": \"0.0002\",\n \"confirmed_at\": \"2023-10-02T12:08:12.000Z\",\n \"created_at\": \"2023-10-02T11:57:24.691Z\",\n \"updated_at\": \"2023-10-02T12:08:12.668Z\",\n \"callback_url\": \"https://my-callback-url.com/mass-payouts\",\n \"ledger_account\": {\n \"id\": \"01HBG17JWMSF3TAVSQCW3EYMTA\",\n \"balance\": \"0.469332132\",\n \"status\": \"active\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\"\n }\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n },\n \"service_fee\": \"0.0000006\",\n \"total_amount\": \"0.0002006\",\n \"expires_at\": null\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 71, "default": 0 }, "status": { "type": "string", "example": "in_progress" }, "title": { "type": "string", "example": "Mass Payout #1" }, "amount": { "type": "string", "example": "0.0002" }, "confirmed_at": { "type": "string", "example": "2023-10-02T12:08:12.000Z" }, "created_at": { "type": "string", "example": "2023-10-02T11:57:24.691Z" }, "updated_at": { "type": "string", "example": "2023-10-02T12:08:12.668Z" }, "callback_url": { "type": "string", "example": "https://my-callback-url.com/mass-payouts" }, "ledger_account": { "type": "object", "properties": { "id": { "type": "string", "example": "01HBG17JWMSF3TAVSQCW3EYMTA" }, "balance": { "type": "string", "example": "0.469332132" }, "status": { "type": "string", "example": "active" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" } } } } }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } }, "service_fee": { "type": "string", "example": "0.0000006" }, "total_amount": { "type": "string", "example": "0.0002006" }, "expires_at": {} } } } } }, "404": { "description": "404", "content": { "text/plain": { "examples": { "Result": { "value": "{\n \"message\": \"Record not found\",\n \"reason\": \"RecordNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Record not found" }, "reason": { "type": "string", "example": "RecordNotFound" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Confirming Mass Payout failed\",\n \"reason\": \"MassPayoutIsNotValid\",\n \"errors\": [\n \"Mass Payout is not in pending status to be confirmed.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Confirming Mass Payout failed" }, "reason": { "type": "string", "example": "MassPayoutIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Mass Payout is not in pending status to be confirmed." } } } } } } } }, "deprecated": false, "security": [] } }, "/mass_payouts/:id/entries": { "get": { "summary": "List Entries of Mass Payouts", "description": "List Entries of mass payout by mass payout id", "operationId": "get-mass-payout-entries", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "per_page": { "type": "integer", "description": "Number of record you would like to see per page", "default": 100, "format": "int32" }, "page": { "type": "integer", "description": "Current page", "default": 1, "format": "int32" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 1,\n \"per_page\": 100,\n \"total_records\": 2,\n \"total_pages\": 1,\n \"records\": [\n {\n \"id\": 1220,\n \"status\": \"draft\",\n \"compliance_status\": \"draft\",\n \"internal_id\": \"11\",\n \"address\": \"mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa\",\n \"amount\": \"0.0001\",\n \"created_at\": \"2023-10-02T11:57:24.721Z\",\n \"updated_at\": \"2023-10-02T11:57:24.721Z\",\n \"payout_type\": \"person\",\n \"first_name\": \"Bob\",\n \"surname\": \"Bailey\",\n \"date_of_birth\": \"1983-08-14\",\n \"txid\": null,\n \"country\": \"DEU\",\n \"purpose\": \"payroll\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n },\n {\n \"id\": 1221,\n \"status\": \"draft\",\n \"compliance_status\": \"draft\",\n \"internal_id\": \"12\",\n \"address\": \"mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa\",\n \"amount\": \"0.0001\",\n \"created_at\": \"2023-10-02T11:57:24.748Z\",\n \"updated_at\": \"2023-10-02T11:57:24.748Z\",\n \"payout_type\": \"business\",\n \"txid\": null,\n \"company_name\": \"Gleichner Group\",\n \"company_code\": \"19-211-8140\",\n \"country\": \"DEU\",\n \"purpose\": \"withdrawal\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 100, "default": 0 }, "total_records": { "type": "integer", "example": 2, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 }, "records": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1220, "default": 0 }, "status": { "type": "string", "example": "draft" }, "compliance_status": { "type": "string", "example": "draft" }, "internal_id": { "type": "string", "example": "11" }, "address": { "type": "string", "example": "mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa" }, "amount": { "type": "string", "example": "0.0001" }, "created_at": { "type": "string", "example": "2023-10-02T11:57:24.721Z" }, "updated_at": { "type": "string", "example": "2023-10-02T11:57:24.721Z" }, "payout_type": { "type": "string", "example": "person" }, "first_name": { "type": "string", "example": "Bob" }, "surname": { "type": "string", "example": "Bailey" }, "date_of_birth": { "type": "string", "example": "1983-08-14" }, "txid": {}, "country": { "type": "string", "example": "DEU" }, "purpose": { "type": "string", "example": "payroll" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 6, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "id_name": { "type": "string", "example": "bitcoin" } } }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Record not found\",\n \"reason\": \"RecordNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Record not found" }, "reason": { "type": "string", "example": "RecordNotFound" } } } } } } }, "deprecated": false, "security": [] } }, "/mass_payouts/{mass_payout_id}/entries/{entry_id}": { "get": { "summary": "Show Entry of Mass Payout", "description": "Get mass payout entry by mass payout and entry id", "operationId": "show-entry-of-mass-payout", "parameters": [ { "name": "mass_payout_id", "in": "path", "description": "ID of mass payout", "schema": { "type": "string" }, "required": true }, { "name": "entry_id", "in": "path", "description": "ID of mass payout entry", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 1220,\n \"status\": \"draft\",\n \"compliance_status\": \"draft\",\n \"internal_id\": \"11\",\n \"address\": \"mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa\",\n \"amount\": \"0.0001\",\n \"created_at\": \"2023-10-02T11:57:24.721Z\",\n \"updated_at\": \"2023-10-02T11:57:24.721Z\",\n \"payout_type\": \"person\",\n \"first_name\": \"Bob\",\n \"surname\": \"Bailey\",\n \"date_of_birth\": \"1983-08-14\",\n \"txid\": null,\n \"country\": \"DEU\",\n \"purpose\": \"payroll\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 1220, "default": 0 }, "status": { "type": "string", "example": "draft" }, "compliance_status": { "type": "string", "example": "draft" }, "internal_id": { "type": "string", "example": "11" }, "address": { "type": "string", "example": "mxMuzMBauEyoPDfib11jKq6Xy8DLQvfspa" }, "amount": { "type": "string", "example": "0.0001" }, "created_at": { "type": "string", "example": "2023-10-02T11:57:24.721Z" }, "updated_at": { "type": "string", "example": "2023-10-02T11:57:24.721Z" }, "payout_type": { "type": "string", "example": "person" }, "first_name": { "type": "string", "example": "Bob" }, "surname": { "type": "string", "example": "Bailey" }, "date_of_birth": { "type": "string", "example": "1983-08-14" }, "txid": {}, "country": { "type": "string", "example": "DEU" }, "purpose": { "type": "string", "example": "payroll" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 6, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "id_name": { "type": "string", "example": "bitcoin" } } }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Record not found\",\n \"reason\": \"RecordNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Record not found" }, "reason": { "type": "string", "example": "RecordNotFound" } } } } } } }, "deprecated": false, "security": [] } }, "/beneficiaries": { "post": { "summary": "Create Beneficiary", "description": "", "operationId": "create-beneficiary", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "beneficiary_type", "email", "country", "currency_id", "platform_id", "crypto_address" ], "properties": { "beneficiary_type": { "type": "string", "description": "Beneficiary type decides if first name surname email and date of birth or company_name and company code fields will be required", "enum": [ "\"person\"", "\"business\"" ] }, "person": { "type": "object", "description": "Required only if beneficiary_type is \"person\"", "required": [ "first_name", "surname" ], "properties": { "first_name": { "type": "string" }, "surname": { "type": "string" } } }, "business": { "type": "object", "description": "Required only if beneficiary_type is \"business\"", "required": [ "company_name", "company_code" ], "properties": { "company_name": { "type": "string", "description": "Company's legal name" }, "company_code": { "type": "string", "description": "Company or LEI code" } } }, "email": { "type": "string" }, "country": { "type": "string", "description": "Country alpha3 code" }, "country_state": { "type": "string", "description": "Required when the country includes states. Use the state's alpha-2 code." }, "currency_id": { "type": "integer", "description": "Retrieve the currency_id by making a request to the following API endpoint: https://developer.coingate.com/reference/currencies. The values for currency_id and platform_id differ between the live and sandbox environments. Make sure to retrieve these values according to your integration environment from either api.coingate.com for production or api-sandbox.coingate.com for sandbox testing.", "format": "int32" }, "platform_id": { "type": "integer", "description": "Retrieve the platform_id and supported currencies by making a request to the following API endpoint: https://developer.coingate.com/reference/platforms. The values for currency_id and platform_id differ between the live and sandbox environments. Make sure to retrieve these values according to your integration environment from either api.coingate.com for production or api-sandbox.coingate.com for sandbox testing.", "format": "int32" }, "crypto_address": { "type": "string", "description": "Crypto address" }, "crypto_address_metadata": { "type": "string", "description": "Required destination_tag for XRP, memo for BNB,XLM,SOLANA ex. 12345" }, "street_name": { "type": "string", "description": "Street name" }, "building_number": { "type": "string", "description": "Building number" }, "town_name": { "type": "string", "description": "Town name" }, "post_code": { "type": "string", "description": "Postcode" }, "date_of_birth": { "type": "string", "description": "(YYYY-MM-DD or MM/DD/YYYY) Date of birth" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 1,\n \"beneficiary_type\": \"person\",\n \"first_name\": \"Joes\",\n \"surname\": \"Doehs\",\n \"email\": \"joes@doehs.com\",\n \"country\": \"LAV\",\n \"country_state\": \"Riga\",\n \"street_name\": \"Brīvības iela\",\n \"building_number\": \"21\",\n \"town_name\": \"Riga\",\n \"post_code\": \"LV-1010\"\n \"created_at\": \"2024-01-01T00:00:00.691Z\",\n \"beneficiary_payout_settings\": [\n {\n \"id\": 1,\n \t\t\"crypto_address\": \"tb1q8twk9pftcyywlctnhf5xtgx037h4qwwrqt20hs\",\n \"crypto_address_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00.691Z\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n ]\n}" } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Beneficiary is not valid\",\n \"reason\": \"BeneficiaryIsNotValid\",\n \"errors\": {\n \"beneficiary_type\": [\n \"can't be blank\"\n ]\n }\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Beneficiary is not valid" }, "reason": { "type": "string", "example": "BeneficiaryIsNotValid" }, "errors": { "type": "object", "properties": { "beneficiary_type": { "type": "array", "items": { "type": "string", "example": "can't be blank" } } } } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "\ncurl -X \"POST\" \"https://api-sandbox.coingate.com/v2/beneficiaries\" \\\n -H 'Authorization: Token YOUR_API_TOKEN' \\\n -H 'Content-Type: application/x-www-form-urlencoded; charset=utf-8' \\\n --data-urlencode \"beneficiary_type=person\" \\\n --data-urlencode \"person[first_name]=Joe\" \\\n --data-urlencode \"person[surname]=Doe\" \\\n --data-urlencode \"email=test@example.com\" \\\n --data-urlencode \"country=LTU\" \\\n --data-urlencode \"currency_id=1\" \\\n --data-urlencode \"platform_id=6\" \\\n --data-urlencode \"crypto_address=tb1qz63xn75h604p4mdkemmje909ysnmjgxrj2xx2v\"\n" } ], "samples-languages": [ "curl" ] } }, "get": { "summary": "List Beneficiaries", "description": "", "operationId": "list-beneficiaries", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "per_page": { "type": "integer", "description": "Records per page", "default": 100, "format": "int32" }, "page": { "type": "integer", "description": "Current page number", "default": 1, "format": "int32" }, "beneficiary_id": { "type": "integer", "description": "Filter By Beneficiary ID", "format": "int32" }, "beneficiary_type": { "type": "string", "description": "Filter By Beneficiary type (person, business)" }, "email": { "type": "string", "description": "Filter By Email" }, "search_name": { "type": "string", "description": "Search by (first_name, surname, company_name) Fields" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"current_page\": 1,\n \"per_page\": 100,\n \"total_records\": 1,\n \"total_pages\": 1,\n \"beneficiaries\": [\n {\n \"id\": 1,\n \"beneficiary_type\": \"person\",\n \"first_name\": \"Joes\",\n \"surname\": \"Doehs\",\n \"email\": \"joes@doehs.com\",\n \"country\": \"LAV\",\n \"country_state\": \"Riga\",\n \"street_name\": \"Brīvības iela\",\n \"building_number\": \"21\",\n \"town_name\": \"Riga\",\n \"post_code\": \"LV-1010\"\n \"created_at\": \"2024-01-01T00:00:00.691Z\",\n \"beneficiary_payout_settings\": [\n {\n \"id\": 1,\n \"crypto_address\": \"tb1q8twk9pftcyywlctnhf5xtgx037h4qwwrqt20hs\",\n \t\t\"crypto_address_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00.691Z\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n ]\n }\n ]\n}" } } } } } }, "deprecated": false } }, "/beneficiaries/{id}": { "get": { "summary": "Get Beneficiary", "description": "", "operationId": "get-beneficiary", "parameters": [ { "name": "id", "in": "path", "description": "Beneficiary ID", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 1,\n \"beneficiary_type\": \"person\",\n \"first_name\": \"Joes\",\n \"surname\": \"Doehs\",\n \"email\": \"joes@doehs.com\",\n \"country\": \"LAV\",\n \"country_state\": \"Riga\",\n \"street_name\": \"Brīvības iela\",\n \"building_number\": \"21\",\n \"town_name\": \"Riga\",\n \"post_code\": \"LV-1010\"\n \"created_at\": \"2024-01-01T00:00:00.691Z\",\n \"beneficiary_payout_settings\": [\n {\n \"id\": 1,\n \t\t\"crypto_address\": \"tb1q8twk9pftcyywlctnhf5xtgx037h4qwwrqt20hs\",\n \"crypto_address_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00.691Z\",\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n }\n ]\n}" } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Beneficiary not found\",\n \"reason\": \"BeneficiaryNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Beneficiary not found" }, "reason": { "type": "string", "example": "BeneficiaryNotFound" } } } } } } }, "deprecated": false } }, "/beneficiary_payout_settings": { "post": { "summary": "Create Payout Setting", "description": "Add a New Payout Setting for a Specific Beneficiary", "operationId": "create-beneficiary-payout-setting", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "beneficiary_id", "currency_id", "platform_id", "crypto_address" ], "properties": { "beneficiary_id": { "type": "integer", "description": "Beneficiary ID: Obtain this value from a newly created beneficiary or retrieve an existing one using the following API endpoints: [Create Beneficiary](https://developer.coingate.com/reference/create-beneficiary) or [List Beneficiaries](https://developer.coingate.com/reference/list-beneficiaries)", "format": "int32" }, "currency_id": { "type": "integer", "description": "Retrieve the currency_id by making a request to the following API endpoint: https://developer.coingate.com/reference/currencies. The values for currency_id and platform_id differ between the live and sandbox environments. Make sure to retrieve these values according to your integration environment from either api.coingate.com for production or api-sandbox.coingate.com for sandbox testing.", "format": "int32" }, "platform_id": { "type": "integer", "description": "Retrieve the platform_id and supported currencies by making a request to the following API endpoint: https://developer.coingate.com/reference/platforms. The values for currency_id and platform_id differ between the live and sandbox environments. Make sure to retrieve these values according to your integration environment from either api.coingate.com for production or api-sandbox.coingate.com for sandbox testing.", "format": "int32" }, "crypto_address": { "type": "string", "description": "Crypto address" }, "crypto_address_metadata": { "type": "string", "description": "Required destination_tag for XRP, memo for BNB,XLM,SOLANA ex. 12345" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 29,\n \"created_at\": \"2025-02-26T15:11:55.317Z\",\n \"beneficiary_id\": 216,\n \"platform\": {\n \"id\": 6,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\"\n },\n \"crypto_address\": \"mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJRfn\",\n \"crypto_address_metadata\": null,\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"kind\": \"crypto\",\n \"symbol\": \"BTC\"\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 29, "default": 0 }, "created_at": { "type": "string", "example": "2025-02-26T15:11:55.317Z" }, "beneficiary_id": { "type": "integer", "example": 216, "default": 0 }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 6, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "id_name": { "type": "string", "example": "bitcoin" } } }, "crypto_address": { "type": "string", "example": "mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJRfn" }, "crypto_address_metadata": {}, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "kind": { "type": "string", "example": "crypto" }, "symbol": { "type": "string", "example": "BTC" } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n\t\"message\": \"Beneficiary Payout Setting is not valid\",\n\t\"reason\": \"BeneficiaryPayoutSettingIsNotValid\",\n\t\"errors\": [\n\t\t\"Beneficiary not found\"\n\t]\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Beneficiary Payout Setting is not valid" }, "reason": { "type": "string", "example": "BeneficiaryPayoutSettingIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Beneficiary not found" } } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "## Create Payout Setting\ncurl -X \"POST\" \"https://api-sandbox.coingate.com/v2/beneficiary_payout_settings\" \\\n -H 'Authorization: Token YOUR_API_TOKEN' \\\n -H 'Content-Type: application/x-www-form-urlencoded; charset=utf-8' \\\n --data-urlencode \"beneficiary_id=216\" \\\n --data-urlencode \"currency_id=1\" \\\n --data-urlencode \"platform_id=6\" \\\n --data-urlencode \"crypto_address=mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJRfn\"\n" } ], "samples-languages": [ "curl" ] } } }, "/rates/merchant/{from}/{to}": { "get": { "summary": "Get Exchange Rate", "description": "Current exchange rate for any two currencies, fiat or crypto. This endpoint is public, authentication is not required.", "operationId": "get-rate", "parameters": [ { "name": "from", "in": "path", "description": "ISO Symbol. Example: EUR, USD, BTC, ETH, [etc](https://coingate.com/currencies).", "schema": { "type": "string" }, "required": true }, { "name": "to", "in": "path", "description": "ISO Symbol. Example: EUR, USD, BTC, ETH, [etc](https://coingate.com/currencies).", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "text/plain": { "examples": { "Result": { "value": "7469.5" } }, "schema": { "type": "number", "example": 7469.5, "default": 0 } } } } }, "deprecated": false } }, "/rates": { "get": { "summary": "List Exchange Rates", "description": "Current CoinGate exchange rates for Merchants and Traders. This endpoint is public, authentication is not required.", "operationId": "list-rates", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"merchant\": {\n \"BTC\": {\n \"EUR\": \"7449.99\",\n \"USD\": \"9139.34\",\n \"ETH\": \"13.18044023\"\n },\n \"EUR\": {\n \"BTC\": \"0.00013351\",\n \"USD\": \"1.2317\",\n \"ETH\": \"0.00175954\"\n }\n },\n \"trader\": {\n \"buy\": {\n \"BTC\": {\n \"EUR\": \"7449.99\",\n \"USD\": \"9139.34\",\n \"ETH\": \"13.18044023\"\n },\n \"EUR\": {\n \"BTC\": \"0.00013351\",\n \"USD\": \"1.2317\",\n \"ETH\": \"0.00175954\"\n }\n },\n \"sell\": {\n \"BTC\": {\n \"EUR\": \"7449.99\",\n \"USD\": \"9139.34\",\n \"ETH\": \"13.18044023\"\n },\n \"EUR\": {\n \"BTC\": \"0.00013351\",\n \"USD\": \"1.2317\",\n \"ETH\": \"0.00175954\"\n }\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "merchant": { "type": "object", "properties": { "BTC": { "type": "object", "properties": { "EUR": { "type": "string", "example": "7449.99" }, "USD": { "type": "string", "example": "9139.34" }, "ETH": { "type": "string", "example": "13.18044023" } } }, "EUR": { "type": "object", "properties": { "BTC": { "type": "string", "example": "0.00013351" }, "USD": { "type": "string", "example": "1.2317" }, "ETH": { "type": "string", "example": "0.00175954" } } } } }, "trader": { "type": "object", "properties": { "buy": { "type": "object", "properties": { "BTC": { "type": "object", "properties": { "EUR": { "type": "string", "example": "7449.99" }, "USD": { "type": "string", "example": "9139.34" }, "ETH": { "type": "string", "example": "13.18044023" } } }, "EUR": { "type": "object", "properties": { "BTC": { "type": "string", "example": "0.00013351" }, "USD": { "type": "string", "example": "1.2317" }, "ETH": { "type": "string", "example": "0.00175954" } } } } }, "sell": { "type": "object", "properties": { "BTC": { "type": "object", "properties": { "EUR": { "type": "string", "example": "7449.99" }, "USD": { "type": "string", "example": "9139.34" }, "ETH": { "type": "string", "example": "13.18044023" } } }, "EUR": { "type": "object", "properties": { "BTC": { "type": "string", "example": "0.00013351" }, "USD": { "type": "string", "example": "1.2317" }, "ETH": { "type": "string", "example": "0.00175954" } } } } } } } } } } } } }, "deprecated": false } }, "/ping": { "get": { "summary": "Ping", "description": "A health check endpoint for CoinGate API. This endpoint is public, authentication is not required.", "operationId": "ping", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n ping: \"pong\",\n time: \"2017-12-13T19:07:18+00:00\"\n}" } } } } } }, "deprecated": false } }, "/currencies": { "get": { "summary": "Get Currencies", "description": "Retrieves all currencies.", "operationId": "currencies", "parameters": [ { "name": "native", "in": "query", "schema": { "type": "boolean" } }, { "name": "enabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "merchant_pay", "in": "query", "schema": { "type": "boolean" } }, { "name": "merchant_receive", "in": "query", "schema": { "type": "boolean" } }, { "name": "kind", "in": "query", "description": "Accepted values: crypto, fiat", "schema": { "type": "string" } }, { "name": "symbol", "in": "query", "description": "Search by currency symbol, for example: BTC", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n id: 1,\n title: 'Bitcoin',\n kind: 'crypto',\n symbol: 'BTC',\n native: true,\n disabled: false,\n disabled_message: null,\n merchant: {\n price: true,\n pay: true,\n receive: true,\n },\n platforms: [\n {\n id: 8,\n id_name: 'bitcoin',\n title: 'Bitcoin',\n enabled: true,\n },\n ],\n },\n {\n id: 2,\n title: 'Euro',\n kind: 'fiat',\n symbol: 'EUR',\n native: true,\n disabled: false,\n disabled_message: null,\n merchant: {\n price: true,\n pay: false,\n receive: true,\n },\n },\n {\n id: 3,\n title: 'United States dollar',\n kind: 'fiat',\n symbol: 'USD',\n native: true,\n disabled: false,\n disabled_message: null,\n merchant: {\n price: true,\n pay: false,\n receive: true,\n },\n },\n {\n id: 4,\n title: 'British Pound',\n kind: 'fiat',\n symbol: 'GBP',\n native: true,\n disabled: false,\n disabled_message: null,\n merchant: {\n price: true,\n pay: false,\n receive: true,\n },\n },\n {\n id: 5,\n title: 'Ethereum',\n kind: 'crypto',\n symbol: 'ETH',\n native: true,\n disabled: false,\n disabled_message: null,\n merchant: {\n price: true,\n pay: true,\n receive: true,\n },\n platforms: [\n {\n id: 2,\n id_name: 'binance_chain',\n title: 'Binance Chain (BEP2)',\n enabled: true,\n },\n {\n id: 7,\n id_name: 'ethereum',\n title: 'Ethereum',\n enabled: true,\n },\n ],\n },\n]" } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl https://api.coingate.com/v2/currencies\n\n# Enabled + Native + Crypto\ncurl https://api.coingate.com/v2/currencies?native=true&enabled=true&kind=crypto\n\n# Merchant Pay\ncurl https://api.coingate.com/v2/currencies?merchant_pay=true" } ], "samples-languages": [ "curl" ] } } }, "/platforms": { "get": { "summary": "Platforms", "description": "", "operationId": "platforms", "parameters": [ { "name": "enabled", "in": "query", "description": "List only enabled platforms", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"id\": 1,\n \"title\": \"Ethereum\",\n \"id_name\": \"ethereum\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 50,\n \"title\": \"Ethereum\",\n \"symbol\": \"ETH\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.00198888\"\n }\n },\n {\n \"id\": 61,\n \"title\": \"Dai\",\n \"symbol\": \"DAI\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"5.9857\"\n }\n },\n {\n \"id\": 63,\n \"title\": \"Augur\",\n \"symbol\": \"REP\",\n \"enabled\": false\n },\n {\n \"id\": 68,\n \"title\": \"iEx.ec\",\n \"symbol\": \"RLC\",\n \"enabled\": true\n },\n {\n \"id\": 71,\n \"title\": \"Basic Attention Token\",\n \"symbol\": \"BAT\",\n \"enabled\": true\n },\n {\n \"id\": 72,\n \"title\": \"Aragon\",\n \"symbol\": \"ANT\",\n \"enabled\": true\n },\n {\n \"id\": 73,\n \"title\": \"Bancor Network Token\",\n \"symbol\": \"BNT\",\n \"enabled\": true\n },\n {\n \"id\": 74,\n \"title\": \"Civic\",\n \"symbol\": \"CVC\",\n \"enabled\": false\n },\n {\n \"id\": 77,\n \"title\": \"OMG Network\",\n \"symbol\": \"OMG\",\n \"enabled\": true\n },\n {\n \"id\": 79,\n \"title\": \"0x Protocol Token\",\n \"symbol\": \"ZRX\",\n \"enabled\": true\n },\n {\n \"id\": 81,\n \"title\": \"Storj\",\n \"symbol\": \"STORJ\",\n \"enabled\": true\n },\n {\n \"id\": 86,\n \"title\": \"district0x\",\n \"symbol\": \"DNT\",\n \"enabled\": false\n },\n {\n \"id\": 87,\n \"title\": \"Power Ledger\",\n \"symbol\": \"POWR\",\n \"enabled\": true\n },\n {\n \"id\": 91,\n \"title\": \"Binance Coin\",\n \"symbol\": \"BNB\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.002269\"\n }\n },\n {\n \"id\": 92,\n \"title\": \"Polymath\",\n \"symbol\": \"POLY\",\n \"enabled\": false\n },\n {\n \"id\": 93,\n \"title\": \"Kyber Network\",\n \"symbol\": \"KNC\",\n \"enabled\": true\n },\n {\n \"id\": 94,\n \"title\": \"TrueUSD\",\n \"symbol\": \"TUSD\",\n \"enabled\": true\n },\n {\n \"id\": 96,\n \"title\": \"Chainlink\",\n \"symbol\": \"LINK\",\n \"enabled\": true\n },\n {\n \"id\": 97,\n \"title\": \"Tether\",\n \"symbol\": \"USDT\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"5.9868\"\n }\n },\n {\n \"id\": 103,\n \"title\": \"Mysterium\",\n \"symbol\": \"MYST\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"2.9641\"\n }\n },\n {\n \"id\": 104,\n \"title\": \"carVertical\",\n \"symbol\": \"CV\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"2500.0\"\n }\n },\n {\n \"id\": 113,\n \"title\": \"USDC\",\n \"symbol\": \"USDC\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"5.989\"\n }\n },\n {\n \"id\": 115,\n \"title\": \"Uniswap\",\n \"symbol\": \"UNI\",\n \"enabled\": true\n },\n {\n \"id\": 116,\n \"title\": \"Binance USD\",\n \"symbol\": \"BUSD\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"5.9873\"\n }\n },\n {\n \"id\": 118,\n \"title\": \"Wrapped Bitcoin\",\n \"symbol\": \"WBTC\",\n \"enabled\": true\n },\n {\n \"id\": 125,\n \"title\": \"SushiSwap\",\n \"symbol\": \"SUSHI\",\n \"enabled\": true\n },\n {\n \"id\": 127,\n \"title\": \"Aave\",\n \"symbol\": \"AAVE\",\n \"enabled\": true\n },\n {\n \"id\": 131,\n \"title\": \"Enjin Coin\",\n \"symbol\": \"ENJ\",\n \"enabled\": true\n },\n {\n \"id\": 132,\n \"title\": \"Filecoin\",\n \"symbol\": \"FIL\",\n \"enabled\": true\n },\n {\n \"id\": 133,\n \"title\": \"FTX Token\",\n \"symbol\": \"FTT\",\n \"enabled\": false\n },\n {\n \"id\": 135,\n \"title\": \"Golem\",\n \"symbol\": \"GLM\",\n \"enabled\": true\n },\n {\n \"id\": 136,\n \"title\": \"The Graph\",\n \"symbol\": \"GRT\",\n \"enabled\": true\n },\n {\n \"id\": 137,\n \"title\": \"Loopring\",\n \"symbol\": \"LRC\",\n \"enabled\": true\n },\n {\n \"id\": 139,\n \"title\": \"Decentraland\",\n \"symbol\": \"MANA\",\n \"enabled\": true\n },\n {\n \"id\": 140,\n \"title\": \"Maker\",\n \"symbol\": \"MKR\",\n \"enabled\": true\n },\n {\n \"id\": 142,\n \"title\": \"Nexo\",\n \"symbol\": \"NEXO\",\n \"enabled\": true\n },\n {\n \"id\": 145,\n \"title\": \"PAX Gold\",\n \"symbol\": \"PAXG\",\n \"enabled\": true\n },\n {\n \"id\": 148,\n \"title\": \"Viberate\",\n \"symbol\": \"VIB\",\n \"enabled\": true\n },\n {\n \"id\": 149,\n \"title\": \"Waves\",\n \"symbol\": \"WAVES\",\n \"enabled\": true\n },\n {\n \"id\": 152,\n \"title\": \"yearn.finance\",\n \"symbol\": \"YFI\",\n \"enabled\": true\n },\n {\n \"id\": 153,\n \"title\": \"Chiliz\",\n \"symbol\": \"CHZ\",\n \"enabled\": true\n },\n {\n \"id\": 157,\n \"title\": \"Quant\",\n \"symbol\": \"QNT\",\n \"enabled\": true\n },\n {\n \"id\": 158,\n \"title\": \"Fantom\",\n \"symbol\": \"FTM\",\n \"enabled\": true\n },\n {\n \"id\": 159,\n \"title\": \"Holo\",\n \"symbol\": \"HOT\",\n \"enabled\": true\n },\n {\n \"id\": 160,\n \"title\": \"Huobi Token\",\n \"symbol\": \"HT\",\n \"enabled\": true\n },\n {\n \"id\": 163,\n \"title\": \"Compound\",\n \"symbol\": \"COMP\",\n \"enabled\": true\n },\n {\n \"id\": 164,\n \"title\": \"Ren\",\n \"symbol\": \"REN\",\n \"enabled\": true\n },\n {\n \"id\": 165,\n \"title\": \"SHIBA INU\",\n \"symbol\": \"SHIB\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"786841.0\"\n }\n },\n {\n \"id\": 169,\n \"title\": \"Axie Infinity\",\n \"symbol\": \"AXS\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.0883\"\n }\n },\n {\n \"id\": 171,\n \"title\": \"The Sandbox\",\n \"symbol\": \"SAND\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"1.2475\"\n }\n },\n {\n \"id\": 176,\n \"title\": \"Tether EURt\",\n \"symbol\": \"EURT\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.4997\"\n }\n }\n ]\n },\n {\n \"id\": 2,\n \"title\": \"Binance Chain\",\n \"id_name\": \"binance_chain\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 50,\n \"title\": \"Ethereum\",\n \"symbol\": \"ETH\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.00028413\"\n }\n },\n {\n \"id\": 91,\n \"title\": \"Binance Coin\",\n \"symbol\": \"BNB\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.002269\"\n }\n },\n {\n \"id\": 97,\n \"title\": \"Tether\",\n \"symbol\": \"USDT\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.5443\"\n }\n },\n {\n \"id\": 102,\n \"title\": \"Travala.com (AVA)\",\n \"symbol\": \"AVA\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"1.1271\"\n }\n },\n {\n \"id\": 116,\n \"title\": \"Binance USD\",\n \"symbol\": \"BUSD\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.5443\"\n }\n }\n ]\n },\n {\n \"id\": 3,\n \"title\": \"Binance Smart Chain\",\n \"id_name\": \"binance_smart_chain\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 61,\n \"title\": \"Dai\",\n \"symbol\": \"DAI\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.5442\"\n }\n },\n {\n \"id\": 91,\n \"title\": \"Binance Coin\",\n \"symbol\": \"BNB\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.002269\"\n }\n },\n {\n \"id\": 97,\n \"title\": \"Tether\",\n \"symbol\": \"USDT\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.5443\"\n }\n },\n {\n \"id\": 113,\n \"title\": \"USDC\",\n \"symbol\": \"USDC\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.5445\"\n }\n },\n {\n \"id\": 116,\n \"title\": \"Binance USD\",\n \"symbol\": \"BUSD\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.5443\"\n }\n }\n ]\n },\n {\n \"id\": 4,\n \"title\": \"Tron\",\n \"id_name\": \"tron\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 60,\n \"title\": \"TRON\",\n \"symbol\": \"TRX\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"21.12\"\n }\n },\n {\n \"id\": 97,\n \"title\": \"Tether\",\n \"symbol\": \"USDT\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"1.6328\"\n }\n },\n {\n \"id\": 113,\n \"title\": \"USDC\",\n \"symbol\": \"USDC\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.5445\"\n }\n },\n {\n \"id\": 175,\n \"title\": \"BitTorrent\",\n \"symbol\": \"BTTC\",\n \"enabled\": false,\n \"void\": {\n \"min_refundable_amount\": \"1086957.0\"\n }\n }\n ]\n },\n {\n \"id\": 5,\n \"title\": \"Bitcoin\",\n \"id_name\": \"bitcoin\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 8,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.00001779\"\n }\n }\n ]\n },\n {\n \"id\": 6,\n \"title\": \"Litecoin\",\n \"id_name\": \"litecoin\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 49,\n \"title\": \"Litecoin\",\n \"symbol\": \"LTC\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.005159\"\n }\n }\n ]\n },\n {\n \"id\": 7,\n \"title\": \"Dogecoin\",\n \"id_name\": \"dogecoin\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 64,\n \"title\": \"Dogecoin\",\n \"symbol\": \"DOGE\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"8.06\"\n }\n }\n ]\n },\n {\n \"id\": 8,\n \"title\": \"Bitcoin Cash\",\n \"id_name\": \"bitcoin_cash\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 52,\n \"title\": \"Bitcoin Cash\",\n \"symbol\": \"BCH\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.001989\"\n }\n }\n ]\n },\n {\n \"id\": 9,\n \"title\": \"XRP\",\n \"id_name\": \"ripple\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 53,\n \"title\": \"XRP\",\n \"symbol\": \"XRP\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"1.1231\"\n }\n }\n ]\n },\n {\n \"id\": 11,\n \"title\": \"Cardano\",\n \"id_name\": \"cardano\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 114,\n \"title\": \"Cardano\",\n \"symbol\": \"ADA\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"1.8783\"\n }\n }\n ]\n },\n {\n \"id\": 12,\n \"title\": \"Nano\",\n \"id_name\": \"nano\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 59,\n \"title\": \"Nano\",\n \"symbol\": \"XNO\",\n \"enabled\": false\n }\n ]\n },\n {\n \"id\": 13,\n \"title\": \"Bitcoin SV\",\n \"id_name\": \"bitcoin_sv\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 98,\n \"title\": \"Bitcoin SV\",\n \"symbol\": \"BSV\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 14,\n \"title\": \"Stellar\",\n \"id_name\": \"stellar\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 70,\n \"title\": \"Stellar\",\n \"symbol\": \"XLM\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 15,\n \"title\": \"Dash\",\n \"id_name\": \"dash\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": []\n },\n {\n \"id\": 16,\n \"title\": \"Zcash\",\n \"id_name\": \"zcash\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": []\n },\n {\n \"id\": 17,\n \"title\": \"Ethereum Classic\",\n \"id_name\": \"ethereum_classic\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 62,\n \"title\": \"Ethereum Classic\",\n \"symbol\": \"ETC\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 18,\n \"title\": \"VeChain\",\n \"id_name\": \"vechain\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 105,\n \"title\": \"VeChain\",\n \"symbol\": \"VET\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 19,\n \"title\": \"Polkadot\",\n \"id_name\": \"polkadot\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": []\n },\n {\n \"id\": 20,\n \"title\": \"Solana\",\n \"id_name\": \"solana\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 117,\n \"title\": \"Solana\",\n \"symbol\": \"SOL\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 21,\n \"title\": \"Terra\",\n \"id_name\": \"terra\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": []\n },\n {\n \"id\": 22,\n \"title\": \"Theta\",\n \"id_name\": \"theta\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": []\n },\n {\n \"id\": 23,\n \"title\": \"Internet Computer\",\n \"id_name\": \"internet_computer\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": []\n },\n {\n \"id\": 24,\n \"title\": \"Algorand\",\n \"id_name\": \"algorand\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 128,\n \"title\": \"Algorand\",\n \"symbol\": \"ALGO\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 25,\n \"title\": \"Avalanche\",\n \"id_name\": \"avalanche\",\n \"disabled\": true,\n \"disabled_message\": \"Coming Soon\",\n \"currencies\": [\n {\n \"id\": 167,\n \"title\": \"Avalanche\",\n \"symbol\": \"AVAX\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.042301\"\n }\n }\n ]\n },\n {\n \"id\": 26,\n \"title\": \"Kusama\",\n \"id_name\": \"kusama\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": []\n },\n {\n \"id\": 27,\n \"title\": \"Decred\",\n \"id_name\": \"decred\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 69,\n \"title\": \"Decred\",\n \"symbol\": \"DCR\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 28,\n \"title\": \"Qtum Ignition\",\n \"id_name\": \"qtum_ignition\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 80,\n \"title\": \"Qtum Ignition\",\n \"symbol\": \"QTUM\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 29,\n \"title\": \"Bitcoin Gold\",\n \"id_name\": \"bitcoin_gold\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 84,\n \"title\": \"Bitcoin Gold\",\n \"symbol\": \"BTG\",\n \"enabled\": false\n }\n ]\n },\n {\n \"id\": 30,\n \"title\": \"DigiByte\",\n \"id_name\": \"digibyte\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 85,\n \"title\": \"DigiByte\",\n \"symbol\": \"DGB\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 31,\n \"title\": \"Tezos\",\n \"id_name\": \"tezos\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 123,\n \"title\": \"Tezos\",\n \"symbol\": \"XTZ\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 32,\n \"title\": \"Ravencoin\",\n \"id_name\": \"ravencoin\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 124,\n \"title\": \"Ravencoin\",\n \"symbol\": \"RVN\",\n \"enabled\": false\n }\n ]\n },\n {\n \"id\": 33,\n \"title\": \"Ardor\",\n \"id_name\": \"ardor\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 129,\n \"title\": \"Ardor\",\n \"symbol\": \"ARDR\",\n \"enabled\": false\n }\n ]\n },\n {\n \"id\": 34,\n \"title\": \"Ontology\",\n \"id_name\": \"ontology\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 144,\n \"title\": \"Ontology\",\n \"symbol\": \"ONT\",\n \"enabled\": false\n }\n ]\n },\n {\n \"id\": 35,\n \"title\": \"NEM\",\n \"id_name\": \"nem\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 151,\n \"title\": \"NEM\",\n \"symbol\": \"XEM\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 36,\n \"title\": \"Hedera Hashgraph\",\n \"id_name\": \"hedera_hashgraph\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 154,\n \"title\": \"Hedera Hashgraph\",\n \"symbol\": \"HBAR\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 37,\n \"title\": \"ICON\",\n \"id_name\": \"icon\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 155,\n \"title\": \"ICON\",\n \"symbol\": \"ICX\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 38,\n \"title\": \"Zilliqa\",\n \"id_name\": \"zilliqa\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 161,\n \"title\": \"Zilliqa\",\n \"symbol\": \"ZIL\",\n \"enabled\": false\n }\n ]\n },\n {\n \"id\": 39,\n \"title\": \"Polygon\",\n \"id_name\": \"polygon\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 61,\n \"title\": \"Dai\",\n \"symbol\": \"DAI\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.5442\"\n }\n },\n {\n \"id\": 91,\n \"title\": \"Binance Coin\",\n \"symbol\": \"BNB\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.002269\"\n }\n },\n {\n \"id\": 97,\n \"title\": \"Tether\",\n \"symbol\": \"USDT\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.5443\"\n }\n },\n {\n \"id\": 112,\n \"title\": \"Polygon\",\n \"symbol\": \"MATIC\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.7866\"\n }\n },\n {\n \"id\": 113,\n \"title\": \"USDC\",\n \"symbol\": \"USDC\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.5445\"\n }\n },\n {\n \"id\": 116,\n \"title\": \"Binance USD\",\n \"symbol\": \"BUSD\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.5443\"\n }\n },\n {\n \"id\": 118,\n \"title\": \"Wrapped Bitcoin\",\n \"symbol\": \"WBTC\",\n \"enabled\": true\n }\n ]\n },\n {\n \"id\": 40,\n \"title\": \"Arbitrum\",\n \"id_name\": \"arbitrum\",\n \"disabled\": false,\n \"disabled_message\": null,\n \"currencies\": [\n {\n \"id\": 50,\n \"title\": \"Ethereum\",\n \"symbol\": \"ETH\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.00028413\"\n }\n },\n {\n \"id\": 97,\n \"title\": \"Tether\",\n \"symbol\": \"USDT\",\n \"enabled\": true,\n \"void\": {\n \"min_refundable_amount\": \"0.5443\"\n }\n }\n ]\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "id_name": { "type": "string", "example": "ethereum" }, "disabled": { "type": "boolean", "example": false, "default": true }, "disabled_message": {}, "currencies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 50, "default": 0 }, "title": { "type": "string", "example": "Ethereum" }, "symbol": { "type": "string", "example": "ETH" }, "enabled": { "type": "boolean", "example": true, "default": true }, "void": { "type": "object", "properties": { "min_refundable_amount": { "type": "string", "example": "0.00198888" } } } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "shell", "code": "curl https://api.coingate.com/v2/platforms\n\ncurl https://api.coingate.com/v2/platforms?enabled=true" } ], "samples-languages": [ "shell" ] } } }, "/invoice/{uuid}/request-void": { "post": { "summary": "Create Void Request", "description": "", "operationId": "void-request", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice UUID", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "address", "crypto_platform_id" ], "properties": { "address": { "type": "string", "description": "Crypto wallet address" }, "additional_field": { "type": "string", "description": "Crypto addres memo or destination tag" }, "crypto_platform_id": { "type": "integer", "description": "[Crypto Platform](https://developer.coingate.com/reference/platforms)", "format": "int32" }, "email": { "type": "string", "description": "Shopper's email" }, "comment": { "type": "string" }, "accept_payment": { "type": "boolean", "description": "If payment was paid in full, you can mark the ‘Accept Payment’ checkbox on the refund form and we will make every attempt to process this payment, however, it may not be possible and a refund may be required." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 9,\n \"status\": \"pending\",\n \"address\": \"36c3KtqTpnhCRXp5179HR6hpKxP2XDahKF\",\n \"comment\": null,\n \"additional_field\": null,\n \"accept_payment\": false,\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\",\n \"platform\": {\n \"id\": 5,\n \"title\": \"Bitcoin\"\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 9, "default": 0 }, "status": { "type": "string", "example": "pending" }, "address": { "type": "string", "example": "36c3KtqTpnhCRXp5179HR6hpKxP2XDahKF" }, "comment": {}, "additional_field": {}, "accept_payment": { "type": "boolean", "example": false, "default": true }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" } } } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"errors\": {\n \"fields\": {\n \"crypto_platform_id\": [\n \"not found or does not belong to this currency\"\n ],\n \"base\": [\n \"Refund is not eligible for this order\"\n ]\n },\n \"full_messages\": [\n \"Crypto platform not found or does not belong to this currency\",\n \"Refund is not eligible for this order\"\n ]\n }\n}" } }, "schema": { "type": "object", "properties": { "errors": { "type": "object", "properties": { "fields": { "type": "object", "properties": { "crypto_platform_id": { "type": "array", "items": { "type": "string", "example": "not found or does not belong to this currency" } }, "base": { "type": "array", "items": { "type": "string", "example": "Refund is not eligible for this order" } } } }, "full_messages": { "type": "array", "items": { "type": "string", "example": "Crypto platform not found or does not belong to this currency" } } } } } } } } } }, "deprecated": false, "security": [] }, "get": { "summary": "Get Void Request", "description": "Retrieves a void request for a specific order. This endpoint is public, authentication is not required.", "operationId": "get-void-request", "parameters": [ { "name": "uuid", "in": "path", "description": "Invoice UUID", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 9,\n \"status\": \"pending\",\n \"address\": \"36c3KtqTpnhCRXp5179HR6hpKxP2XDahKF\",\n \"comment\": null,\n \"additional_field\": null,\n \"accept_payment\": false,\n \"created_at\": \"2022-12-06T10:58:21+00:00\",\n \"currency\": {\n \"id\": 1,\n \"title\": \"Bitcoin\",\n \"symbol\": \"BTC\",\n \"platform\": {\n \"id\": 5,\n \"title\": \"Bitcoin\"\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 9, "default": 0 }, "status": { "type": "string", "example": "pending" }, "address": { "type": "string", "example": "36c3KtqTpnhCRXp5179HR6hpKxP2XDahKF" }, "comment": {}, "additional_field": {}, "accept_payment": { "type": "boolean", "example": false, "default": true }, "created_at": { "type": "string", "example": "2022-12-06T10:58:21+00:00" }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" }, "symbol": { "type": "string", "example": "BTC" }, "platform": { "type": "object", "properties": { "id": { "type": "integer", "example": 5, "default": 0 }, "title": { "type": "string", "example": "Bitcoin" } } } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n\t\"message\": \"Void Request not found\",\n\t\"reason\": \"VoidRequestNotFound\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Void Request not found" }, "reason": { "type": "string", "example": "VoidRequestNotFound" } } } } } } }, "deprecated": false, "security": [] } }, "/invoice/{uuid}": { "get": { "summary": "Invoice", "description": "", "operationId": "invoice", "parameters": [ { "name": "uuid", "in": "path", "description": "Order UUID", "schema": { "type": "string" }, "required": true }, { "name": "cg_org", "in": "query", "description": "cg_org[format_address]=inline. Possible values: inline, newline, array", "schema": { "properties": {}, "type": "object" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"uuid\": \"c0ac16b0-528e-4615-9cc0-d6b09706dc05\",\n \"cg_org\": {\n \"title\": \"UAB Decentralized\",\n \"id_name\": \"coingate_uab\",\n \"address\": \"Registration code: 303423510\\nVAT code: LT100014216412\\nGoštauto g. 8, LT-01108\\nVilnius, Lithuania\"\n }\n}" } }, "schema": { "type": "object", "properties": { "uuid": { "type": "string", "example": "c0ac16b0-528e-4615-9cc0-d6b09706dc05" }, "cg_org": { "type": "object", "properties": { "title": { "type": "string", "example": "UAB Decentralized" }, "id_name": { "type": "string", "example": "coingate_uab" }, "address": { "type": "string", "example": "Registration code: 303423510\nVAT code: LT100014216412\nGoštauto g. 8, LT-01108\nVilnius, Lithuania" } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\"message\":\"Record not found\",\"reason\":\"RecordNotFound\"}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Record not found" }, "reason": { "type": "string", "example": "RecordNotFound" } } } } } } }, "deprecated": false, "security": [] } }, "/new-endpoint": { "post": { "description": "", "operationId": "post_new-endpoint", "responses": { "200": { "description": "" } }, "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "test": { "type": "string", "description": "test" } }, "type": "object" } } } } } }, "/orders/{order_id}/refunds/{id}/mark_as_rejected": { "patch": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "id": 1427, "request_amount": "10.0", "refund_amount": "0.0002733", "address": "mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJRfn", "status": "rejected", "memo": null, "balance_debit_amount": "0.000273", "callback_url": null, "skip_user_address_confirmation": true, "created_at": "2026-02-26T08:25:33+00:00", "updated_at": "2026-02-26T08:25:54+00:00", "processor": "coingate", "binance_refund_id": null, "order": { "id": 284096, "title": "My Store Order #111", "price_amount": "1369.0", "created_at": "2025-08-11T08:52:50+00:00", "paid_at": "2025-08-11T08:53:27+00:00", "price_currency": { "id": 2, "title": "Euro", "kind": "fiat", "symbol": "EUR", "enabled": true, "disabled_message": null } }, "balance_debit_currency": { "id": 1, "title": "Bitcoin", "kind": "crypto", "symbol": "BTC", "enabled": true, "disabled_message": null }, "refund_currency": { "id": 1, "title": "Bitcoin", "symbol": "BTC", "platform": { "id": 6, "title": "Bitcoin" } }, "transactions": [], "fees": { "service_fee": { "amount": "0.00000462", "currency": { "id": 1, "title": "Bitcoin", "kind": "crypto", "symbol": "BTC", "enabled": true, "disabled_message": null } } }, "ledger_account": { "id": "01GVH4DZW43CHQRCZFSS5GES9V", "currency": { "id": 1, "title": "Bitcoin", "symbol": "BTC" } } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "reason": { "type": "string" } } } } } } }, "parameters": [ { "in": "path", "name": "order_id", "schema": { "type": "integer", "default": "" }, "required": true, "description": "CoinGate Order ID" }, { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true, "description": "CoinGate Merchant Refund ID" } ], "summary": "Mark as Rejected", "operationId": "patch_orders-order-id-refunds-id-mark-as-rejected" } }, "/orders/{order_id}/refunds/{id}/mark_as_completed": { "patch": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "id": 1426, "request_amount": "10.0", "refund_amount": "0.0002733", "address": "mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJRfn", "status": "completed", "memo": null, "balance_debit_amount": "0.000273", "callback_url": null, "skip_user_address_confirmation": true, "created_at": "2026-02-26T08:15:57+00:00", "updated_at": "2026-02-26T08:16:20+00:00", "processor": "coingate", "binance_refund_id": null, "order": { "id": 284114, "title": "My Store Order #111", "price_amount": "1369.0", "created_at": "2025-08-11T09:01:57+00:00", "price_currency": { "id": 2, "title": "Euro", "kind": "fiat", "symbol": "EUR", "enabled": true, "disabled_message": null } }, "balance_debit_currency": { "id": 1, "title": "Bitcoin", "kind": "crypto", "symbol": "BTC", "enabled": true, "disabled_message": null }, "refund_currency": { "id": 1, "title": "Bitcoin", "symbol": "BTC", "platform": { "id": 6, "title": "Bitcoin" } }, "transactions": [], "fees": { "service_fee": { "amount": "0.00000463", "currency": { "id": 1, "title": "Bitcoin", "kind": "crypto", "symbol": "BTC", "enabled": true, "disabled_message": null } } }, "ledger_account": { "id": "01GVH4DZW43CHQRCZFSS5GES9V", "currency": { "id": 1, "title": "Bitcoin", "symbol": "BTC" } } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "reason": { "type": "string" } } } } } } }, "parameters": [ { "in": "path", "name": "order_id", "schema": { "type": "integer", "default": "" }, "required": true, "description": "CoinGate Order ID" }, { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true, "description": "CoinGate Merchant Refund ID" } ], "operationId": "patch_orders-order-id-refunds-id-mark-as-completed", "summary": "Mark as Completed" } }, "/contacts": { "post": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "200": { "summary": "200", "value": { "id": 45, "contact_type": "person", "email": "jane.doe@example.com", "external_contact_id": "shop_user_45", "status": "active", "created_at": "2026-06-09T08:20:35.437Z", "first_name": "Jane", "surname": "Doe", "date_of_birth": "1990-01-15", "address_country_id": 133 } } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 45, "default": 0 }, "contact_type": { "type": "string", "example": "person" }, "email": { "type": "string", "example": "jane.doe@example.com" }, "external_contact_id": { "type": "string", "example": "shop_user_45" }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "example": "2026-06-09T08:20:35.437Z" }, "first_name": { "type": "string", "example": "Jane" }, "surname": { "type": "string", "example": "Doe" }, "date_of_birth": { "type": "string", "example": "1990-01-15" }, "address_country_id": { "type": "integer", "example": 133, "default": 0 } } } } } } }, "parameters": [], "operationId": "post_contacts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "contact_type": { "type": "string", "description": "Type of contact. Allowed values: person, business.", "default": "person" }, "email": { "type": "string", "description": "Contact email address. Must be a valid, non-disposable email." }, "external_contact_id": { "type": "string", "description": "External Contact ID used in your application (e.g. user or customer ID). Must be unique per merchant." }, "first_name": { "type": "string", "description": "First name of the contact (required if contact_type is person)." }, "surname": { "type": "string", "description": "Last name of the contact (required if contact_type is person)." }, "company_name": { "type": "string", "description": "Company name (required if contact_type is business)." }, "date_of_birth": { "type": "string", "description": "Date of birth in YYYY-MM-DD format (required if contact_type is person)." }, "address_country": { "type": "string", "default": "", "description": "Country of residence as ISO 3166-1 alpha-2 (e.g. LT) or alpha-3 (e.g. LTU) code (required if contact_type is person)." }, "company_code": { "type": "string", "description": "Company registration code (required if contact_type is business)." }, "incorporation_country": { "type": "string", "description": "Company registration country as ISO 3166-1 alpha-2 or alpha-3 code (required if contact_type is business)." } }, "required": [ "contact_type", "email", "external_contact_id" ] } } } }, "summary": "Create Contact" }, "get": { "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "current_page": 1, "per_page": 100, "total_records": 2, "total_pages": 1, "contacts": [ { "id": 29, "contact_type": "person", "email": "qa.test+example@coingate.com", "external_contact_id": "QA-EXTERNAL-1", "status": "active", "created_at": "2026-06-02T08:19:30.572Z", "first_name": "Jane", "surname": "Doe", "date_of_birth": "1995-05-21", "address_country_id": 133 }, { "id": 30, "contact_type": "business", "email": "qa.test+acme@coingate.com", "external_contact_id": "QA-EXTERNAL-2", "status": "active", "created_at": "2026-06-02T09:14:11.022Z", "company_name": "Acme QA UAB", "company_code": "QA-12345678", "incorporation_country_id": 133 } ] } } } } } } }, "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer", "default": "1" }, "description": "1-indexed page number. Defaults to 1." }, { "in": "query", "name": "per_page", "schema": { "type": "integer", "default": "100" }, "description": "Items per page. Defaults to 100. Capped at 100." } ], "summary": "List Contacts", "operationId": "get_contacts" } }, "/payment_channels": { "post": { "description": "", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "id": 76, "contact_id": 40, "payment_purpose": "Subscription fees", "callback_url": "https://example.com/webhooks/payment-channels", "receive_currency_id": 1, "status": "active", "created_at": "2026-06-09T05:43:14.172Z", "addresses": [ { "currency_id": 1, "platform_id": 4, "address": null, "memo": "", "status": "enqueued" } ] } } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 76, "default": 0 }, "contact_id": { "type": "integer", "example": 40, "default": 0 }, "payment_purpose": { "type": "string", "example": "Subscription fees" }, "callback_url": { "type": "string", "example": "https://example.com/webhooks/payment-channels" }, "receive_currency_id": { "type": "integer", "example": 1, "default": 0 }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "example": "2026-06-09T05:43:14.172Z" }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "currency_id": { "type": "integer", "example": 1, "default": 0 }, "platform_id": { "type": "integer", "example": 4, "default": 0 }, "address": {}, "memo": { "type": "string", "example": "" }, "expires_at": {}, "status": { "type": "string", "example": "enqueued" } } } } } } } } }, "422": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Payment channel is not valid" }, "reason": { "type": "string", "example": "PaymentChannelIsNotValid" }, "errors": { "type": "object", "properties": { "contact_id": { "type": "array", "items": { "type": "string", "example": "is already assigned to another payment channel" } } } } } }, "examples": { "422": { "summary": "422", "value": { "message": "Payment channel is not valid", "reason": "PaymentChannelIsNotValid", "errors": { "contact_id": [ "is already assigned to another payment channel" ] } } } } } }, "description": "422" } }, "parameters": [], "operationId": "post_payment-channels", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "contact_id": { "type": "integer", "description": "Contact to associate with this channel. Must belong to the same merchant, have all required travel-rule fields filled, and not already be assigned to another payment channel (a contact maps to at most one channel)." }, "receive_currency_id": { "type": "integer", "description": "Currency the merchant wants to receive. Must be enabled and support merchant receive." }, "payment_purpose": { "type": "string", "description": "Purpose of the payment (e.g. merchant_payment, subscription, donation)." }, "callback_url": { "type": "string", "description": "URL to receive webhook notifications for transactions on this channel." }, "assets": { "type": "array", "description": "Crypto assets to generate addresses for. New addresses start enqueued (null address) and become active within ~1 min. Each item: currency_id (integer, required), platform_id (integer, required).", "items": { "properties": {}, "type": "object" } } }, "required": [ "contact_id", "receive_currency_id" ] } } } }, "summary": "Create Payment Channel" }, "get": { "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "current_page": 1, "per_page": 100, "total_records": 2, "total_pages": 1, "payment_channels": [ { "id": 61, "contact_id": 29, "payment_purpose": "Subscription fees", "callback_url": "https://example.com/webhooks/payment-channels", "receive_currency_id": 4, "status": "active", "created_at": "2026-06-02T08:19:38.374Z", "addresses": [ { "currency_id": 1, "platform_id": 4, "address": "bc1qexampledepositaddress00000000000000000", "memo": "", "status": "active" }, { "currency_id": 7, "platform_id": 11, "address": "0xExampleEthereumAddress00000000000000000000", "memo": "", "status": "active" } ] } ] } } } } } } }, "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer", "default": "1" }, "description": "1-indexed page number. Defaults to 1." }, { "in": "query", "name": "per_page", "schema": { "type": "integer", "default": "100" }, "description": "Items per page. Defaults to 100. Capped at 100." } ], "operationId": "get_payment-channels", "summary": "List Payment Channels" } }, "/countries/merchants": { "get": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": [ { "alpha2_code": "DE", "alpha3_code": "DEU", "name": "Germany" }, { "alpha2_code": "LT", "alpha3_code": "LTU", "name": "Lithuania" } ] } }, "schema": { "type": "object", "properties": { "alpha2_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code (e.g. LT)." }, "alpha3_code": { "type": "string", "description": "ISO 3166-1 alpha-3 country code (e.g. LTU)." }, "name": { "type": "string", "description": "English country name." } }, "required": [ "alpha2_code", "alpha3_code", "name" ] } } } } }, "parameters": [], "operationId": "get_countries-merchants", "summary": "Merchant Supported Countries" } }, "/countries/shoppers": { "get": { "description": "Returns the countries where users can pay for orders (\"shoppers\").", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "alpha2_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code (e.g. LT)." }, "alpha3_code": { "type": "string", "description": "ISO 3166-1 alpha-3 country code (e.g. LTU)." }, "name": { "type": "string", "description": "English country name." } }, "required": [ "alpha2_code", "name", "alpha3_code" ] }, "examples": { "OK": { "summary": "OK", "value": [ { "alpha2_code": "DE", "alpha3_code": "DEU", "name": "Germany" }, { "alpha2_code": "LT", "alpha3_code": "LTU", "name": "Lithuania" }, { "alpha2_code": "US", "alpha3_code": "USA", "name": "United States" } ] } } } } } }, "parameters": [], "operationId": "get_countries-shoppers", "summary": "Shopper Supported Countries" } }, "/industries": { "get": { "summary": "Industries", "description": "Returns the list of enabled industries, sorted by title. Use the industry id when submitting the industries field of a business verification.", "operationId": "list-industries", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Industry identifier. Use this value when submitting business verification industries." }, "title": { "type": "string", "description": "Human-readable industry name." }, "slug": { "type": "string", "description": "URL-friendly industry identifier." } }, "required": [ "id", "title", "slug" ] } }, "examples": { "OK": { "summary": "OK", "value": [ { "id": 1, "title": "Apparel & Cosmetics", "slug": "apparel-cosmetics" }, { "id": 4, "title": "Education", "slug": "education" }, { "id": 10, "title": "Gaming (not gambling)", "slug": "gaming-not-gambling" } ] } } } } } } } }, "/payment_channels/supported-currencies": { "get": { "description": "", "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": [ { "id": 1, "title": "Bitcoin", "kind": "crypto", "symbol": "BTC", "enabled": true, "disabled_message": null, "platforms": [ { "id": 4, "id_name": "bitcoin", "title": "Bitcoin", "enabled": true } ] }, { "id": 7, "title": "Tether", "kind": "crypto", "symbol": "USDT", "enabled": true, "disabled_message": null, "platforms": [ { "id": 11, "id_name": "ethereum", "title": "Ethereum", "enabled": true }, { "id": 18, "id_name": "tron", "title": "Tron", "enabled": true } ] } ] } } } } } }, "parameters": [], "operationId": "get_payment-channels-supported-currencies", "summary": "Supported Currencies" } }, "/billing/recurrings": { "get": { "summary": "List Recurring Billing", "description": "", "operationId": "list-billing-requests-1", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "per_page": { "type": "integer", "description": "Records per page.", "default": 100, "format": "int32" }, "page": { "type": "integer", "description": "Current page number.", "default": 1, "format": "int32" }, "sort": { "type": "string", "description": "Sort billing requests by field. Available sort options: created_at_asc, created_at_desc. Default: created_at_asc.", "default": "created_at_desc" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "current_page": 1, "per_page": 100, "total_records": 8, "total_pages": 1, "recurring_billings": [ { "id": 8, "status": "active", "frequency": "monthly", "start_at": "2026-05-29", "end_at": null, "next_billing_at": "2026-06-29", "created_at": "2026-05-29T11:01:21.695Z", "billing_requests": [ { "id": 13, "status": "pending", "created_at": "2026-05-29T11:01:21.703Z", "paid_at": null } ] }, { "id": 7, "status": "active", "frequency": "monthly", "start_at": "2026-06-01", "end_at": null, "next_billing_at": "2026-06-01", "created_at": "2026-05-29T11:00:38.861Z", "billing_requests": [ { "id": 12, "status": "scheduled", "created_at": "2026-05-29T11:00:38.877Z", "paid_at": null } ] }, { "id": 6, "status": "canceled", "frequency": "monthly", "start_at": "2026-05-25", "end_at": null, "next_billing_at": "2026-06-25", "created_at": "2026-05-25T08:35:14.566Z", "billing_requests": [ { "id": 11, "status": "pending", "created_at": "2026-05-25T08:35:14.570Z", "paid_at": null } ] } ] } } }, "schema": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "per_page": { "type": "integer", "example": 100, "default": 0 }, "total_records": { "type": "integer", "example": 8, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 }, "recurring_billings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 8, "default": 0 }, "status": { "type": "string", "example": "active" }, "frequency": { "type": "string", "example": "monthly" }, "start_at": { "type": "string", "example": "2026-05-29", "format": "date" }, "end_at": { "type": "string", "format": "date" }, "next_billing_at": { "type": "string", "example": "2026-06-29", "format": "date" }, "created_at": { "type": "string", "example": "2026-05-29T11:01:21.695Z", "format": "date-time" }, "billing_requests": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 13, "default": 0 }, "status": { "type": "string", "example": "pending" }, "created_at": { "type": "string", "example": "2026-05-29T11:01:21.703Z", "format": "date-time" }, "paid_at": { "type": "string", "format": "date-time" } } } } } } } } } } } } } }, "post": { "summary": "Create Recurring Billing", "description": "", "operationId": "create-billing-request-1", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": 1, "status": "active", "frequency": "monthly", "start_at": "2026-05-29", "end_at": null, "next_billing_at": "2026-06-29", "created_at": "2026-05-29T11:01:21.695Z", "billing_requests": [ { "id": 13, "status": "pending", "created_at": "2026-05-29T11:01:21.703Z", "paid_at": null } ] } } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "status": { "type": "string", "example": "active" }, "frequency": { "type": "string", "example": "monthly" }, "start_at": { "type": "string", "example": "2026-05-29" }, "end_at": { "type": "string", "format": "date" }, "next_billing_at": { "type": "string", "example": "2026-06-29", "format": "date" }, "created_at": { "type": "string", "example": "2026-05-29T11:01:21.695Z", "format": "date-time" }, "billing_requests": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 13, "default": 0 }, "status": { "type": "string", "example": "pending" }, "created_at": { "type": "string", "example": "2026-05-29T11:01:21.703Z", "format": "date-time" }, "paid_at": { "type": "string", "format": "date-time" } } } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": { "message": "Recurring billing is not valid", "reason": "RecurringBillingIsNotValid", "errors": [ "Start at can't be in the past" ] } } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Billing request is not valid" }, "reason": { "type": "string", "example": "BillingRequestIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Amount must be greater than 0" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "properties": { "billing_contact_id": { "type": "integer", "format": "int32", "description": "Billing Contact ID." }, "title": { "type": "string", "description": "Request title." }, "currency_id": { "type": "integer", "format": "int32", "description": "Currency of amount. Currency ID's can be seen on https://developer.coingate.com/reference/currencies." }, "amount": { "type": "string", "description": "Amount is required only when the request is created without associated products. If products are included, the amount is automatically calculated based on the product prices and quantities." }, "receive_currency_id": { "type": "integer", "format": "int32", "description": "Currency ID's can be seen on https://developer.coingate.com/reference/currencies." }, "frequency": { "type": "string", "description": "How often billing occurs. Possible values: `weekly`, `monthly`.", "enum": [ "weekly", "monthly" ] }, "start_at": { "type": "string", "format": "date", "description": "When the first billing will be sent to the client. If set to a future date, the first billing will be created as a scheduled item and sent on the `start_at` date. This date also acts as the anchor day for subsequent recurring billings." }, "end_at": { "type": "string", "description": "Indicates when recurring billings stop. If not set, billings will continue indefinitely.", "format": "date", "default": "" }, "underpaid_cover_pct": { "type": "integer", "description": "How much percentage of underpaid can be covered. Max: 10.", "default": "0" }, "callback_url": { "type": "string", "description": "Send an automated message to Merchant URL when request status is changed. For testing you can use requestcatcher.com tool. URL must be direct without redirection. Read about billing request callbacks [here](https://developer.coingate.com/reference/billing-request-callback)." }, "billing_request_items": { "type": "object", "properties": { "billing_product_id": { "type": "integer", "description": "Billing Product ID.", "format": "int32" }, "quantity": { "type": "integer", "format": "int32", "description": "Quantity of product." } }, "description": "Billing Products and quantity. If present amount will calculated based on product price and quantity." } }, "type": "object", "required": [ "billing_contact_id", "currency_id", "receive_currency_id", "frequency", "start_at" ] } } } } } }, "/billing/recurrings/{id}": { "get": { "summary": "Get Recurring Billing", "description": "", "operationId": "list-billing-requests-1-1", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "summary": "Result", "value": { "id": 3, "status": "active", "frequency": "weekly", "start_at": "2026-04-30", "end_at": "2026-05-28", "next_billing_at": "2026-05-07", "created_at": "2026-04-30T14:22:08.409Z", "billing_requests": [ { "id": 4, "status": "pending", "created_at": "2026-04-30T14:22:08.412Z", "paid_at": null } ] } } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 3, "default": 0 }, "status": { "type": "string", "example": "active" }, "frequency": { "type": "string", "example": "weekly" }, "start_at": { "type": "string", "example": "2026-04-30", "format": "date" }, "end_at": { "type": "string", "example": "2026-05-28", "format": "date" }, "next_billing_at": { "type": "string", "example": "2026-05-07", "format": "date" }, "created_at": { "type": "string", "example": "2026-04-30T14:22:08.409Z", "format": "date-time" }, "billing_requests": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 4, "default": 0 }, "status": { "type": "string", "example": "pending" }, "created_at": { "type": "string", "example": "2026-04-30T14:22:08.412Z", "format": "date-time" }, "paid_at": { "type": "string", "format": "date-time" } } } } } } } } }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Recurring billing not found" }, "reason": { "type": "string", "example": "RecurringBillingNotFound" } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "message": "Recurring billing not found", "reason": "RecurringBillingNotFound" } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true, "description": "ID of recurring billing" } ] } }, "/billing/recurrings/{id}/discontinue": { "patch": { "summary": "Discontinue Recurring Billing", "description": "", "operationId": "list-billing-requests-1-1-1", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "summary": "Result", "value": { "id": 8, "status": "canceled", "frequency": "monthly", "start_at": "2026-05-29", "end_at": null, "next_billing_at": "2026-06-29", "created_at": "2026-05-29T11:01:21.695Z", "billing_requests": [ { "id": 13, "status": "pending", "created_at": "2026-05-29T11:01:21.703Z", "paid_at": null } ] } } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 3, "default": 0 }, "status": { "type": "string", "example": "active" }, "frequency": { "type": "string", "example": "weekly" }, "start_at": { "type": "string", "example": "2026-04-30", "format": "date" }, "end_at": { "type": "string", "example": "2026-05-28", "format": "date" }, "next_billing_at": { "type": "string", "example": "2026-05-07", "format": "date" }, "created_at": { "type": "string", "example": "2026-04-30T14:22:08.409Z", "format": "date-time" }, "billing_requests": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 4, "default": 0 }, "status": { "type": "string", "example": "pending" }, "created_at": { "type": "string", "example": "2026-04-30T14:22:08.412Z", "format": "date-time" }, "paid_at": { "type": "string", "format": "date-time" } } } } } } } } }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Recurring billing not found" }, "reason": { "type": "string", "example": "RecurringBillingNotFound" } } }, "examples": { "Not Found": { "summary": "Not Found", "value": { "message": "Recurring billing not found", "reason": "RecurringBillingNotFound" } } } } }, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true, "description": "ID of recurring billing." } ] } }, "/payment_channels/{id}/addresses": { "post": { "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "payment_channel_id": { "type": "integer" }, "addresses": { "type": "array", "items": { "properties": { "currency_id": { "type": "integer" }, "platform_id": { "type": "integer" }, "address": { "type": "string" }, "memo": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "status": { "type": "string" } }, "type": "object", "required": [ "platform_id", "currency_id", "expires_at", "status" ] } } }, "required": [ "payment_channel_id", "addresses" ] }, "examples": { "OK": { "summary": "OK", "value": { "payment_channel_id": 61, "addresses": [ { "currency_id": 7, "platform_id": 11, "address": null, "memo": "", "status": "enqueued" }, { "currency_id": 7, "platform_id": 18, "address": null, "memo": "", "status": "enqueued" } ] } } } } } }, "422": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Payment channel is not valid" }, "reason": { "type": "string", "example": "PaymentChannelIsNotValid" }, "errors": { "type": "array", "items": { "type": "string", "example": "Platform 11 does not exist or is not eligible for currency 7" } } } }, "examples": { "Unsupported asset": { "summary": "Unsupported asset", "value": { "message": "Payment channel is not valid", "reason": "PaymentChannelIsNotValid", "errors": [ "Platform 11 does not exist or is not eligible for currency 7" ] } } } } }, "description": "Unsupported asset" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "required": true, "description": "Payment channel ID." } ], "summary": "Add Addresses", "operationId": "post_payment-channels-id-addresses", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "assets": { "type": "array", "items": { "properties": { "currency_id": { "type": "integer" }, "platform_id": { "type": "integer" } }, "type": "object", "required": [ "currency_id", "platform_id" ] }, "description": "One or more { currency_id, platform_id } pairs to generate addresses for. Each item: currency_id (integer, required), platform_id (integer, required)." } }, "required": [ "assets" ] } } } }, "x-readme": { "code-samples": [ { "code": "curl -X POST \"https://api.coingate.com/api/v2/payment_channels/61/addresses\" \\\n -H \"Authorization: Token \" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n --data-urlencode \"assets[][currency_id]=7\" \\\n --data-urlencode \"assets[][platform_id]=11\" \\\n --data-urlencode \"assets[][currency_id]=7\" \\\n --data-urlencode \"assets[][platform_id]=18\"", "language": "shell", "name": "" } ], "samples-languages": [ "shell" ] } } }, "/payment_channels/{id}": { "get": { "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "200": { "summary": "200", "value": { "id": 86, "contact_id": 45, "payment_purpose": "Subscription fees", "callback_url": "https://example.com/webhooks/payment-channels", "receive_currency_id": 1, "status": "active", "created_at": "2026-06-09T08:20:44.998Z", "addresses": [ { "currency_id": 1, "platform_id": 4, "address": "tb1qexampledepositaddress00000000000000000", "memo": "", "status": "active" } ] } } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 86, "default": 0 }, "contact_id": { "type": "integer", "example": 45, "default": 0 }, "payment_purpose": { "type": "string", "example": "Subscription fees" }, "callback_url": { "type": "string", "example": "https://example.com/webhooks/payment-channels" }, "receive_currency_id": { "type": "integer", "example": 1, "default": 0 }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "example": "2026-06-09T08:20:44.998Z" }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "currency_id": { "type": "integer", "example": 1, "default": 0 }, "platform_id": { "type": "integer", "example": 4, "default": 0 }, "address": { "type": "string", "example": "tb1qexampledepositaddress00000000000000000" }, "memo": { "type": "string", "example": "" }, "expires_at": {}, "status": { "type": "string", "example": "active" } } } } } } } } }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Payment channel not found" }, "reason": { "type": "string", "example": "PaymentChannelNotFound" } } }, "examples": { "404": { "summary": "404", "value": { "message": "Payment channel not found", "reason": "PaymentChannelNotFound" } } } } }, "description": "404" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "required": true, "description": "ID of the payment channel to retrieve." } ], "operationId": "get_payment-channels-id", "summary": "Get Payment Channel" } }, "/contacts/{id}": { "get": { "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "200": { "summary": "200", "value": { "id": 45, "contact_type": "person", "email": "jane.doe@example.com", "external_contact_id": "shop_user_45", "status": "active", "created_at": "2026-06-09T08:20:35.437Z", "first_name": "Jane", "surname": "Doe", "date_of_birth": "1990-01-15", "address_country_id": 133 } } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 45, "default": 0 }, "contact_type": { "type": "string", "example": "person" }, "email": { "type": "string", "example": "jane.doe@example.com" }, "external_contact_id": { "type": "string", "example": "shop_user_45" }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "example": "2026-06-09T08:20:35.437Z" }, "first_name": { "type": "string", "example": "Jane" }, "surname": { "type": "string", "example": "Doe" }, "date_of_birth": { "type": "string", "example": "1990-01-15" }, "address_country_id": { "type": "integer", "example": 133, "default": 0 } } } } } }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Contact not found" }, "reason": { "type": "string", "example": "ContactNotFound" } } }, "examples": { "404": { "summary": "404", "value": { "message": "Contact not found", "reason": "ContactNotFound" } } } } }, "description": "404" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "required": true, "description": "Contact ID." } ], "summary": "Get Contact", "operationId": "get_contacts-id" } }, "/contacts/{id}/upload-documents": { "post": { "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Server-assigned uploaded-file ID. Stable." }, "created_at": { "type": "string", "description": "Upload timestamp in UTC (ISO8601)." }, "filename": { "type": "string", "description": "Original filename submitted in the multipart upload." }, "document_type": { "type": "string", "description": "Echoes the document_type from the request." } }, "required": [ "id" ] } }, "examples": { "200": { "summary": "200", "value": { "files": [ { "id": 4821, "created_at": "2026-06-04T08:12:33.114Z", "filename": "passport.pdf", "document_type": "passport" } ] } } } } } }, "422": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Document upload failed" }, "reason": { "type": "string", "example": "DocumentUploadFailed" }, "errors": { "type": "array", "items": { "type": "string", "example": "Document type is not allowed for person contacts" } } } }, "examples": { "422": { "summary": "422", "value": { "message": "Document upload failed", "reason": "DocumentUploadFailed", "errors": [ "Document type is not allowed for person contacts" ] } } } } }, "description": "422" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "required": true, "description": "Contact ID." } ], "summary": "Upload Documents", "description": "", "operationId": "post_contacts-id-upload-documents", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "byte", "default": "", "description": "The document file to upload. Refer to file constraints above." }, "document_type": { "type": "string", "description": "The kind of document. Allowed values depend on the contact type. Refer to the allowed document types above." }, "comment": { "type": "string", "description": "Optional note for compliance reviewers." } }, "required": [ "file", "document_type" ] } } } } } } }, "x-readme": { "headers": [], "explorer-enabled": false, "proxy-enabled": true }, "x-readme-fauxas": true }