Amazon インセンティブ API - エラーとモックエラー

連携技術仕様 - エラーとモックエラー

インセンティブ API のエンドポイントは、障害の種類別に整理されたエラーを生成する可能性があります。モックエラーコードを使用してこれらのエラーをシミュレーションして、ユーザーのプログラムをテストすることもできます。

エラーコードクラス
- 最も一般的なエラーコードと原因
ログイン＆レシーブエラー
その他すべてのエンドポイントエラー
モックエラーコード
モックコードを使用したシナリオのテスト
モックテストの例
- requestId=F0000 でのモックテストに成功しました
- requestId「F2005」のモックテストが失敗しました
F500 - 不明なエラー

エラーコードクラス

エラーを表示するために、コードの規約を使用しています。たとえば、原因がクライアント側にある場合、API は F2xx エラーを返し、問題が Amazon システムの問題によるものであれば F1XX で応答します。一般に、エラーコードは、次の表のように変換されます。

エラーコード	説明
F100	Amazon 内部エラー
F200	F200：無効なリクエストエラー (リクエストペイロードに誤りがある)
F300	アカウント関連のエラー (通常、オンボーディング、認証、アクセス関連の問題などによる)
F400	再試行可能エラー (一時的な問題)。エラー処理を参照してください
F500	不明なエラー

最も一般的なエラーコードと原因

共通エラーコード	一般的な原因
F200	`The request signature we calculated does not match the signature you provided.Check your AWS Secret Access Key and signing method.Consult the service documentation for details` アクセスキーとシークレットキーが一致しません。
F300	`Insufficient Funds` ギフトカードの作成、有効化、またはギフトカードへの残高ロードのために十分なクレジットまたは資金がありません。
F300	`ActiveContractNotFound` 作成、アクティブ化、または残高ロードを行う有効な契約がありません。
F400	`SystemTemporarilyUnavailable` これは再試行可能なエラーです。元のリクエスト ID をキャンセル/非アクティブ化/無効にし、作成/アクティブ化/BalanceLoad APIを再送信することができます。

F100 - システムエラー

エラーコード = F100、モックエラーリクエスト ID = F1000の一般的なエラー

SimpleAmountIsNull
AmountIsNull
CurrencyCodeIsNull
GcLocked
EmptyCardInfoList
RequestError

F200 - パートナー入力エラー

すべてのパートナー入力エラーに対して、エラーコード = F200。

エラー	メッセージとモックエラー ID
`InvalidRequestInput`	リクエスト本文が nulll ですモック： F2000
`InvalidCardNumberInput`	カード番号を null または空にすることはできませんモック： F2001
`InvalidPartnerIdInput`	パートナー ID は null または空にできませんモック： F2002
`InvalidAmountInput`	金額を null にすることはできませんモック： F2003
`InvalidAmountValue`	金額は 0 より大きくなければなりませんモック： F2004
`InvalidCurrencyCodeInput`	通貨コードを null または空にすることはできませんモック： F2005
`InvalidRequestIdInput`	リクエスト ID を null または空にすることはできませんモック： F2006
`CardNumberNotFound`	カード番号が見つかりませんモック： F2007
`RequestedDenominationMismatch`	ErrorType – PreDenominationMismatch 事前単位の不一致 - カードは異なる単位で作成されましたモック： F2008
`CardActivatedWithDifferentDenomination`	カードはすでに別の単位で有効化されていますモック： F2009
`CardActivatedWithDifferentRequestId`	カードはすでに別のリクエスト ID で有効化されていますモック： F2010
`ActivationNotAllowed`	ErrorType – InvalidCardStatusForActivation 現在のカードのステータスはアクティベーションには無効ですモック： F2011
`DeactivationNotAllowed`	ErrorType – InvalidCardStatusForDeactivation 現在のカードのステータスはアクティベーション解除には無効ですモック： F2012
`ActivationRequestIdAlreadyBeenUsed`	アクティベーションリクエスト ID は既に使用されていますモック： F2013
`NegativeOrZeroAmount`	マイナスの金額またはゼロの金額モック： F2014
`MaxAmountExceeded`	最大金額を超過しましたモック： F2015
`CurrencyCodeMismatch`	通貨コードの不一致モック： F2016
`FractionalAmountNotAllowed`	端数の金額は許可されていませんモック： F2017
`NonExistingActivationRequestId`	アクティベーションリクエスト ID が一致しませんモック： F2018
`WrongActivationRequestId`	アクティベーションリクエスト ID が間違っていますモック： F2019
`GcRTPNotAllowed`	ErrorType – GeneralError 一般的なエラーモック： F2020
`RequestIdTooLong`	リクエスト ID が長すぎます。許容される最大長は 40 ですモック： F2021
`RequestIdMustStartWithPartnerName`	リクエスト ID はパートナー名で開始する必要がありますモック： F2022
`CardNumberTooShort`	ErrorType – InvalidCardNumber 無効なカード番号モック： F2023
`CardNumberCheckSumError`	ErrorType – InvalidCardNumber 無効なカード番号モック： F2023
`InvalidGCIdInput`	GC ID を null または空にすることはできませんモック： F2024
`InvalidRequest`	GC ID を null または空にすることはできませんモック： F2025
`MaxPageSizeExceeded`	最大ページサイズを超えましたモック： F2026
`InvalidPageSize`	無効なページサイズモック： F2027
`InvalidPageIndex`	無効なページインデックスモック： F2028
`InvalidStartDate`	無効な開始日モック： F2029
`InvalidEndDate`	無効な終了日モック： F2030
`StartDateAfterEndDate`	終了日より後の開始日モック： F2031
`InvalidDateFormat`	無効な日付形式モック： F2032
`ExternalReferenceTooLong`	外部参照が長すぎますモック： F2042
`CancelRequestArrivedAfterTimeLimit`	作成からの経過時間が長すぎるため、キャンセルを処理できませんモック： F2047
`ProgramIdNotPresent`	プログラム ID が存在しませんモック： F2048

