残高照会

現在の API Key が属するアプリの利用可能残高を照会するために使用します。照会するアプリは API Key によって決定されるため、リクエストでアプリ ID を渡す必要はありません。

リクエスト URL

GET https://otp.api.engagelab.cc/v1/balance

認証

API 認証の実行方法については、認証 を参照してください。

リクエスト例

リクエストヘッダー

              
              GET /v1/balance HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

リクエストパラメータ

リクエストパラメータはありません。

レスポンスパラメータ

成功レスポンス

              
              {
    "currency": "USD",
    "balance": "123.4500",
    "gift_balance": "1.0000",
    "total_balance": "124.4500"
}

            

フィールド説明

1. 金額はすべて文字列の小数であり、小数点以下 4 桁を保持します。この設計は、浮動小数点数の転送および解析中の精度エラーを回避するためです。解析には高精度の小数型（各言語の BigDecimal / Decimal など）を使用し、直接浮動小数点数として計算しないでください。
2. 通貨: 現在、すべてのアプリは米ドル（USD）で決済されます。
3. 残高がマイナスになる可能性があります: 当座貸越枠を有効にしているアプリの場合、当座貸越後に balance / total_balance がマイナス値（"-12.3400" など）を返すことがあり、未払いであることを示します。時間内にチャージしてください。
4. total_balance は、サーバーによって同じ瞬間に一貫して計算され、表示および照合に直接使用できます。

失敗レスポンス

HTTP ステータスコードが 4xx または 5xx の場合、レスポンスボディには以下のフィールドが含まれます。

              
              {
    "code": 2001,
    "message": "invalid token"
}

            

エラーコード