Byteball開発者向け情報wiki

このAPIは、Byteballキャッシュバックプログラムに参加している加盟店および支払い処理業者用に提供されています。
お客様からの支払いを受け入れた後、このAPIを使用してお客様のキャッシュバックをリクエストします。

まずリクエストは以下のURLに送信します。
メインネット：https://byte.money/new_purchase
テストネット：https://byte.money/test/new_purchase

次にパラメーターは以下の値を渡します

パラメーター名	型	説明
partner	string	あなたがプログラムにサインアップしたときに割り当てられたパートナー名
partner_key	string	リクエストの認証に使用されるパートナーキー
customer	string	データベースに顧客名やIDなどの購入を行った顧客のID。 このフィールドは、同じ顧客が別の購入をした場合に同じでなければなりません。
order_id	string	購入に関連付けられた注文の一意のID。 同じ注文IDのキャッシュバックを再度要求しないでください。
description	string	購入の説明
merchant	string	このフィールドは、支払プロセッサーによってのみ個々のマーチャントを識別するために使用されます。 同じ商人から別の購入が行われた場合、これは同じでなければなりません。
address	string	顧客のバイトボールアドレスまたは電子メールアドレス。 キャッシュバックはこのアドレスに送られます。 電子メールアドレスの場合は、テキストコインが送信されます。 テキストコインが1週間以内に顧客に開かれない場合、報酬は戻ってしまいます。
currency	string	購入に使用された通貨。 サポートされている通貨：USD、EUR、RUR、GBYTE、BTC。 購入が他の通貨で支払われた場合は、その額をサポートされている通貨のいずれか(GBYTEを除く)の金額に換算する必要があります。
currency_amount	number	購入額
partner_cashback_percentage	number	通常のキャッシュバックに加えて、自分の資金から顧客に支払う金額の割合。 Byteballは、ディストリビューションファンド（マーチャントマッチ）から同じパーセンテージを追加します。 デフォルトは0(追加の支払いなし)です。このオプションに資金を提供するには、事前に資金を入金しなければなりません。
purchase_unit	string	(GBYTE支払い時のみ)支払い時のトランザクションID

レスポンスはJSON形式です。
常にresultコンテナに含まれており、'ok'か’error’を返します。

キャッシュバックが顧客に正常に送信された場合、レスポンスは「"result": "ok"」となりキャッシュバックの額とユニットが以下の様に返信されます。

{"result":"ok","cashback_amount":101318,"unit":"kYbc5KGKB/KnjynYePEF4cpumKmOz22xVKSVWbmtZ0M="}

エラーの場合はレスポンスが「"result": "error"」となり、「error」フィールドに詳細が記されます。

{"result":"error","error":"authentication failed"}