{"_id":"5aecd74e0c435b00035860e5","project":"5530bfac57cea10d00a3aa3b","version":{"_id":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","__v":3,"createdAt":"2018-04-22T17:06:32.152Z","releaseDate":"2018-04-22T17:06:32.152Z","categories":["5adcc1185cd1890003da8166","5adcc1185cd1890003da8167","5adcf4b3ce4b3f00035317e9","5adfb8e9452bd900036d115b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"5adcc1185cd1890003da8167","version":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-18T18:14:59.726Z","from_sync":false,"order":2,"slug":"orders","title":"Private"},"user":"5530bf7457cea10d00a3aa3a","githubsync":"","__v":19,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-05-04T21:57:34.102Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"code":"curl -H \"Authorization: Token YOUR_APP_TOKEN\" -X POST -d \"pay_currency=BTC\" https://api.coingate.com/v2/orders/140043/checkout","language":"curl"}]},"results":{"codes":[{"name":"","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}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Order does not exist\",\n    \"reason\": \"OrderNotFound\"\n}","language":"json","status":422}]},"settings":"5adcc50db719b20003516400","auth":"required","params":[{"_id":"5aecd74e0c435b00035860e6","ref":"","in":"body","required":true,"desc":"In which currency invoice should be paid. Possible values: *BTC*, *LTC*, *ETH*, *BCH*.","default":"","type":"string","name":"pay_currency"},{"_id":"5aed6a250bd4db0003052076","ref":"","in":"path","required":false,"desc":"CoinGate order ID","default":"","type":"int","name":"id"}],"url":"/orders/:id/checkout"},"isReference":false,"order":1,"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 or BCH 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.","excerpt":"Placing [created order](doc:create-order) with pre-selected payment currency (BTC or LTC). Display payment_address and pay_amount for shopper or redirect to payment_url. Can be used to White-Label invoices","slug":"checkout","type":"endpoint","title":"Checkout"}

postCheckout

Placing [created order](doc:create-order) with pre-selected payment currency (BTC or LTC). Display payment_address and pay_amount for shopper or redirect to payment_url. Can be used to White-Label invoices

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
integer
CoinGate order ID

Body Params

pay_currency:
required
string
In which currency invoice should be paid. Possible values: *BTC*, *LTC*, *ETH*, *BCH*.

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 or BCH 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.