残高照会
アカウント残高照会
リクエストURL
GET /v1/balance
認証
HTTP基本認証 を使用します。HTTPヘッダーにAuthorizationを追加してください：
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
このコードブロックはフローティングウィンドウ内に表示されます
上記の base64_auth_string の生成アルゴリズム：base64(dev_key:dev_secret)
リクエスト例
リクエストヘッダー
GET /v1/balance HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
GET /v1/balance HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
このコードブロックはフローティングウィンドウ内に表示されます
リクエストボディ
なし
リクエストパラメータ
なし
レスポンスパラメータ
成功レスポンス
| フィールド | 型 | オプション | 説明 |
|---|---|---|---|
| balance10000 | Integer | 必須 | 通常残高、10000を掛けた整数値 |
| gift_balance10000 | Integer | 必須 | 贈与残高、10000を掛けた整数値 |
| balance | Number | 必須 | 通常残高、浮動小数点型 |
| gift_balance | Number | 必須 | 贈与残高、浮動小数点型 |
| total_balance10000 | Integer | 必須 | 合計残高、通常残高と贈与残高の合計、10000を掛けた整数値 |
| total_balance | Number | 必須 | 合計残高、通常残高と贈与残高の合計、浮動小数点型 |
{
"balance10000": 123456,
"gift_balance10000": 20000,
"balance": 12.3456,
"gift_balance": 2,
"total_balance10000": 143456,
"total_balance": 14.3456
}
{
"balance10000": 123456,
"gift_balance10000": 20000,
"balance": 12.3456,
"gift_balance": 2,
"total_balance10000": 143456,
"total_balance": 14.3456
}
このコードブロックはフローティングウィンドウ内に表示されます
呼び出し側は浮動小数点の精度問題を避けるため、balance10000、gift_balance10000、total_balance10000 フィールドを優先的に使用して残高をフォーマットすることを推奨します。
失敗レスポンス
HTTPステータスコードが4xxまたは5xxの場合、レスポンスボディには以下のフィールドが含まれます：
| フィールド | 型 | オプション | 説明 |
|---|---|---|---|
| code | int | 必須 | エラーコード、詳細は エラーコード を参照 |
| message | String | 必須 | エラー詳細 |
{
"code": 2001,
"message": "invalid token"
}
{
"code": 2001,
"message": "invalid token"
}
このコードブロックはフローティングウィンドウ内に表示されます
エラーコード
| エラーコード | HTTP Code | 説明 |
|---|---|---|
| 1000 | 500 | 内部エラー、後で再試行してください |
| 2001 | 401 | 認証失敗、正しいtokenが提供されていない、またはtokenに対応するマーチャントが存在しない |
| 2002 | 401 | 認証失敗、tokenの有効期限が切れているか、無効化されている |
| 2002 | 403 | マーチャントが削除されている |
