API

API一覧

API共通事項

エンドポイントURL
https://bitflyer.jp/
  • APIのレスポンスデータは、特に断りのない場合を除き、 JSON(※1)形式の文字列とします。
  • リクエスト時のパラメータや、レスポンスデータ内において、日時を表現するために ISO 8601(W3C-DTF)形式(※2)の文字列を用います。タイムゾーンは JST で固定。フォーマットは“yyyy-mm-dd hh:mm:ss”。
  • レスポンスを正常に返せない場合は、200以外のステータスを返します。レスポンスボディはアプリ側で無視するものとします。
  • ドキュメントに書かれていないプロパティが追加されている場合があります。
  • レスポンスがJSONになっているAPIについて、プロパティの任意性が「任意」の場合、値がnullになっているか、プロパティが存在しない場合があります。
  1. JSON(JavaScript Object Notation) 参考: http://www.json.org/json-ja.html(外部サイト)
  2. ISO 8601 (W3C-DTF) 形式 参考: http://www.w3.org/TR/NOTE-datetime(外部サイト),http://www.kanzaki.com/docs/html/dtf.html(外部サイト)

レート取得

  • bitFlyerのビットコインレート値を返します。

認証

なし

リクエスト

GET /api/echo/price

レスポンス

{
    "mid" : 41022,
    "ask" : 41812,
    "bid" : 40233
}
  • mid
    int型
    必須
    仲値
  • ask
    int型
    必須
    bitFlyerの1BTC販売価格
  • bid
    int型
    必須
    bitFlyerの1BTC買取価格

Echo要求

  • メールアドレスかBFアカウントID(例:BF10-1234-5678-90)を指定してコインの送付を行います。
  • コインが足りない場合は自動チャージすることができます。

認証

APIキー

リクエスト

POST /api/echo/send

パラメータ

{
    "apikey" :  "ady4q4565wear23rag",
    "shop_id" : "BF90-1111-1111-11",
    "email" : "user@bitflyer.com",
    "account_id" : "BF10-1111-1111-11",
    "amount" : 1000000,
    "auto_charge" : 100000000,
    "name" : "ビット太郎",
    "external_transaction_id" : "A1230000001"
}
  • apikey
    string型
    必須
    ショップごとに発行した認証キー。
  • shop_id
    string型
    必須
    コインの支払い側となるショップのアカウントID。
  • email
    string型
    必須
    コイン送付先顧客メールアドレス。
  • account_id
    string型
    必須
    コイン送付先BF顧客ID。
  • amount
    number型
    必須
    支払いBTC。単位はsatoshi(1億分の1BTC)。
  • auto_charge
    number型
    任意
    コインが足りない場合に自動コイン買いを行うコイン数。単位はsatoshi。0であれば自動チャージはしない。
  • name
    string型
    任意
    メールに記載するお客様名。
  • external_transaction_id
    string型
    任意
    ショップ独自のトランザクションID(注文番号等)

レスポンス

{
    "status": 0,
    "tracking_id" : "892c5fbd-bf40-488c-b606-75b349cbc023",
    "auto_charge_price" : 50123
}
  • status
    int型
    必須
    0: 呼び出し成功。マイナスの場合はエラー。詳細はエラーコード一覧を参照。
  • tracking_id
    string型
    必須
    EchoごとにユニークなID。あとでトラッキングをするのに使う。
  • auto_charge_price
    int型
    任意
    自動チャージをした場合、その約定価格が入る。自動チャージしない場合やstatusが0でない場合は0が入る。

状態取得

  • リクエストの状態を取得します。

認証

APIキー

リクエスト

POST /api/echo/getstatus

パラメーター

{
    "apikey" : "ady4q4565wear23rag",
    "shop_id" : "BF90-1111-1111-11",
    "tracking_id" : "892c5fbd-bf40-488c-b606-75b349cbc023",
    "external_transaction_id" : "1230000001"
}
  • apikey
    string型
    必須
    ショップごとに発行した認証キー。
  • shop_id
    string型
    必須
    コインの支払い側となるショップのアカウントID。
  • tracking_id
    string型
    必須
    sendecho時に発行されたID。
  • external_transaction_id
    string型
    必須
    sendecho時に指定されたexternal_transaction_id。

レスポンス

{
    "status" : 0,
    "tracking_id" : "892c5fbd-bf40-488c-b606-75b349cbc023",
    "auto_charge_price" : 50123
}
  • status
    int型
    必須
    0: 呼び出し成功。マイナスの場合はエラー。詳細はエラーコード一覧を参照。
  • tracking_id
    string型
    必須
    EchoごとにユニークなID。後でトラッキングをするのに使う。
  • auto_charge_price
    int型
    任意
    自動チャージをした場合、その約定価格が入る。自動チャージしない場合やstatusが0でない場合は0が入る。

エラーコード一覧

1
処理中
0
Echo処理成功
-100
アカウントが特定できない
-101
残高不足
-102
メールアドレス不正
-103
ショップが特定できない
-104
external_transaction_id重複(ただし)
-105
tracking_idが不正で特定できない
-106
external_transaction_idが不正で特定できない
-107
tracking_idもexternal_transaction_idも指定されていない
-200
amountが不正
-201
auto_chargeが不正
-202
auto_chargeがamountより小さい
-800
ユーザがアカウントを作成しなかったので払い戻し済み
-999
そのほかエラー