{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/orders/:id/checkout","auth":"required","method":"post","examples":{"codes":[{"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"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 10568600,\n  \"status\": \"pending\",\n  \"do_not_convert\": false,\n  \"price_currency\": \"EUR\",\n  \"price_amount\": \"1149.0\",\n  \"pay_currency\": \"ETH\",\n  \"pay_amount\": \"0.3315205\",\n  \"lightning_network\": false,\n  \"receive_currency\": \"EUR\",\n  \"receive_amount\": \"1137.51\",\n  \"created_at\": \"2021-12-23T14:00:55+00:00\",\n  \"expire_at\": \"2021-12-23T14:50:02+00:00\",\n  \"payment_address\": \"bnb1lqfu2n6xg9n6ggqjjdjpp4r866vp99qxac87n8?memo=10568600\",\n  \"order_id\": \"111\",\n  \"payment_url\": \"https://pay.coingate.com/invoice/b8d68eee-aa21-478e-bc15-d8251c9dc12e\",\n  \"underpaid_amount\": \"0.3315205\",\n  \"overpaid_amount\": \"0\",\n  \"is_refundable\": false,\n  \"platform\": {\n    \"id\": 2,\n    \"title\": \"Binance Chain (BEP2)\",\n    \"id_name\": \"binance_chain\"\n  }\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*, etc. Other cryptocurrencies are processed via a third party 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"},{"name":"purchaser_email","type":"string","default":"","desc":"Email address of the purchaser (payee) provided will be pre-filled on the invoice.","required":false,"in":"body","ref":"","_id":"602a7aa1f5ca0a006c9c5d7d"},{"name":"platform_id","type":"int","default":"","desc":"Is an optional parameter where you can select on what blockchain (platform) the particular digital asset is expected to be received. By default (if the parameter is empty) the system will generate the invoice on the NATIVE blockchain (Binance chain for BNB, Bitcoin chain for BTC, Ethereum chain for ETH, etc.) or on Ethereum blockchain for Tokens (BUSD, DAI USDT, etc.). For more information about available blockchains (platforms) see [here](https://developer.coingate.com/docs/platforms). For more information about blockchain (platform) availability for different currencies see [here](https://developer.coingate.com/docs/currencies).","required":false,"in":"body","ref":"","_id":"61c4800b41f05800e31786f4"}]},"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\nThis is private API endpoint and requires [authentication](https://developer.coingate.com/docs/api-authentication).","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, etc 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.\n\nYou can find out which payment currencies can be used using this list: https://api.coingate.com/v2/currencies?native=true&enabled=true&merchant_pay=true","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","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},"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":50,"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. This is private API endpoint and requires [authentication](https://developer.coingate.com/docs/api-authentication).

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*, etc. Other cryptocurrencies are processed via a third party 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.
purchaser_email:
string
Email address of the purchaser (payee) provided will be pre-filled on the invoice.
platform_id:
integer
Is an optional parameter where you can select on what blockchain (platform) the particular digital asset is expected to be received. By default (if the parameter is empty) the system will generate the invoice on the NATIVE blockchain (Binance chain for BNB, Bitcoin chain for BTC, Ethereum chain for ETH, etc.) or on Ethereum blockchain for Tokens (BUSD, DAI USDT, etc.). For more information about available blockchains (platforms) see [here](https://developer.coingate.com/docs/platforms). For more information about blockchain (platform) availability for different currencies see [here](https://developer.coingate.com/docs/currencies).

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, etc 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. You can find out which payment currencies can be used using this list: https://api.coingate.com/v2/currencies?native=true&enabled=true&merchant_pay=true