F300 - パートナーアカウント/アクセス/オンボーディングエラー

すべてのパートナーアカウント、アクセス、およびオンボーディングエラーに対して、エラーコード = F300。

エラー	メッセージとモックエラー ID
`InvalidPartnerId`	無効なパートナー ID モック： F3000
`InvalidAccessKey`	無効なアクセスキーモック： F3001
`AccessDenied`	アクセスが拒否されましたモック： F3002
`IssuanceCapExceeded`	発行上限を超過しましたモック： F3004
`InsufficientFunds`	資金が不足していますモック： F3003
`GeneralError`	一般的なエラーモック： F3005
`AccountHasProblems`	ErrorType – GeneralError 一般的なエラーモック： F3005
`OrderNotFound`	ErrorType – GeneralError 一般的なエラーモック： F3005
`WrongGcOrderSource`	ErrorType – GeneralError 一般的なエラーモック： F3005
`WrongGcOrderType`	ErrorType – GeneralError 一般的なエラーモック： F3005
`GcOrderBelongToOtherCustomer`	ErrorType – GeneralError 一般的なエラーモック： F3005
`OperationNotPermitted`	操作は許可されていませんモック： F3006
`BadInput`	入力データが間違っていますモック： F3007
`APIGetGiftCardActivityPageIsDisabled`	ErrorType – GeneralError GeneralError モック： F3008
`ActiveContractNotFound`	有効な契約が見つかりませんモック： F3009
`InvalidProgramId`	プログラム ID が Amazon システムに存在しませんモック： F3010
`ProgramIsNotApproved`	ErrorType – InvalidProgramId プログラムは承認されていませんモック： F3011

その他すべてのエンドポイントエラー

