アカウント残高の取得

API認証情報に対応するアカウントの残高、通貨、支払条件の値を取得します。これは残高の照会であり、入金や注文は行いません。

リクエスト

サーバー側のAPI認証情報を使用し、HTTPSで通信してください。各例では認証情報を環境変数から読み込みます。実際に使用できる認証情報は含まれていません。status.codeをJSON本文で確認し、HTTPステータスも確認してください。これらの従来のハンドラーは、アプリケーションエラーに対して必ずしもHTTPエラーステータスを設定するわけではありません。

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/getbalance"

パスパラメーター、クエリパラメーター、本文のパラメーターはいずれも不要です。

レスポンス

これはレスポンスの構造を示す例であり、アカウントのデータや現在の価格の見積もりではありません。

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}

残高レスポンスのフィールド
フィールド	意味
`balance`	保存されているアカウント残高です。金額を扱う際は、小数の精度を維持してください。
`currency`	このアカウントに保存されている通貨の値です。
`terms`	アカウントに保存されている支払条件の値です。このハンドラーは、この値が取り得る値の列挙や正規化を行いません。この例が取り得る値をすべて網羅していると考えないでください。

エラーと利用上の注意

認証に失敗した場合は、API共通の認証レスポンスが使用されます。このハンドラーには、残高が存在しない場合の個別のエラーやページネーションは定義されていません。残高が返されても資金が確保されるわけではなく、その後の注文の成功を保証するものでもありません。