Report APIでダウンロードするレポートのサンプルと項目について
Amazon Pay Report APIでは決済とトランザクションのレポートを取得することができます。
ほぼ全てのレポートは本番のみで取得可能なため、参考情報としてサンプルファイルとファイル内の項目を以下にご紹介します。
Settlement Report - 決済レポート
決済サイクルに応じてAmazonで生成するレポートです。事業者自身がレポートを作成することはできませんが、APIを使用してダウンロードすることは可能です。
なお、Sandboxでは事業者による決済レポートの作成が可能です。
- ダウンロードしたサンプルレポートファイル
- ファイルに含まれる項目は こちら
ファイルに含まれるTransactionTypeに関する補足:
- Authorization: 日本は対象外のためレポートに含まれません。ただし、Sandboxでレポート生成するとAuthorizationが含まれますのでご注意ください。
- Dispute: 日本は対象外のためレポートに含まれません。
- Adjustment: 例:（１）チャージバックで事業者責任となったがあとで同額を補填したケース（２）手数料の間違いなどで調整したケース (3) Refund Failureで返金マイナス処理できずに、マニュアルで残高調整するケース 等。
- Carryover: 例：振込処理が完了できずに次回の支払周期に持ち越されるケースや、アカウントをHoldしたケースにおいて振り込みがされずに残高が残るケース等
Transaction Report トランザクションレポート
Order Reference - AmazonリファレンスID
OneTimeではCharge Permission単位、RecurringではCharge単位での注文番号や決済金額、お届け先情報に関するレポートです。
事業者がCreateReport API実行時にreportType=GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATAを指定すると作成されるレポートです。
このレポートは本番のみで作成可能です。
- ダウンロードしたサンプルレポートファイルはこちら
- ファイルに含まれる項目は以下のとおりです。
| 項目名 | 値の例 | 補足説明 |
|---|---|---|
| AmazonOrderReferenceId | P03-1555510-7560755 | OneTimeの chargePermissionId または Recurringの chargeIdの最初の19桁の値が表示されます |
| SellerOrderId | Order123 | merchantMetadata.merchantReferenceIdにセットしたものが表示されます |
| OrderTotal | 200 | 決済金額が表示されます |
| CurrencyCode | JPY | 日本ではJPYとなります |
| SellerNote | Note | merchantMetadata.noteToBuyer にセットした値が表示されます |
| DestinationCity | 日本では使用しない項目です | |
| DestinationDistrictOrCounty | 日本では使用しない項目です | |
| DestinationStateOrRegion | 東京都 | productType=PayAndShipの場合に発送先のStateOrRegionが表示されます |
| DestinationPostalCode | 153-0064 | productType=PayAndShipの場合に発送先のPostalCodeが表示されます |
| DestinationCountryCode | JP | productType=PayAndShipの場合に発送先のCountryCodeが表示されます |
| StoreName | AmazonPayデモショップ | merchantMetadata.storeName に値をセットしている場合はその値が表示されます。値をセットしていない場合はセラーセントラルに登録されている出品者情報「表示名」が表示されます。 |
| CustomInformation | 事業者様情報 | merchantMetadata.customInformation にセットした値が表示されます |
| OrderReferenceStatus | Open | Open/Suspended/Cancelled/Closedの4つのステータスがあります。 各ステータスをCV2のCharge Permissionのステータスに置き換えると次のとおりです。 Open=Chargeable、Suspended=NonChargeable、Cancelled=Closed、Closed=Closed |
| LastUpdateTimestamp | 2023-09-06T08:59:24 +0900 | 最終更新日時のタイムスタンプが表示されます |
| ReasonCode | Charge Permissionの理由コードがある場合に表示されます。 Amazon Pay CV2 Charge Permissionの理由コードがCV1 Order Referenceの理由コードに変換されて表示されます |
|
| ReasonDescription | ReasonCodeに関する詳細がある場合に表示されます | |
| CreationTimestamp | 2023-09-06T08:59:23 +0900 | 生成日時のタイムスタンプが表示されます |
| ExpirationTimestamp | 2024-03-04T08:59:23 +0900 | 有効期限のタイムスタンプが表示されます |
| AmazonPaymentsCountryCode | JP | 日本ではJPとなります |
| BillingAgreementId | B03-0538394-4007414 | Recurringの場合にchargePermissionIdの値が表示されます |
Billing Agreement - お支払い方法設定ID
Recurring（継続払い）のCharge Permissionに関するレポートです。
事業者がCreateReport API実行時にreportType=GET_FLAT_FILE_OFFAMAZONPAYMENTS_BILLING_AGREEMENT_DATAを指定すると作成されるレポートです。
このレポートは本番のみで作成可能です。
- ダウンロードしたサンプルレポートファイルはこちら
- ファイルに含まれる項目は以下のとおりです。
| 項目名 | 値の例 | 補足説明 |
|---|---|---|
| AmazonBillingAgreementId | B03-0000000-0000001 | RecurringのchargePermissionIdが表示されます |
| SellerReferenceId | Order12345 | merchantMetadata.merchantReferenceId にセットした値が表示されます |
| SellerNote | Note | merchantMetadata.noteToBuyer にセットした値が表示されます |
| DestinationCity | 日本では使用しない項目です | |
| DestinationDistrictOrCounty | 日本では使用しない項目です | |
| DestinationStateOrRegion | 東京都 | productType=PayAndShipの場合に発送先のStateOrRegionが表示されます |
| DestinationPostalCode | 153-0064 | productType=PayAndShipの場合に発送先のPostalCodeが表示されます |
| DestinationCountryCode | JP | productType=PayAndShipの場合に発送先のCountryCodeが表示されます |
| StoreName | AmazonPayデモショップ | merchantMetadata.storeName に値をセットしている場合はその値が表示されます。値をセットしていない場合はセラーセントラルに登録されている出品者情報「表示名」が表示されます。 |
| CustomInformation | 事業者様情報 | merchantMetadata.customInformation にセットした値が表示されます |
| BillingAgreementStatus | Suspended | Draft/Open/Suspended/Canceled/Closedの4種類が表示されます。 Amazon Pay CV2 Charge Permissionの状態がCV1 Billing Agreementの状態に変換されて表示されます |
| LastUpdateTimestamp | 2023-09-05T17:36:21 +0900 | 最終更新日時のタイムスタンプが表示されます |
| ReasonCode | InvalidPaymentMethod | Charge Permissionの理由コードがある場合に表示されます。 Amazon Pay CV2 Charge Permissionの理由コードがCV1 Billing Agreementの理由コードに変換されて表示されます |
| ReasonDescription | ReasonCodeに関する詳細がある場合に表示されます。 | |
| CreationTimestamp | 2022-09-30T14:40:41 +0900 | 生成日時のタイムスタンプが表示されます |
Authorization - オーソリ処理
OneTimeおよびRecurringのCharge（オーソリ、仮売上）に関するレポートです。
事業者がCreateReport API実行時にreportType=GET_FLAT_FILE_OFFAMAZONPAYMENTS_AUTHORIZATION_DATAを指定すると作成されるレポートです。
このレポートは本番のみで作成可能です。
- ダウンロードしたサンプルレポートファイルはこちら
- ファイルに含まれる項目は以下のとおりです。
| 項目名 | 値の例 | 補足説明 |
|---|---|---|
| AmazonAuthorizationId | P03-0000000-0000001-A000001 | chargeId のCをAに変更した値が表示されます |
| AuthorizationReferenceId | 1693958365187 | いくつかのパターンがあります - ECサイトの決済セッション中にオーソリを取得した場合はCharge Permission IDに 「-0」といった文字が追加された値となります（例: P03-1786929-3255592-0）- 事業者がCreateCharge APIを実行してオーソリを行った場合は idempotencyKeyがセットされます。- 事業者がセラーセントラルで「売上請求する」のオペレーションを実行し売上請求と同時にオーソリを生成した場合は AUTHORIZE_n5FN0xz4zifk7AAJIX18のようにAUTHORIZE_という文字の後ろにランダム英数字の文字がセットされます。 |
| AmazonOrderReferenceId | P03-0000000-0000001 | OneTimeの chargePermissionId または Recurringの chargeIdの最初の19桁の値が表示されます |
| AuthorizationAmount | 600 | Charge金額が表示されます |
| CurrencyCode | JPY | 日本ではJPYとなります |
| SellerAuthorizationNote | Order12345 | merchantMetadata.merchantReferenceIdにセットしたものが表示されます |
| AuthorizationStatus | Pending | Pending/Open/Declined/Closedの4種類が表示されます。 各ステータスをAmazon Pay CV2 Chargeの状態に置き換えると以下のとおりです。 Pending = AuthorizationInitiated、Open = Authorized、Declined = Declined、Closed (reason code = MaxAmountCaptured ) = Captured、Closed (other reason codes) = Canceled |
| LastUpdateTimestamp | 2023-09-06T08:59:27 +0900 | 最終更新日時のタイムスタンプが表示されます |
| ReasonCode | MaxCapturesProcessed | オーソリの理由コードがある場合に表示されます。 Amazon Pay CV2 Chargeの理由コードがCV1 Aurthorizeの理由コードに変換されて表示されます |
| ReasonDescription | ReasonCodeに関する詳細がある場合に表示されます。 | |
| CreationTimestamp | 2023-09-06T08:59:25 +0900 | 生成日時のタイムスタンプが表示されます |
| ExpirationTimestamp | 2023-10-06T08:59:25 +0900 | オーソリの有効期限タイムスタンプが表示されます |
| AmazonPaymentsCountryCode | JP | 日本ではJPとなります |
Capture - 売上請求処理
Capture（売上請求、実売上）に関するレポートです。
事業者がCreateReport API実行時にreportType=GET_FLAT_FILE_OFFAMAZONPAYMENTS_CAPTURE_DATAを指定すると作成されるレポートです。
このレポートは本番のみで作成可能です。
- ダウンロードしたサンプルレポートファイルはこちら
- ファイルに含まれる項目は以下のとおりです。
| 項目名 | 値の例 | 補足説明 |
|---|---|---|
| AmazonCaptureId | P03-1555510-7560755-C020894 | chargeId の値が表示されます |
| CaptureReferenceId | 1693958365187 | いくつかのパターンがあります - ECサイトの決済セッション中にオーソリを取得した場合は P03-1786929-3255592-v2のような値となります- 事業者がCaptureCharge APIを実行して売上請求を行った場合は idempotencyKeyがセットされます。- 事業者がセラーセントラルで「売上請求する」のオペレーションを実行し、売上請求と同時にオーソリを生成した場合は AUTHORIZE_n5FN0xz4zifk7AAJIX18のようにAUTHORIZE_という文字の後ろにランダム英数字の文字がセットされます（AuthorizationレポートのAuthorizationReferenceIdと同じものがセットされます）。- 事業者がセラーセントラルで「売上請求する」のオペレーションを実行し、売上請求のみが行われた場合は CAPTURE_uJclm9XyztvK9RjP7OsVのようにCAPTURE_という文字の後ろにランダム英数字の文字がセットされます。 |
| AmazonAuthorizationId | P03-1555510-7560755-A020894 | chargeId のCをAに変更した値が表示されます |
| AmazonOrderReferenceId | P03-1555510-7560755 | OneTimeの chargePermissionId または Recurringの chargeIdの最初の19桁の値が表示されます |
| CaptureAmount | 200 | 売上請求した金額が表示されます |
| CurrencyCode | JPY | 日本ではJPYとなります |
| SellerCaptureNote | EPI_b001_2023-09-06T08:59:13.450 | 事業者がセラーセントラルで「売上請求する」のオペレーションを実行する際に 理由（任意） に入力した値が表示されます |
| CaptureStatus | Completed | Pending/Declined/Completed/Closedの4種類が表示されます。 各ステータスをAmazon Pay CV2 Chargeの状態に置き換えると以下のとおりです。 Pending = CaptureInitiated、Completed = Captured、Declined = Declined、Closed = Completed |
| LastUpdateTimestamp | 2023-09-06T08:59:25 +0900 | 最終更新日時のタイムスタンプが表示されます |
| ReasonCode | | 売上請求の理由コードがある場合に表示されます。 Amazon Pay CV2 Chargeの理由コードがCV1 Captureの理由コードに変換されて表示されます |
| CreationTimestamp | 2023-09-06T08:59:25 +0900 | 生成日時のタイムスタンプが表示されます |
| AmazonPaymentsCountryCode | JP | 日本ではJPとなります |
Refund - 返金処理
Refund（返金）に関するレポートです。
事業者がCreateReport API実行時にreportType=GET_FLAT_FILE_OFFAMAZONPAYMENTS_REFUND_DATAを指定すると作成されるレポートです。
このレポートは本番のみで作成可能です。
- ダウンロードしたサンプルレポートファイルはこちら
- ファイルに含まれる項目は以下のとおりです。
| 項目名 | 値の例 | 補足説明 |
|---|---|---|
| AmazonRefundId | P03-0597038-9689789-R064912 | refundIdの値が表示されます |
| RefundReferenceId | REFUND_3vgWkQq5Gx7nR8w4hWom | いくつかのパターンがあります - 事業者がCreateRefund APIを実行してオーソリを行った場合は idempotencyKeyがセットされます。- 事業者がセラーセントラルで「返金する」のオペレーションを実行した場合は REFUND_3vgWkQq5Gx7nR8w4hWomのようにREFUND_という文字の後ろにランダム英数字の文字がセットされます。 |
| AmazonCaptureId | P03-0597038-9689789-C058226 | chargeIdの値が表示されます |
| AmazonOrderReferenceId | P03-0597038-9689789 | OneTimeの chargePermissionId または Recurringの chargeIdの最初の19桁の値が表示されます |
| RefundAmount | 600 | 返金した金額が表示されます |
| CurrencyCode | JPY | 日本ではJPYとなります |
| SellerRefundNote | 事業者がセラーセントラルで「返金する」のオペレーションを実行する際に 理由（任意） に入力した値が表示されます |
|
| RefundType | SellerInitiated | 基本的にSellerInitiatedが表示されます |
| RefundStatus | Completed | Pending/Declined/Completedの3種類が表示されます。 各ステータスをAmazon Pay CV2 Refundの状態に置き換えると以下のとおりです。 Pending = RefundInitiated、Completed = Refunded、Declined = Declined |
| LastUpdateTimestamp | 2023-09-06T08:59:25 +0900 | 最終更新日時のタイムスタンプが表示されます |
| ReasonCode | 返金のの理由コードがある場合に表示されます。 Amazon Pay CV2 Refundの理由コードがCV1 Refundの理由コードに変換されて表示されます |
|
| CreationTimestamp | 2023-09-06T08:59:25 +0900 | 生成日時のタイムスタンプが表示されます |
| AmazonPaymentsCountryCode | JP | 日本ではJPとなります |
関連するタグ