{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/orders/:id","auth":"required","method":"get","results":{"codes":[{"name":"","code":"{\n  \"id\": 1195824,\n  \"status\": \"paid\",\n  \"orderable_type\": \"ApiApp\",\n  \"orderable_id\": 42,\n  \"price_currency\": \"EUR\",\n  \"price_amount\": \"10.0\",\n  \"pay_currency\": \"BTC\",\n  \"pay_amount\": \"0.001281\",\n  \"receive_currency\": \"EUR\",\n  \"receive_amount\": \"9.9\",\n  \"created_at\": \"2018-04-24T23:43:14+00:00\",\n  \"expire_at\": \"2018-04-25T00:05:40+00:00\",\n  \"payment_address\": \"38gmr5MujyDxcEhaqFfC5P9K6bhJo548gu\",\n  \"order_id\": \"110\",\n  \"underpaid_amount\": \"0\",\n  \"overpaid_amount\": \"0\",\n\t\"is_refundable\": false,\n  \"payment_url\": \"https://coingate.com/invoice/4f5e5a63-5270-435d-bf05-eec369b0fdba\"\n}","language":"json","status":200},{"name":"","code":"{\n  \"message\": \"Order not found\",\n  \"reason\": \"OrderNotFound\"\n}","language":"json","status":404}]},"settings":"5adcc50db719b20003516400","examples":{"codes":[{"language":"curl","code":"curl -H \"Authorization: Token YOUR_APP_TOKEN\" https://api.coingate.com/v2/orders/1195824"}]},"params":[{"name":"id","type":"int","default":"","desc":"CoinGate Order id","required":false,"in":"path","ref":"","_id":"5afbf74331e0c60003513f58"}]},"next":{"description":"","pages":[]},"title":"Get Order","type":"endpoint","slug":"get-order","excerpt":"Before making a GET order request, a user should have an already CREATED order, which can be paid or canceled. To CREATE ORDER, please follow the instructions here https://developer.coingate.com/docs/create-order \n\nAfter creating an order, you will get an ORDER ID. This ID will be used for GET ORDER requests.\n\nPlease, take into account that before creating requests within the CoinGate system, the user should have an authentication token. To have it, please follow the instructions here https://developer.coingate.com/docs/api-authentication","body":"Fields `pay_currency, pay_amount, expire_at, payment_address` are **only sent** when the customer chooses the currency with which he is going to pay for the invoice.","updates":["5a7c9d5f324bc1001f64aeb9","612569c1c3f1f2001f153414","6155bca1f266e50071f132ef"],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5adcc1185cd1890003da816e","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Payment Gateway","slug":"orders","order":2,"from_sync":false,"reference":false,"_id":"5adcc1185cd1890003da8167","version":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","createdAt":"2015-08-18T18:14:59.726Z","__v":1},"user":"5530bf7457cea10d00a3aa3a","parentDoc":null,"project":"5530bfac57cea10d00a3aa3b","version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5adcc1185cd1890003da8166","5adcc1185cd1890003da8167","5adcf4b3ce4b3f00035317e9","5adfb8e9452bd900036d115b","5e7b51281ac49702d745882c","5e7b526560c6cc004f25ca3e","61c47c8dc69d6b000f961812","62289a8cb831c9003650b36c","62615ded4828c0003015b8a2","627511250a8fbb052a794d80","62b43cee767dd2003ad59e14"],"_id":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","createdAt":"2018-04-22T17:06:32.152Z","releaseDate":"2018-04-22T17:06:32.152Z","__v":10},"createdAt":"2015-08-18T19:05:55.998Z","githubsync":"","__v":10}

getGet Order

Before making a GET order request, a user should have an already CREATED order, which can be paid or canceled. To CREATE ORDER, please follow the instructions here https://developer.coingate.com/docs/create-order After creating an order, you will get an ORDER ID. This ID will be used for GET ORDER requests. Please, take into account that before creating requests within the CoinGate system, the user should have an authentication token. To have it, please follow the instructions here https://developer.coingate.com/docs/api-authentication

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
integer
CoinGate Order id

Examples


Result Format


Documentation

Fields `pay_currency, pay_amount, expire_at, payment_address` are **only sent** when the customer chooses the currency with which he is going to pay for the invoice.