エラータイプエラーコード/ モックコード	説明
`GeneralError` F100 / F1000	Amazon 内部エラー
`BalanceLoadCannotBeVoided` F100 / F1001	Amazon の内部エラーのため、ロードバランスを無効にすることができません
`InvalidRequestInput` F200 / F2000	リクエスト本文が null です
`InvalidPartnerIdInput` F200 / F2002	partnerId は null にできません
`InvalidAmountInput` F200 / F2003	金額を null にすることはできません
`InvalidAmountValue` F200 / F2004	金額は 0 より大きくなければなりません
`InvalidCurrencyCodeInput` F200 / F2005	通貨コードを null にすることはできません
`InvalidRequestIdInput` F200 / F2006	loadBalanceRequestId は null にできません
`MaxAmountExceeded` F200 / F2015	金額が国内市場セグメントで許容される最大値を超えています (例：米国で500ドル)
`FractionalAmountNotAllowed` F200 / F2017	通貨では端数を使用できません (例：JP)
`RequestIdTooLong` F200 / F2021	loadBalanceRequestId が 40 文字を超えています
`RequestIdMustStartWithPartnerName` F200 / F2022	loadBalanceRequestId は partnerId で始まる必要があります
`InvalidAccountType` F200 / F2033	リクエストで提供されたアカウントタイプは未定義です
`UndefinedAccountId` F200 / F2034	リクエストで指定された AccountId は、Amazon システムには存在しません
`AccountIdNotInValidStatus` F200 / F2035	AccountId が、リクエストされた操作に対して有効なステータスではありません (例：AccountId が非アクティブです)
`InvalidCurrencyInMarketplace` F200 / F2036	AccountId が作成される国の市場セグメントで通貨コードがサポートされていません
`AmountBelowMinThreshold` F200 / F2037	金額が最低必要金額を下回っています
`LoadBalanceRequestIdAlreadyUsed` F200 / F2038	ロード API で提供された loadBalanceRequestId は既に使用されています (たとえば、指定された loadBalanceRequestId の冪等性チェックが失敗した場合)。
`LoadBalanceRequestIdDoesNotExist` F200 / F2039	無効な API で提供された loadBalanceRequestId の Load リクエストは存在しません
`RequestMismatchFromLoadRequest` F200 / F2040	void リクエストで渡されたパラメータが Load リクエストのパラメータと一致しません
`BalanceLoadCannotBeVoided` F200 / F2041	ロードバランスが使われ、voidIfUsed フラグが false の場合
`ExternalReferenceTooLong` F200 / F2042	使用される値が Unicode 文字の最大文字数を超えています
`NotificationMessageTooLong` F200 / F2043	notificationDetails パラメータで使用される値が 250 文字 (Unicode) を超えています
`SourceIdTooLong` F200 / F2044	sourceID フィールドで使用されている値が、Unicode 文字の最大文字数 (40 文字) を超えています
`BalanceLoadCannotBeVoided` F200 / F2045	残高を無効にすることができません。リクエストが制限時間以降に到着しました
`InvalidPartnerId` F300 / F3000	API リクエストで使用される partnerId は、Amazon システムには存在しません
`InvalidAccessKey` F300 / F3001	リクエストに署名するために使用されるセキュリティアクセスキーが Amazon システムに存在しません (中国では適用されません)
`InvalidAccessKey` F300 / F3001	API リクエストの署名に使用されるアクセスキー (中国) が Amazon システムに存在しません
`AccessDenied` F300 / F3002	アカウントがブロックされています
`InsufficientFunds` F300 / F3003	アカウントにリクエスト金額を発行するのに十分な資金がありません (各パートナーには一定の購入可能限度額が与えられ、パートナーは購入可能限度額までの残高のみを発行できます。購入可能限度額は、パートナーが支払いを行うとリセットされます)
`IssuanceCapExceeded` F300 / F3004	指定した期間内に契約で定義された残高発行限度額に達しました
`OperationNotPermitted` F300 / F3006	リクエストは拒否されます。パートナーに API を呼び出す権限がありません (Amazon Balance Load ディストリビューター以外のパートナーが、オンボーディング前に Amazon Balance Load API を呼び出そうとすると発生します)
`ActiveContractNotFound` F300 / F3009	パートナーアカウントの設定が完了していません
`CustomerSurpassedDailyVelocityLimit` F300 / F3010	顧客が 1 日の速度制限を超えています
`CustomerAccountBlocked` F300 / F3011	この Amazon アカウントはこのトランザクションの実行を許可されていません
`SystemTemporarilyUnavailable` F400 / F4000	Amazon システムは一時的に利用できません。注：レスポンスステータスは再送信であり、失敗ではありません。エラー処理を参照してください
`GeneralError` F500 / F5000	不明なエラー

モックエラーコード

エラー状態をシミュレーションして、ユーザーのプログラムのパスを完全にテストすることができます。次の表は、特定のエラー状態をシミュレーションするためにオペレーションに渡すことができるモックコードを示しています。エラー状態をシミュレーションするには、操作リクエストの *requestId フィールドにモックコードを渡します。

注：すべての操作がすべてのモックコードをサポートしているわけではありません。

