{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/orders/:id/checkout","auth":"required","method":"post","examples":{"codes":[{"language":"curl","code":"curl -H \"Authorization: Token YOUR_APP_TOKEN\" -X POST -d \"pay_currency=BTC\" https://api.coingate.com/v2/orders/140043/checkout"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \t\"id\": 1723,\n    \"order_id\": \"\",\n    \"pay_amount\": \"0.000023\",\n    \"pay_currency\": \"BTC\",\n    \"payment_address\": \"2MzyF5xfYRAmHVPwG6YPRMY74dojhAVEtmm\",\n    \"payment_url\": \"http://coingate.com/invoice/4949cf0a-fccb-4cc2-9342-7af1890cc664\",\n    \"price_amount\": \"0.01\",\n    \"price_currency\": \"USD\",\n    \"receive_amount\": \"0.01\",\n    \"receive_currency\": \"USD\",\n    \"status\": \"pending\",\n    \"created_at\": \"2018-05-04T21:46:07+00:00\",\n    \"expire_at\": \"2018-05-04T22:11:58+00:00\"\n}","name":""},{"status":422,"language":"json","code":"{\n    \"message\": \"Order does not exist\",\n    \"reason\": \"OrderNotFound\"\n}","name":""}]},"settings":"5adcc50db719b20003516400","params":[{"name":"pay_currency","type":"string","default":"","desc":"Payment cryptocurrency. Possible values: *BTC*, *LTC*, *ETH*, *BCH*, *NANO*, *TRX*, *SRN*, *TEL*. Other cryptocurrencies are processed via Changelly and are not accessible with the Checkout method.","required":true,"in":"body","ref":"","_id":"5aecd74e0c435b00035860e6"},{"name":"id","type":"int","default":"","desc":"CoinGate order ID","required":false,"in":"path","ref":"","_id":"5aed6a250bd4db0003052076"},{"name":"lightning_network","type":"boolean","default":"","desc":"Lightning network parameter is optional and it is available only for BTC and LTC cryptocurrencies. Maximum available price amount for lightning network orders is 0.042 BTC equivalent.","required":false,"in":"body","ref":"","_id":"5e8b18571ba785004995c401"}]},"next":{"description":"","pages":[]},"title":"Checkout","type":"endpoint","slug":"checkout","excerpt":"Placing [created order](doc: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.\n\nImportant. Checkout method can only be used with the following payment currencies: BTC, XRP, ETH, LTC, BCH, TRX, NANO, DAI, USDS, SRN, TEL, BTT.","body":"# White-label invoices using Checkout method #\n\nUsing Checkout method, invoices can be white-labelled and integrated into your website, without redirecting the customer to CoinGate.\n\nThis is achieved by pre-selecting BTC, LTC, ETH, BCH, NANO, TRX, SRN or TEL (new coins added regularly) as the payment currency, and retrieving the `pay_amount` and `payment_address` parameters. These are sufficient for a customer to complete the payment, as well as to generate a QR code which a customer can scan with a mobile wallet.","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5aecd74e0c435b00035860e5","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"],"_id":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","createdAt":"2018-04-22T17:06:32.152Z","releaseDate":"2018-04-22T17:06:32.152Z","__v":5},"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","createdAt":"2018-05-04T21:57:34.102Z","githubsync":"","__v":24,"parentDoc":null}

postCheckout

Placing [created order](doc: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. Important. Checkout method can only be used with the following payment currencies: BTC, XRP, ETH, LTC, BCH, TRX, NANO, DAI, USDS, SRN, TEL, BTT.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
integer
CoinGate order ID

Body Params

pay_currency:
required
string
Payment cryptocurrency. Possible values: *BTC*, *LTC*, *ETH*, *BCH*, *NANO*, *TRX*, *SRN*, *TEL*. Other cryptocurrencies are processed via Changelly and are not accessible with the Checkout method.
lightning_network:
boolean
Lightning network parameter is optional and it is available only for BTC and LTC cryptocurrencies. Maximum available price amount for lightning network orders is 0.042 BTC equivalent.

Examples


Result Format


Documentation

# White-label invoices using Checkout method # Using Checkout method, invoices can be white-labelled and integrated into your website, without redirecting the customer to CoinGate. This is achieved by pre-selecting BTC, LTC, ETH, BCH, NANO, TRX, SRN or TEL (new coins added regularly) as the payment currency, and retrieving the `pay_amount` and `payment_address` parameters. These are sufficient for a customer to complete the payment, as well as to generate a QR code which a customer can scan with a mobile wallet.