支払い情報を設定する
[ステップ4/9] このステップでは、支払い情報を設定し、購入者への請求方法を指定します。このステップの最後に、トランザクション処理のために購入者を一意の amazonRedirectUrl にリダイレクトできるようになります。
1. 支払い情報の設定
Update Checkout Session を呼び出して、支払い情報（注文金額）とトランザクションメタデータを設定します。checkoutResultReturnUrlパラメータを使用して、購入者がホストするページで決済が完了した後に購入者がリダイレクトされる先となるURLを指定します。
Note: Amazon Payボタンをレンダリングしたドメインと異なる場合は、使用する予定のcheckoutReviewReturnUrlドメインをセラーセントラルに追加する必要があります。詳細については、セラーセントラルへのドメイン追加をご覧ください。
chargeAmount を、決済で設定した paymentIntent に沿って設定します。決済の完了後に追加の支払いを行うために注文を分割する必要がある場合は、オプションの totalOrderAmount パラメータを使用して、そこに注文の全額を設定します。
リクエスト
リクエストボディ
{
"webCheckoutDetails": {
"checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
},
"paymentDetails": {
"paymentIntent": "AuthorizeWithCapture",
"canHandlePendingAuthorization":false,
"softDescriptor": "Descriptor",
"chargeAmount": {
"amount": "1",
"currencyCode": "USD"
}
},
"merchantMetadata": {
"merchantReferenceId": "Merchant reference ID",
"merchantStoreName": "Merchant store name",
"noteToBuyer": "Note to buyer",
"customInformation": "Custom information"
}
}
リクエストパラメータ
| 名前
|
ロケーション
|
説明
|
| checkoutSessionId (必須) Type: string |
Path parameter
|
Checkout Session識別子
|
| webCheckoutDetails Type: webCheckoutDetails |
Body
|
事業者から提供された決済結果のURL。トランザクションの完了後、Amazon PayはこのURLにリダイレクトします 変更可否: 購入者が amazonPayReturnUrlにリダイレクトされるまで回数制限なし
|
| paymentDetails Type: paymentDetails |
Body
|
購入者に請求する金額や方法など、販売者が指定した支払いの詳細 変更可否: 購入者が amazonPayReturnUrlにリダイレクトされるまで回数制限なし
|
| merchantMetadata Type: merchantMetadata |
Body
|
事業者から提供された外部の注文詳細 変更可否: 購入者が amazonPayReturnUrlにリダイレクトされるまで回数制限なし
|
| platformId Type: string |
Body
|
ソリューションプロバイダー（SP）の事業者識別子 SPのみがこのフィールドを使用します。 変更可否: 購入者が amazonPayReturnUrlにリダイレクトされるまで回数制限なし
|
| providerMetadata Type: providerMetadata |
Body
|
決済サービスプロバイダー（PSP）によって作成されたトランザクション識別子 PSPのみがこれらのフィールドを使用します。 変更可否: 購入者が amazonPayReturnUrlにリダイレクトされるまで回数制限なし
|
レスポンス
{
"checkoutSessionId": "ada3f397-7d4b-4a55-abac-786685c02d8b",
"webCheckoutDetails": {
"checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
"checkoutResultReturnUrl": "https://a.com/merchant-confirm-page",
"checkoutCancelUrl": null,
"amazonPayRedirectUrl": "https://pay.amazon.com/redirect/checkoutId-1"
},
"productType": "PayAndShip",
"paymentDetails": {
"paymentIntent": "AuthorizeWithCapture",
"canHandlePendingAuthorization": false,
"chargeAmount": {
"amount": "1",
"currencyCode": "USD"
},
"totalOrderAmount": null,
"softDescriptor": "Descriptor",
"presentmentCurrency": "USD",
"allowOvercharge": null,
"extendExpiration": null
},
"merchantMetadata": {
"merchantReferenceId": "Merchant reference ID",
"merchantStoreName": "Merchant store name",
"noteToBuyer": "Note to buyer",
"customInformation": "Custom information"
},
"supplementaryData": null, // Amazon Pay system data
"buyer": {
"buyerId": "buyerId",
"name": "name-1",
"email": "name@amazon.com",
"phoneNumber": "800-000-0000",
"primeMembershipTypes": null
},
"billingAddress":{
"name": "Work",
"addressLine1": "440 Terry Ave",
"addressLine2": "",
"addressLine3": "",
"city": "Seattle",
"county": "King",
"district": "Seattle",
"stateOrRegion": "WA",
"postalCode": "98121",
"countryCode": "US",
"phoneNumber": "800-000-0000"
},
"paymentPreferences": [
{
"paymentDescriptor": "Visa ****1111 (Amazon Pay)"
}
],
"statusDetails": {
"state": "Open",
"reasonCode": null,
"reasonDescription": null,
"lastUpdatedTimestamp": "20191015T195703Z"
},
"shippingAddress": { // Null for PayOnly product type
"name": "Susie Smith",
"addressLine1": "10 Ditka Ave",
"addressLine2": "Suite 2500",
"addressLine3": null,
"city": "Chicago",
"county": null,
"district": null,
"stateOrRegion": "IL",
"postalCode": "60602",
"countryCode": "US",
"phoneNumber": "800-000-0000"
},
"platformId": null,
"chargePermissionId": null,
"chargeId": null,
"constraints": [],
"creationTimestamp": "20191015T195655Z",
"expirationTimestamp": "20191016T195655Z",
"storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
"deliverySpecifications": {
"specialRestrictions": ["RestrictPOBoxes"],
"addressRestrictions": {
"type": "Allowed",
"restrictions": {
"US": {
"statesOrRegions": ["WA"],
"zipCodes": ["95050", "93405"]
},
"GB": {
"zipCodes": ["72046", "72047"]
},
"IN": {
"statesOrRegions": ["AP"]
},
"JP": {}
}
}
},
"providerMetadata": {
"providerReferenceId": null
},
"releaseEnvironment": "Sandbox"
}
2. AmazonPayRedirectUrlにリダイレクト実施
すべての必須パラメータが提供されるまで、Update Checkout Session レスポンスには、Constraint object が含まれます。必須パラメータは次のとおりです。
checkoutResultReturnUrlchargeAmount-paymentIntentがConfirmかつRecurringMetadataが設定される場合は任意となります。それ以外のケースでは0以外の値を設定する必要があります。paymentIntent
constraintsがなくなると、レスポンスは一意のamazonPayRedirectUrlを返却します。決済を完了するには、購入者をそのURLにリダイレクトします。