モックコードとエラー名	備考
F2000 - InvalidRequestInput
F2001 - InvalidCardNumberInput
F2002 - InvalidPartnerIdInput
F2003 - InvalidAmountInput
F2004 - InvalidAmountValue	Amount must be greater than 0
F2005 - InvalidCurrencyCodeInput
F2006 - InvalidRequestIdInput
F2007 - CardNotFound
F2008 - RequestedDenominationMismatch
F2009 - CardActivatedWithDifferentDenomination
F2010 - CardActivatedWithDifferentRequestId
F2011 - ActivationNotAllowed
F2012 - DeactivationNotAllowed
F2013 - ActivationRequestIdAlreadyBeenUsed
F2014 - NegativeOrZeroAmount
F2015 - MaxAmountExceeded	金額が国内市場セグメントで許容される最大値を超えています (例：米国で500ドル)
F2016 - CurrencyCodeMismatch
F2017 - FractionalAmountNotAllowed	この通貨では使用できない端数 (例：JP)
F2018 - NonExistingActivationRequestId
F2019 - WrongActivationRequestId
F2020 - GcNotReadyForRefund
F2021 - RequestIdTooLong	リクエスト ID が 40 文字を超えています
F2022 - RequestIdMustStartWithPartnerName
F2023 - CardNumberTooShort
F2024 - InvalidGCIdInput
F2025 - InvalidRequest
F2026 - MaxPageSizeExceeded
F2027 - InvalidPageSize
F2028 - InvalidPageIndex
F2029 - InvalidStartDate
F2030 - InvalidEndDate
F2031 - StartDateAfterEndDate
F2032 - InvalidDateFormat
F2033 - InvalidAccountType	リクエストで提供されたアカウントタイプは未定義です
F2034 - UndefinedAccountId	リクエストで指定された AccountId は、Amazon システムには存在しません
F2035 - AccountIdNotInValidStatus	AccountId が、リクエストされた操作に対して有効なステータスではありません (例：AccountId が非アクティブです)
F2036 - InvalidCurrencyInMarketplace
F2037 - AmountBelowMinThreshold
F2038 - LoadBalanceRequestIdAlreadyUsed	ロード API で提供された loadBalanceRequestId は既に使用されています (たとえば、指定された loadBalanceRequestId の冪等性チェックが失敗した場合)。
F2039 - LoadBalanceRequestIdDoesNotExist
F2040 - RequestMismatchFromLoadRequest	void リクエストで渡されたパラメータが Load リクエストのパラメータと一致しません
F2041 - BalanceLoadCannotBeVoided	ロードバランスが使われ、voidIfUsed フラグが false の場合
F2042 - ExternalReferenceTooLong
F2043 - NotificationMessageTooLong	notificationDetails パラメータで使用される値が 250 文字 (Unicode) を超えています
F2044 - SourceIdTooLong	sourceID フィールドで使用されている値が、Unicode 文字の最大文字数 (40 文字) を超えています
F2045 - BalanceLoadCannotBeVoidedDueToTimeout
F2046 - InvalidPhoneNumber
F2047 - CancelRequestArrivedAfterTimeLimit
F2048 - ProgramIdNotPresent
F3000 - UnknownCustomer
F3001 - InvalidAwsAccessKeyId
F3002 - BlockedCustomer
F3003 - InsufficientFunds	アカウントにリクエスト金額を発行するのに十分な資金がありません (各パートナーには一定の購入可能限度額が与えられ、パートナーは購入可能限度額までの残高のみを発行できます。購入可能限度額は支払い時にリセットされます)
F3004 - IssuanceCapExceeded	指定した期間内に契約で定義された残高発行限度額に達しました
F3005 - AccountHasProblems
F3006 - OperationNotPermitted	リクエストは拒否されます。パートナーに API を呼び出す権限がありません (Amazon Balance Load ディストリビューター以外のパートナーが、オンボーディング前に Amazon Balance Load API を呼び出そうとすると発生します)
F3007 - BadInput
F3008 - APIGetGiftCardActivityPageIsDisabled
F3009 - ActiveContractNotFound	アカウントの設定が完了していません
F3010 - CustomerSurpassedDailyVelocityLimit
F3011 - CustomerAccountBlocked	この Amazon アカウントはこのトランザクションの実行を許可されていません
F3012 - ProductTypeNotEnabledInTheContract
F3013 - InvalidProgramId
F3014 - ProgramIsNotApproved
F4000 - GCSharpTimeout	Amazon システムは一時的に利用できません。注：レスポンスステータスは「再送信」であり、失敗ではありません。エラー処理を参照してください
F5000 - UnknownError

モックコードを使用したシナリオのテスト

API の成功とエラーレスポンスは、モックリクエストを送信することによってテストすることができます。成功レスポンスは、モックコード F0000を使用して模倣することができます。エラーレスポンスは、エラーコード表で提供されるモックエラーコードを使用して模倣することができます。

モックリクエストはアカウントタイプ 0 を使用し、アカウント ID はモック (エラー) コードです。たとえば、LoadAmazonBalance API で成功レスポンスのモックリクエストを送信するには、アカウント ID F0000を使用します。

モックリクエストの例

