一般的なデータタイプとレスポンス
これらのフィールドは、Account Information API と Points Bank API の両方の複数の操作で使用されます。
金額
取引によって影響を受けるロイヤルティリワードを示す変数。
| フィールド | 説明 | サンプル値 | 必須/必須ではない |
|---|---|---|---|
value | ロイヤルティリワードの金額 (ポイント、マイル、またはその他のプログラム通貨) | 100.00 | 必須 |
currency | リワードの利用に使用された通貨 (CAD、USD、ポイント、マイルなど) | USD | 必須 |
DeclineReason
取引が拒否される理由。顧客に表示するカスタムメッセージを追加することもできます。
| reasonCode | 説明 | HTTP ステータスコード |
|---|---|---|
ACCOUNT_INELIGIBLE | 現在の利用リクエストの対象とならないアカウント | 200 |
ACCOUNT_NOT_FOUND | 利用のためのアカウントが見つからない | 200 |
COULD_NOT_FIND_THE_ORIGINAL_TRANSACTION | 元の取引が見つからない | 200 |
DUPLICATE_TRANSACTION | 過去に利用リクエストを受けたことがある | 200 |
INSUFFICIENT_BALANCE | ユーザーのアカウントの残高不足 | 200 |
INVALID_AMOUNT | 利用金額が無効 | 200 |
INVALID_PROMO_ID | 利用プロモーション ID が無効 | 200 |
エラー
ロギングや調査に役立つエラーに関する情報。
エラーレスポンス
| フィールド | 説明 |
|---|---|
status | エラーステータス |
requestId | 一意のリクエスト識別子 |
errorCode | エラーコード (値はエラーコードの表を参照) |
errorMessage | カスタムエラーメッセージ |
additionalInfoMap | キーと値のペアのリスト |
エラーコード
| エラーコード | HTTP ステータスコード |
|---|---|
ACCOUNT_NOT_FOUND | 4xx |
AUTH_FAILED | 4xx |
BAD_REQUEST | 4xx |
INTERNAL_CONFIGURATION_ISSUE | 5xx |
INVALID_ACCOUNT | 4xx |
INVALID_CREDENTIALS | 4xx |
REQUEST_IN_PROGRESS | 5xx |
RESOURCE_NOT_FOUND | 4xx |
TIMEOUT_ERROR | 5xx |
TIMEOUT_ERROR_CODE | 5xx |
UNKNOWN_ERROR_CODE | 5xx |