支払い用ボタンの生成 - ビットコイン決済APIドキュメント

リクエスト先

POST https://coincheck.com/api/ec/buttons

作成されたボタンの例

支払い用ボタンの使い方

coincheck paymentでのビットコイン決済は、全てこのボタンを通じて行われます。このボタンは一般的に、支払い方法を選び、注文の確認、そして購入確定ボタンを押した次のページに設置されます。

ボタンを設置するには、サーバー側でこのAPIに対し、注文の合計金額（日本円）とコールバックURL等の情報を送信し、ボタンのHTMLタグ button[html_tag] を受け取ります（認証が必要です）。そのHTMLタグを含んだページを生成し、購入者に表示をします。

購入者がボタンをクリックすると、2種類の支払い方法が提示されます。

1つ目は通常のビットコインのトランザクションを使って支払いをする方法です。購入者は送付先のビットコインのアドレス、ビットコインの量が示されます。そのアドレスに指定されたビットコインを送付し、{{minConfirmation}} confirmation に達することで決済が完了します。1 confirmation に対して約10分が必要であるため、約30分後に完了します。

2つ目はcoincheckのウォレットを使って支払いをする方法です。購入者が coincheck のアカウントを持っており、ビットコインを指定された量より所有している場合利用できます。coincheck内でのビットコインの受け渡しとなるため、{{minConfirmation}} confirmation を待たずとも、約1分で決済完了状態になります。

システムイメージ図

① 支払い用ボタンのAPIを使い、注文の合計金額等を送信（リクエスト）

② ボタンに関するレスポンスを返答

③ button[html_tag] をページに埋め込み、ユーザーにボタンを表示

④ ユーザーがビットコインを送金

⑤ 送金されたビットコインを取得し、正しく送金されているか確認

⑥ ①で指定されたURLへコールバックをPOST

リクエストサンプル

# Request
POST https://coincheck.com/api/ec/buttons
{
  "button": {
    "name": "注文 #123",
    "currency": "JPY",
    "display_currency": "JPY",
    "amount" : 5000,
    "callback_url": "http://www.example.com/coincheck/callback",
    "success_url": "http://www.example.com/order/complete",
    "max_times": 1,
    "include_name": true,
    "include_email": true,
    "include_address": false,
    "custom": "123",
    "notify_mispayment": true
  }
}

# Response
{
  "success": true,
  "button": {
    "name": "注文 #123",
    "currency": "JPY",
    "display_currency": "JPY",
    "amount" : 5000,
    "callback_url": "http://www.example.com/coincheck/callback",
    "success_url": "http://www.example.com/order/complete",
    "max_times": 1,
    "html_tag": "<script>...</script><a src="...">...</a>",
    "url": "https://coincheck.com/checkouts/...",
    "include_name": true,
    "include_email": true,
    "include_address": false,
    "custom": "123",
    "notify_mispayment": true
  }
}
  

リクエストパラメーター

レスポンス

レスポンスはJSONで返します。

コールバック

コールバックURLは購入者がビットコインの送付をしたとき、承認済みの状態になったときに呼ばれます。ビットコインの送付をしたときは未承認（unconfirmed）な状態であるため、基本的には決済完了状態にしない方が良いでしょう。その後、承認状態になるともう一度コールバックURLにPOSTします。その際に、決済完了状態にし発送処理などを進めると良いです。

承認の条件は、アドレスを使って支払いをした場合は、 {{minConfirmation}} confirmation になることです。coincheckのウォレットを使い支払った場合は、即時に承認されます。

また、コールバック先URLには、注文番号などを設定しておくことで、コールバックが呼ばれた時にスムーズに注文状況を更新できます。
（例）コールバックURL : https://www.example.com/coincheck/callback?order_id=123

コールバックの内容

コールバックは指定されたURLにHTTP(HTTPS) POSTでリクエストされます。

  {
    "order": {
      "id": "ABC123abc",
      "button_name": "注文 #15",
      "total_native": {
        "amount": 1080,
        "currency": "JPY"
      },
      "total_btc": {
        "amount": 0.1,
        "currency": "BTC"
      },
      "created_at": "2014-09-03 09:50:01 UTC",
      "confirmed_at": "2014-09-03 10:20:01 UTC",
      "status": "received",
      "custom": "15",
      "customer": {
        "name": "和田 晃一良",
        "email": "test@gmail.jp",
        "address": "東京都渋谷区東4-4-6"
      }
    }
  }
  

コールバックの署名

コールバックにはcoincheckから送信されたことを保証するために署名を送信しています。

HTTP Headerとして送信しており、ヘッダー名は COINCHECK-SIGNATURE です。

署名は、"コールバックのリクエストボディ + コールバックの署名キー" のSHA256ハッシュです。

署名キーはショップ情報編集で設定でき、デフォルトでランダムな値が入力されています。

たとえばリクエストボディが hoge=true 、署名キーが foo である場合、署名は、 hoge=truefoo のSHA256ハッシュ 9894eb87846ac2f0acc1b75c644752656968ec4f3001622090b962efea3efc5c になります。

コールバックのリトライ

コールバックには、レスポンスコードとして 200 を返して下さい。

そうでないレスポンスが帰ってきた場合は、コールバックを再度送信いたします。

再度送信する場合のスケジュールは以下のとおりになります。( 4 ^ n 秒後に送信します。 )

• 初回送信
• 4秒後
• 16秒後
• 1分後
• 4分後
• 17分後
• 1時間後
• 5時間後
• 18時間後
• 3日後

決済失敗時のコールバック

決済失敗時に指定のURLに対してPOSTリクエストを送信ます。

送信されるデータの説明は以下のページによりご参照ください。

コールバックのテスト送信

coincheck paymentではテスト環境を用意しておりませんが、コールバックをテストでお送りすることができます。

以下のフォームに必要事項を入力し、送信ボタンを押して下さい。

coincheck paymentにログインした状態でのみ利用できます。