<LoadAmazonBalanceRequest>
    <account>
        <id>F0000</id>
        <type>0</type>
    </account>
    <partnerId>PartnerUS</partnerId>
    <amount>
        <currencyCode>USD</currencyCode>
        <value>4570</value>
    </amount>
    <loadBalanceRequestId>PartnerUSrequestId1</loadBalanceRequestId>
    <timestamp>1464933146000</timestamp>
    <transactionSource>
        <sourceId>12344332</sourceId>
        <institutionId>A1234</institutionId>
        <sourceDetails>{"institutionName": "Test Merchant"}</sourceDetails>
    </transactionSource>
</LoadAmazonBalanceRequest>

モックレスポンスの例

<LoadAmazonBalanceResponse>
    <account>
        <id>F0000</id>
        <type>0</type>
    </account>
    <amount>
        <currencyCode>USD</currencyCode>
        <value>4570</value>
    </amount>
    <status>SUCCESS</status>
    <loadBalanceRequestId>PartnerUSrequestId1</loadBalanceRequestId>
</LoadAmazonBalanceResponse>

モックエラー：

次のリクエストモック UndefinedAccountId エラー：

モックリクエスト

<LoadAmazonBalanceRequest>
    <account>
        <id>F2034</id>
        <type>0</type>
    </account>
    <partnerId>PartnerUS</partnerId>
    <amount>
        <currencyCode>USD</currencyCode>
        <value>4570</value>
    </amount>
    <loadBalanceRequestId>PartnerUSrequestId1</loadBalanceRequestId>
    <timestamp>1464933146000</timestamp>
    <transactionSource>
        <sourceId>12344332</sourceId>
        <institutionId>A1234</institutionId>
        <sourceDetails>{"institutionName": "Test Merchant"}</sourceDetails>
    </transactionSource>
</LoadAmazonBalanceRequest>

エラーレスポンス

<LoadAmazonBalanceException>
    <errorCode>F200</errorCode>
    <errorType>UndefinedAccountId</errorType>
    <errorMessage>AccountId provided in request does not exist in Amazon system</errorMessage>
    <status>FAILURE</status>
</LoadAmazonBalanceException>

モックテストの例

requestId=F0000 でのモックテストに成功しました

ペイロード

<CreateGiftCardRequest>
    <creationRequestId>F0000</creationRequestId>
    <partnerId>Awssb</partnerId>
    <value>
        <currencyCode>phonybucks</currencyCode>
        <amount>-3.14159</amount>
    </value>
</CreateGiftCardRequest>

ハッシュ化されたペイロード

7ea6c536e7586fb525f49aaeb4fd3c6971a696f125da6447d12d29a1973fb004

正規リクエスト

POST
/CreateGiftCard
accept:charset=UTF-8
content-type:charset=UTF-8
host:agcod-v2-gamma.amazon.com
x-amz-date:20140205T170041Z
x-amz-target:com.amazonaws.agcod.AGCODService.CreateGiftCard
accept;content-type;host;x-amz-date;x-amz-target
7ea6c536e7586fb525f49aaeb4fd3c6971a696f125da6447d12d29a1973fb004

ハッシュ化された正規リクエスト

0d1c6d7d24f929697e7eae8edae3405d8185c93ccbef2ca5bd098eaa10be42fb

署名する文字列

AWS4-HMAC-SHA256
20140205T170041Z
20140205/us-east-1/AGCODService/aws4_request
0d1c6d7d24f929697e7eae8edae3405d8185c93ccbef2ca5bd098eaa10be42fb

派生した署名キー

07ef165a0531f64ac7ba835805728d63c296be4d0012a226454795f74644aa02

署名

bf772d6fd53ae30f0439e6362e7a9b9dd570893d5db66950d6bbcb72a0a08da3

エンドポイント

agcod-v2-gamma.amazon.com

署名済みリクエスト

POST /CreateGiftCard HTTP/1.1
accept:charset=UTF-8
content-type:charset=UTF-8
host:agcod-v2-gamma.amazon.com
x-amz-date:20140205T170041Z
x-amz-target:com.amazonaws.agcod.AGCODService.CreateGiftCard
Authorization:AWS4-HMAC-SHA256 Credential=AKIAJBYCL67O6NJUNYBQ/20140205/us-east-1/AGCODService/aws4_request, SignedHeaders=accept;content-type;host;x-amz-date;x-amz-target, Signature=bf772d6fd53ae30f0439e6362e7a9b9dd570893d5db66950d6bbcb72a0a08da3
<CreateGiftCardRequest>
    <creationRequestId>F0000</creationRequestId>
    <partnerId>Awssb</partnerId>
    <value>
        <currencyCode>phonybucks</currencyCode>
        <amount>-3.14159</amount>
    </value>
</CreateGiftCardRequest>

requestId「F2005」のモックテストが失敗しました