Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation

About Amazon Pay

General information about Amazon Pay

Amazon Pay provides buyers with a secure, trusted, and convenient way to sign in and pay for their purchases on your site by using their Amazon credentials. See browser support for information about the operating systems, browsers and browser versions that Amazon Pay supports.

This guide provides an overview of the buyer experience and shows you how to integrate with the latest checkout technology from Amazon Pay.

The Amazon Pay checkout experience

  1. The buyer clicks on the Amazon Pay button to start checkout.
  2. The buyer signs in, confirms their preferred payment instrument, and optionally selects a shipping address on the Amazon Pay-hosted page.
  3. The buyer is redirected back to your order review page for confirmation.
  4. The buyer completes checkout on the Amazon Pay-hosted page by responding to the multi-factor authentication (identity validation) challenge, if prompted, or by selecting another payment method if payment was declined.
  5. Amazon Pay redirects the buyer back to your confirmation page.


Further information you will find also on the:

On this page

Table of Contents


Configuration for Amazon Pay

There are two options that can be used depending if you are a new or an existing customer.

Existing Customers

Already existing customers need to login to their accounts and create a new set of API keys to be used with Amazon Pay Checkout version.2.

We already have the needed data for your accounts done for the original checkout v.1.

Please see below the "Guide to create API keys".

On this page

Table of Contents

New Customer

Before using Amazon Pay you need to register at https://pay.amazon.de/signup  

An alternative is also the signup for Amazon based on country, the steps are the;

  • follow the above URL
  • choose the country needed, based on the country flag found at the top-right:


When logged in in the Amazon seller central, you should have 2 accounts, that you can toggle between:

  • Sandbox
  • Production

The needed data for the onboarding are the following:

Amazon Cv.2Comment
Country Code*Code of the Amazon market used (DE=EU, UK, JP and US)
MerchantIDtaken from Amazon seller central
MWS Authorization TokenExample: amzn.mws.a4a8d852-3d9e-f441-0674-d042baa3cf6452
merchant Store NameName of the store
StoreIDExample: amzn1.application-oa2-client.7150fff45acf49f8acd519fa485142a2
  • If you have more than one market this information needs to be given to us for each market needed.


Please follow the guide below to create the API keys necessary.

Important: If you don´t see the option to create the API keys, you need to create a store first and then create the API keys.

Under the "Integration central" at the bottom you can do this using the link found there:


MWS Authorization Token

One of the important piece of data needed is the MWS Authorization token from Amazon which gives

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
permission to conduct transactions for your shop.

The second step is generating a MWS Auth Token. This is the data needed:

  • Developer name: Computop Ltd
  • Developer account number: 8662-2365-9858

Guide

When logged in to the seller central of Amazon, go to the top right-hand side of the page and click on Settings and choose "User Permissions":

This leads you to the "User permissions" page which show you the current users, here you can add an external developer to your account, here please click on "Visit manage your apps":

This leads you to a new page were you can see developers that have access, here you can add, delete and renew permissions. Please click on "Authorise new developer":

On the new page you need to add the developer name and ID given above. Fill in the information and click on "Next":

The last page is were you need to agree to the terms and conditions of granting a developer access to the account.

When clicking on "Next", you are shown a success page with information:

With the last click on "Next", you are led back to the original "User Permission" were the developer is now shown:

Here you can now click on "View" and access the "MWS Authorization token" and can also copy it.

Then submit the received MWS Authorisation Token on a secure way to

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
for configuration.


Guide to create API keys

In order to create new API keys, choose one of your accounts, either Production or Sandbox on top of the page, process needs to be done for both accounts. Amazon description is found here.


Please click left-hand side on the symbol with the 3 horizontal lines. 

On the menu that appears, please go to "Integration" and choose "Integration central". 

On the Integration central, go to the section "Create API Keys" and click on the button there. 

A Pop-up window appears where you need to choose "Generate API Credentials", here you also need to give the keys a unique name: 

The newly created keys are immediately visible on the "Integration central". There you choose the option to "See Details": 

When looking at the details, you can see the data or download the data in JSON format: 

JSON example:

Important

  • This data is needed for your onboarding and needs to be sent in a secure way to
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNameHelpdesk-Name
    PageWithExcerptWording
    for configuration.
  • The same process needs to be repeated for the second account depending on which one you did first

Notify URL

Customers will need to also to store/configure the following

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
notify URL.

URL: 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
amazonpaycomplete.aspx

Go to the menu on the te top left-hand side:


On the menu that appears, please go to "Integration" and choose "MWD Access Key":


At the bottom of the page you can see the option for IPN (Instant Payment notification":

After clicking on the blue link another pages open with integration settings: 


Here please click on the "Edit"-button: 

  1. Here please add the fowllowing URL to the integrator URL and click on the "Update"-button

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
amazonAPAV2Notify.aspx

      2. The merchant can also save his own notify URL if he so wishes.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
will ask for the NotifyURL on the request as well.

Important: Please make sure to use the Notifies sent via server to server and not only rely on the SuccessURLs/FailureURLs.



Steps within the process

The basic payment process with Amazon consists of several steps:


Step

Description

1

Display Amazon Pay button

The Amazon Pay button must be properly implemented on the page of the webshop and must be called for each payment process. You can find below the example code snippet.

2

Initialize payment via amazonCv2.aspx (Server to Server)

You will call

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
endpoint
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
amazonapa.aspx according to description below.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
will respond with parameters that you must use to update the Amazon Pay button.

3

Redirect to Amazon

After updating the Amazon Pay button, customer will be redirected to Amazon.

4

Redirect back to your webshop

After confirming customer's preferred payment instrument, and optionally shipping address on the Amazon Pay-hosted page, customer is redirected back to your webshop order review page.

5

Finalize the purchase

After customer confirms the order, you will redirect the client to Amazon URL received in response from

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
.

6Redirect back to your webshopAfter customer finalizes the payment at Amazon side, customer will be redirected back to your defined URL based on result of payment (URLSuccess / URLFailure).
7

Notify from

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
is sent via S2S

Please make sure to setup and use the notifyURL to get final confirmation on the requests success/failure
Important

Please make sure that you plan in the 2 main tasks for merchants:

  1. Add the new Amazon Cv.2 Button (Step 1)
  2. On the redirect back to the shop (Step 3) were changes may take place, merchant needs to make sure that address (if applicable) and payment method, can be changed. Also the possibility of changes to the amount should be pass with a call to the
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording


Integrate Amazon Pay button

The following example code shows how to integrate the Amazon Pay button in your webshop.

When customer submits this button, you will call

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
to obtain additional data, which are required for updating the Amazon Pay button.

Multiexcerpt
MultiExcerptNamebutton_widget
Code Block
languagejs
var amazonPayButton = amazon.Pay.renderButton('#AmazonPayButton', {

   merchantId: 'xxxxx',
   publicKeyId: 'SANDBOX-xxxxxxxxxx', 
   ledgerCurrency: 'EUR',          
   checkoutLanguage: 'en_GB', 
   productType: 'PayAndShip', 
   placement: 'Cart',
   buttonColor: 'Gold'
});

amazonPayButton.onClick(function(){
  const [payload, signature, publicKeyId] = your_call_to_paygate();
  
  amazonPayButton.initCheckout({
    createCheckoutSessionConfig: { 
      payloadJSON: payload,
      signature: signature,
      publicKeyId: publicKeyId
    }
  });
});


In this case the following parameters must be present within the Button:

Parameter

Description

Value

merchantId

SellerId issued by Amazon


ledgerCurrency

Your ledger currency. For  EU/UK accounts a different presentment currency can be used on the auth/capture


Permissible values:

  • US merchants - 'USD'
  • EU merchants - 'EUR'
  • UK merchants - 'GBP'
  • JP merchants - 'JPY'
placementPlacement of the button

Permissible values:

Cart

buttonColor

The parameter buttonColor defines the color of the button


Permissible values:

Gold, LightGray, DarkGray

productType

The parameter productType defines if the transaction is done for physical or digital goods. PayAndShip is default.


Permissible values:

  • PayAndShip - Physical goods
  • PayOnly - Digital goods

checkoutLanguage

The parameter checkoutLanguage is optionally used for defining the language of the checkout process. This is helpful especially within a multilingual shop environment.

Without submitting the parameter Language Amazon automatically uses the most suitable language for checkout.

Permissible values:

  • US merchants - 'en_US'
  • EU/UK merchants - 'en_GB', de_DE', 'fr_FR', 'it_IT', 'es_ES'
  • JP merchants - 'ja_JP'


estimatedOrderAmount

This is the estimated checkout order amount, it does not have to match the final order amount if the buyer updates their order after starting checkout. Amazon Pay will use this value to assess transaction risk and prevent buyers from selecting payment methods that can't be used to process the order 

Use updateButtonInfo() to update the estimatedOrderAmount if the estimated order amount changes; for example, if the buyer removes or adds something to their cart. This function may update the button UI and the new estimatedOrderAmount will be used to determine whether the order meets the installment provider’s minimum order price threshold.

Example of the function

<script type="text/javascript" charset="utf-8">
         amazonPayButton.updateButtonInfo({"amount":"120.99","currencyCode":"USD"});
</script>

Example:

{ "amount": "50.99", "currencyCode":"USD"},

Further information can be found in the documentation from Amazon Pay.


Review Page

When using the complete checkout of Amazon Pay v2, the review page is to be used on the side of the merchant to allow:

  • change of address
  • change of payment method

A change of either one or both is possible.

Review Page Example


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording

Computop

Data

This is the Computop

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
data that is delivered to the merchant for the review page

  • mid
  • PayID
  • XID
  • TransID
  • Status=REQUEST
  • Code=0
  • AmountAuth=0
  • AmountCap=0
  • AmountCred=0
  • bdaddrstreet2
  • bdaddrcity
  • bdaddrcountrycode
  • bdaddrname
  • bdphonenumber
  • bdaddrzip
  • AddrStreet
  • AddrCity
  • AddrCountryCode
  • addrname
  • phonenumber
  • AddrZip
  • addrstate
  • amazonmerchantid
  • rtf=onetime
  • amazonstatus=Open
  • amazonpayredirecturl
  • amazoncheckoutsessionid
  • amazonpaymentdescriptor

JSON example

This is an example on the JSON that merchants can use to accomodate changes if necessary

Code Block
languagejson
let session = document.getElementById('sessionId').value;
let link = document.getElementById('redirectUrl').value;
let buyNow = document.getElementById('buy-now');
buyNow.addEventListener('click', () => {
  window.location = link;
})
amazon.Pay.bindChangeAction('#change-paymethod', {
  amazonCheckoutSessionId: session,
  changeAction: 'changePayment'
});
amazon.Pay.bindChangeAction('#change-shipping', {
  amazonCheckoutSessionId: session,
  changeAction: 'changeAddress'
});


The Amazon description can be found here:

https://developer.amazon.com/de/docs/amazon-pay-checkout/display-shipping-payment-info.html#2-enable-shipping-and-payment-updates



Process flow chart

  • Version with possibly changes done to delivery address, payment instrument or amount.
  • Valid for OTP (One time payments) or for Recurring setup (RTF=I)


Multiexcerpt
MultiExcerptNameprocessflow


Image Removed

draw.io Diagram

Recurring SubsequentmultiexcerptMultiExcerptName

border

true

diagramName

processflow_recurring

Image Removed

Subsequent actions

Capture a payment

Multiexcerpt
MultiExcerptNameprocessflow_capture

Image Removed

AmazonPay_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

Recurring Subsequent

Credit a payment

Multiexcerpt
MultiExcerptNameprocessflow_creditrecurring

Image Removed

draw.io Diagram
bordertrue
diagramNameAmazonPay_recurring_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

Subsequent actions

Capture a payment

Multiexcerpt
MultiExcerptNameprocessflow_capture

draw.io Diagram
bordertrue
diagramNameAmazonPay_capture_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

Credit a payment

Multiexcerpt
MultiExcerptNameprocessflow_credit

draw.io Diagram
bordertrue
diagramNameAmazonPay_credit_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

Reverse an order

Multiexcerpt

Reverse an order

Multiexcerpt
MultiExcerptNameprocessflow_reverse

draw.io Diagram
bordertrue
diagramNameAmazonPay_reverse_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109
Image Removed


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN

Initialize Amazon Pay interface

In order to initialize a payment with Amazon Pay, please use the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
amazonAPA.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1651480259396_-516261104
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAmazonpay_initialize_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1651480259399_-2046881749
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

Format

CND

Description

Beschreibung
CountryCodean2MCountry code of used marketplace. Options EU, US and JP.Ländercode des verwendeten Marktplatzes. Optionen EU, US und JP.

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Key

Format

CND

Description

Beschreibung
URLSuccessans..256MThe buyer is redirected to this URL if action was successfulDer Käufer wird zu dieser URL weitergeleitet, wenn die Aktion erfolgreich war
URLFailureans..256MThe buyer is redirected to this URL if action was unsuccessfulDer Käufer wird zu dieser URL weitergeleitet, wenn die Aktion nicht erfolgreich war

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

Key

Format

CND

Description

Beschreibung
URLCancelans..256MThe buyer is redirected to this URL if the operation is cancelledDer Käufer wird zu dieser URL weitergeleitet, wenn der Vorgang abgebrochen wird

ShopUrl

ans..256

M

Order review page where customer is redirected after confirming customer's preferred payment instrument and optionally shipping address on the Amazon Pay-hosted pageBestellüberprüfungsseite, auf die der Kunde weitergeleitet wird, nachdem er das bevorzugte Zahlungsmittel und optional die Lieferadresse auf der von Amazon Pay gehosteten Seite bestätigt hat
TxTypean..20C

Payment flow for charging the buyer. Supported values:

  • 'AuthorizeWithCapture' – Authorize and capture funds immediately, is default
  • 'Authorize' – Authorize funds immediately and capture at a later time

Zahlungsablauf für die Belastung des Käufers. Unterstützte Werte:

  • 'AuthorizeWithCapture' – Sofortiges Autorisieren und Einziehen von Geldern ist die Standardeinstellung
  • 'Authorize' – Gelder sofort autorisieren und zu einem späteren Zeitpunkt buchen
LocalCurrencya3CThe currency that the buyer will be charged in ISO 4217 format. Only possible for Amazon EU and UK markets.Die Währung, die dem Käufer in Rechnung gestellt wird, im ISO-4217-Format. Nur möglich für Amazon EU- und UK-Märkte.
Scopea..128O

The buyer details that you're requesting access to. Possible values:

  • "name"
  • "email"
  • "phoneNumber"
  • "billingAddress"

If not included, all buyer information is requested.

Die Käuferdetails, auf die Sie Zugriff anfordern. Mögliche Werte:

  • "name"
  • "email"
  • "phoneNumber"
  • "billingAddress"

Wenn nicht enthalten, werden alle Käuferinformationen angefordert.

ChDescans..16COnly for sale type transactions: AuthorizeWithCapture.
Default: "AMZ*<SELLER_NAME> pay.amazon.com"
Nur für Sale-Transaktionen: AuthorizeWithCapture.
Standardwert: "AMZ*<SELLER_NAME> pay.amazon.com"

OrderDesc

ans..127

O

Use this parameter for the simulation mode. During live mode this parameter has no effects.Verwenden Sie diesen Parameter für den Simulationsmodus. Im Live-Modus hat dieser Parameter keine Auswirkungen.



RecurringRecurring (wiederholte Zahlungen)
RTFans1OFor repeated payments (subscriptions): I = Initial payment of series of payments. Default is OTP, one time payment.Bei wiederholten Zahlungen (Abonnements): I = Erstzahlung einer Reihe von Zahlungen. Standard ist OTP, einmalige Zahlung.
cyclean..7CCycle. Supported values: 'Year', 'Month', 'Week', 'Day', 'Variable'Zyklus. Unterstützte Werte: 'Jahr', 'Monat', 'Woche', 'Tag', 'Variabel'
Valuen..4C

Number of frequency units per billing cycle. For example, to specify a weekly cycle set unit to Week and value to 1. You must set value to 0 if you're using variable unit.

  • year: 1-3
  • Month: 1-36
  • Week: 1-57
  • Day: 1-1095

Anzahl der Frequenzeinheiten pro Abrechnungszeitraum. Um beispielsweise einen wöchentlichen Zyklus anzugeben, setzen Sie die Einheit auf Woche und den Wert auf 1. Sie müssen den Wert auf 0 setzen, wenn Sie eine variable Einheit verwenden..

  • Jahr: 1-3
  • Monat: 1-36
  • Woche: 1-57
  • Tag: 1-1095
InstallmentAmountn..10CTransaction amount – choose zero if is not a fixed amountTransaktionsbetrag – wählen Sie Null, wenn es sich nicht um einen festen Betrag handelt
currencya3CTransaction currency code in ISO 4217 format. Example: EURWährungscode der Transaktion im Format ISO 4217. Beispiel: EUR

Encrypted parameters for initializing an Amazon Pay payment


Intermediate response with button additional parameters

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1651480324590_581100185
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAmazonpay_initialize_intermediate_button
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1651480336186_1309611837
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Key

Format

CND

Description

Beschreibung

buttonsignature

ans..256MSignature for the Amazon buttonSignatur für die Amazon-Schaltfläche

buttonpayload

ans..256MPayload for the Amazon buttonPayload für die Amazon-Schaltfläche

buttonpublickeyid

ans..256MPublic Key ID for the Amazon buttonPublic-Key-ID für die Amazon-Schaltfläche

Response parameters after initializing an Amazon Pay payment


The following example code shows the updated and complete Amazon Pay button, which will redirect the client to Amazon.

Multiexcerpt
MultiExcerptNameAmazonpay_button
Code Block
languagejs
<div id="AmazonPayButton"></div>
<script src="https://static-na.payments-amazon.com/checkout.js"></script>
<script type="text/javascript" charset="utf-8">
var amazonPayButton = amazon.Pay.renderButton('#AmazonPayButton', {
merchantId: 'xxxxx',
ledgerCurrency: 'EUR',          
checkoutLanguage: 'en_GB', 
productType: 'PayAndShip', 
placement: 'Cart',
buttonColor: 'Gold'
});

amazonPayButton.onClick(function(){
// Here you need to call your shop server, which creates the initial Call towards Paygate
// and then returns the required data payloadJSON, signature, publicKeyId from the response
var buttonData = getSignedButtonData()

amazonPayButton.initCheckout({
    createCheckoutSessionConfig: { 
    payloadJSON: buttonData.payloadJSON,
    signature: buttonData.signature,
    publicKeyId: buttonData.publicKeyId
    }
});
</script>

Intermediate response with customer information to your ShopUrl

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1651480376230_-1097415803
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAmazonpay_initialize_intermediate_info
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1651480386475_966538779
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung
RTFans1O

Onetime or recurring. For repeated payments (subscriptions): I = Initial payment of series of payments.

Einmalig oder wiederkehrend. Bei wiederholten Zahlungen (Abonnements): I = Erstzahlung einer Reihe von Zahlungen.

Response parameters after initializing an Amazon Pay payment


Amazon Pay capture a payment

In order to capture an authorized payment with Amazon Pay, please use the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
capture.aspx


The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1632338930100_1312686892
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAmazonpay_capture_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1632338930101_-814895280
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

Format

CND

Description

Beschreibung
ChDescans..16OText printed on the customer’s credit card bill alongside the payeeText der auf der Abrechnung des Kreditinstituts des Kunden erscheint
OrderDescans..127MUse this parameter for the simulation mode. During live mode this parameter has no effects.Nutzen Sie diesen Parameter für den Simulationsmodus. Im Livebetrieb hat dieser Parameter keine Auswirkungen.

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Encrypted parameters for capturing an authorized Amazon Pay payment


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1632340630297_306787162
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAmazonpay_capture_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1632340630298_-1001780813
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung
CodeExtans..10OError code from Amazon, if transferredFehlercode von Amazon, wenn übergeben
ErrorTextas..1024OError description from Amazon, if transferredFehlerbeschreibung von Amazon, wenn diese übergeben wurde

chargeid

ans..256MAmazon Pay Charge IDAmazon Pay Charge ID
AmazonStatusa..20MOrder status at Amazon. Following values are possible: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.Bestellstatus bei Amazon. Folgende Werte sind möglich: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details siehe Amazon API Reference Guide.

chargepermissionid

ans..256MAmazon Pay Permission IDAmazon Pay Permission ID

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Key

Format

CND

Description

Beschreibung
AmountAuthn..10MTotal amount which is reserved at AmazonGesamtbetrag, der bei Amazon reserviert wurde
AmountCapn..10MTotal amount which is already successfully captured at AmazonGesamtbetrag, der bisher bei Amazon erfolgreich gebucht wurde
AmountCredn..10MTotal amount which is already successfully credited at AmazonGesamtbetrag, der bisher bei Amazon erfolgreich gutgeschrieben wurde

Response parameters after capturing an authorized Amazon Pay payment


After a capture you get a notify to your specified URLNotify with following parameters:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1632341965271_1640390685
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAmazonpay_capture_notify
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1632341965274_-1783773620
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung
CodeExtans..10OError code from Amazon, if transferredFehlercode von Amazon, wenn übergeben
ErrorTextas..1024OError description from Amazon, if transferredFehlerbeschreibung von Amazon, wenn diese übergeben wurde

chargeid

ans..256MAmazon Pay Charge IDAmazon Pay Charge ID
AmazonStatusa..20MOrder status at Amazon. Following values are possible: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.Bestellstatus bei Amazon. Folgende Werte sind möglich: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details siehe Amazon API Reference Guide.

chargepermissionid

ans..256MAmazon Pay Permission IDAmazon Pay Permission ID
OrderIDans..19MUnique ID for the order issued by Amazon. Corresponds to the OrderReferenceID.Von Amazon vergebene eindeutige ID für die Bestellung. Entspricht der OrderReferenceID.
AmazonRefIDans..27MUnique ID for the transaction issued by AmazonVon Amazon vergebene eindeutige ID für die Transaktion

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Key

Format

CND

Description

Beschreibung
AmountAuthn..10MTotal amount which is reserved at AmazonGesamtbetrag, der bei Amazon reserviert wurde
AmountCapn..10MTotal amount which is already successfully captured at AmazonGesamtbetrag, der bisher bei Amazon erfolgreich gebucht wurde
AmountCredn..10MTotal amount which is already successfully credited at AmazonGesamtbetrag, der bisher bei Amazon erfolgreich gutgeschrieben wurde
NotificationTypea..25MDescribes the type of notification. Fixed value: <CaptureNotification>Beschreibt die Art der Benachrichtigung. Fester Wert: <CaptureNotification>

Response parameters to URLNotify after capturing an authorized Amazon Pay payment


Amazon Pay credit a payment

In order to credit a captured payment with Amazon Pay, please use the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
credit.aspx


The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1632342424971_989391664
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAmazonpay_credit_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1632342424973_-1581273244
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

Format

CND

Description

Beschreibung
OrderDescans..127MDescription of purchased goods, unit prices etc. for creditBeschreibung der gekauften Waren, Einzelpreise etc. für die Gutschrift

chargeid

ans..256MAmazon Pay Charge IDAmazon Pay Charge ID

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Encrypted parameters for crediting an Amazon Pay payment


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1632342751968_-1312478225
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAmazonpay_credit_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1632342751969_-1692323594
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung
CodeExtans..10OError code from Amazon, if transferredFehlercode von Amazon, wenn übergeben
ErrorTextas..1024OError description from Amazon, if transferredFehlerbeschreibung von Amazon, wenn diese übergeben wurde
AmazonStatusa..20MOrder status at Amazon. Following values are possible: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.Bestellstatus bei Amazon. Folgende Werte sind möglich: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details siehe Amazon API Reference Guide.
chargeidans..256MAmazon Pay Charge IDAmazon Pay Charge ID
refundidans..256MAmazon Pay Refund IDAmazon Pay Refund ID

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Key

Format

CND

Description

Beschreibung
AmountAuthn..10MTotal amount which is reserved at AmazonGesamtbetrag, der bei Amazon reserviert wurde
AmountCapn..10MTotal amount which is already successfully captured at AmazonGesamtbetrag, der bisher bei Amazon erfolgreich gebucht wurde
AmountCredn..10MTotal amount which is already successfully credited at AmazonGesamtbetrag, der bisher bei Amazon erfolgreich gutgeschrieben wurde

Response parameters after crediting an authorized Amazon Pay payment


After a credit you get a notify to your specified URLNotify with following parameters:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1632342980217_816495349
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAmazonpay_credit_notify
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1632342980218_-2037459586
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung
CodeExtans..10OError code from Amazon, if transferredFehlercode von Amazon, wenn übergeben
ErrorTextas..1024OError description from Amazon, if transferredFehlerbeschreibung von Amazon, wenn diese übergeben wurde
AmazonStatusa..20MOrder status at Amazon. Following values are possible: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.Bestellstatus bei Amazon. Folgende Werte sind möglich: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details siehe Amazon API Reference Guide.
chargeidans..256MAmazon Pay Charge IDAmazon Pay Charge ID
refundidans..256MAmazon Pay Refund IDAmazon Pay Refund ID

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Key

Format

CND

Description

Beschreibung
AmountAuthn..10MTotal amount which is reserved at AmazonGesamtbetrag, der bei Amazon reserviert wurde
AmountCapn..10MTotal amount which is already successfully captured at AmazonGesamtbetrag, der bisher bei Amazon erfolgreich gebucht wurde
AmountCredn..10MTotal amount which is already successfully credited at AmazonGesamtbetrag, der bisher bei Amazon erfolgreich gutgeschrieben wurde
NotificationTypea..25MDescribes the type of notification. Fixed value: <CreditNotification>Beschreibt die Art der Benachrichtigung. Fester Wert: <CreditNotification>

Response parameters to URLNotify after credit of an Amazon Pay payment



Amazon Pay reverse an order

In order to reverse a complete order with Amazon Pay with the function „CancelOrderReference“, please use the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
reverse.aspx


The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1632344211467_-629653913
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAmazonpay_reverseorder_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1632344211468_1907130187
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

Format

CND

Description

Beschreibung
Reasona..1024OReason for reversalGrund der Stornierung
chargeidans..256MAmazon Pay Charge IDAmazon Pay Charge ID

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Encrypted parameters for reversal of an Amazon Pay payment


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1651475313632_199267401
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameAmazonpay_reverseorder_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1651475341967_2001849385
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung

CodeExt

ans..10

O

Error code from Amazon, if transferred

Fehlercode von Amazon, wenn übergeben

ErrorText

as..1024

O

Error description from Amazon, if it was transferred

Fehlerbeschreibung von Amazon, wenn diese übergeben wurde
AmazonStatusa..20MOrder status at Amazon. Following values are possible: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.Status der Bestellung bei Amazon. Folgende Werte sind möglich: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details siehe Amazon API Reference Guide.
chargeidans..256MAmazon Pay Charge IDAmazon Pay Charge ID
chargepermissionidans..256MAmazon Pay Permission IDAmazon Pay Permission ID

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Key

Format

CND

Description

Beschreibung
AmountAuthn..10MTotal amount which is reserved at AmazonGesamtbetrag, der bei Amazon reserviert wurde
AmountCapn..10MTotal amount which is already successfully captured at AmazonGesamtbetrag, der bisher bei Amazon erfolgreich gebucht wurde
AmountCredn..10MTotal amount which is already successfully credited at AmazonGesamtbetrag, der bisher bei Amazon erfolgreich gutgeschrieben wurde

Response parameters after reversing an Amazon Pay payment