About Amazon Pay

General information about Amazon Pay

Amazon Pay is a fast, secure, and trusted payment solution that allows buyers to use their Amazon credentials to make purchases on your website. By integrating Amazon Pay, you can offer a seamless checkout experience and increase conversion rates.

Customer journey

  1. Product Selection & Checkout: Buyer adds products to their cart and proceeds to checkout by selecting the Amazon Pay button.
  2. Amazon Login & Credentials Selection: Buyer is redirected to Amazon's login page to sign in to their Amazon account. After login, buyer selects their preferred payment method and shipping address.
  3. Review Order: The buyer is redirected back to your website to review their order details with a possibility to change the details if needed.
  4. Place Order: Buyer confirms the purchase by clicking "Place order". Buyer is redirected to Amazon for additional authentication that may be needed. Once successful, the transaction is authorized.
  5. Order confirmation: Buyer is redirected back to your order confirmation page.

 

On this page

Process flow chart


Accept Amazon Pay

Follow the below steps in order to start accepting Amazon Pay.

If you are already integrated with Computop for Amazon Pay V1, you can skip Step 1 and proceed directly to Step 2.

 

Step 1: Register for Amazon Pay

  • Register yourself at https://pay.amazon.com/signup.
  • You can switch the country on the sign-up page, as per your business location.
  • After a successful login, you can set up both sandbox and production environments on your Amazon Pay account, by switching between the two.


Step 2: Obtain MWS Authorization Token

MWS Authorization token is a secret token that enables Computop to connect to Amazon on behalf of your store. It is important to generate this token and share it with Computop Helpdesk during your onboarding process.

Steps to generate MWS Authorization token

  1. Navigate to settings and select User Permissions.
  2. On the User Permissions page navigate to the section "Third-party developer and apps" and click "Visit Manage your apps".
  3. On the Manage Your Apps page, click the action "Authorize new developer".
  4. Provide Developer's Name and Developer ID. Below credentials are same for Sandbox and Production environment setup.
    1. Developer Name: CT_Sandbox_EU
    2. Developer ID: 0143-6461-8727
  5. Provide your consent in the next page. Upon completion, the MWS Authorization token will be generated. You can also view it later in the "Manage your Apps" page.



Step 3: Setup Notify URL

Notify URL is used by Amazon for asynchronous responses to Platform for operations like capture and refunds. You need to setup Platform's notify URL for your store on Amazon Seller Central account for these notifications to be received.

  1. Navigate to Hamburger menu on the left and select Integration → Integration Central.
  2. Find the option IPN settings at the bottom of the page.
  3. Click on the link "Merchant and Integrator IPN settings". On the page, update the field "Integrator URL" to https://www.computop-paygate.com/amazonAPAV2Notify.aspx?mid=yourmerchantId&region=EU.
    Notice: Replace yourmerchantId with the merchantId setup in Computop Paygate.



Step 4: Onboarding with Computop for Amazon Pay

In order to onboard with Computop for Amazon Pay, provide the following information. Note that the below information is needed for every market you have your presence.

  1. Country code Country code of the market.
  2. Merchant ID Merchant ID from your Amazon Seller Central Account.
  3. MWS Authorization Token Generated in Step 2.
  4. Store Name Name of the store.


Step 5: Render Amazon Pay Button

Render Amazon Pay Button on your checkout page. Use the below code snippet as a reference.

<body>
    <!-- This is the container where the Amazon Pay button will be rendered -->
    <div id="AmazonPayButton"></div>

    <!-- This script loads the Amazon Pay JavaScript SDK from Amazon's servers -->
    <script src="https://static-eu.payments-amazon.com/checkout.js"></script>

    <script type="text/javascript" charset="utf-8">
        // Render the Amazon Pay button within the 'AmazonPayButton' div.
        const amazonPayButton = amazon.Pay.renderButton('#AmazonPayButton', {
            merchantId: 'merchant_id',
            publicKeyId: 'SANDBOX-xxxxxxxxxx',
            ledgerCurrency: 'EUR',             
            checkoutLanguage: 'en_GB',
            productType: 'PayAndShip',
            placement: 'Cart',
            buttonColor: 'Gold',
            estimatedOrderAmount: { "amount": "109.99", "currencyCode": "EUR" }
        });

        // Event listener for when the Amazon Pay button is clicked
        amazonPayButton.onClick(function(){
            // Replace <<call_to_your_backend_function>> with your actual function
            // that makes a server-side call to your backend, which in turn communicates
            // with Paygate to get the 'payload', 'signature', and 'publicKeyId'
            const [payload, signature, publicKeyId] = <<call_to_your_backend_function>>();

            // Initialize the Amazon Pay checkout session with the fetched data above
            amazonPayButton.initCheckout({
                createCheckoutSessionConfig: {
                    payloadJSON: payload,
                    signature: signature,
                    publicKeyId: publicKeyId
                }
            });
        });
    </script>
</body>


Use the below table as a reference for button parameters that can be passed to render the button as per your need.

Button Parameters

CND

Description

Permissible Values

merchantId

M

SellerId issued by Amazon


ledgerCurrency

M

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


Permissible values:

  • EU merchants 'EUR'

publicKeyId

M

Key provided by Amazon


placementMPlacement of the button

Permissible values:

Cart

buttonColor

O

The parameter buttonColor defines the color of the button


Permissible values:

Gold, LightGray, DarkGray

Default value 'Gold'

productTypeO

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

O

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:

  • EU/UK merchants 'en_GB', de_DE', 'fr_FR', 'it_IT', 'es_ES'




Platform interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Step 6: Integrate to Platform Interface

Integrate your backend with Platform interface to fetch the payload to be able to initialize the checkout session with Amazon. In order to initialize a payment with Amazon Pay, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

KeyFormatCNDDescription

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

Key

Format

CND

Description

CountryCodean2MCountry code of used marketplace. Options EU, US and JP.

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key

Format

CND

Description

URLSuccessans..256MThe buyer is redirected to this URL if action was successful
URLFailureans..256MThe buyer is redirected to this URL if action was unsuccessful

KeyFormatCNDDescription
URLNotify

ans..256

M

Complete URL which Platform calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.

(info) Common notes:

  • Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.
  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Key

Format

CND

Description

URLCancelans..256MThe buyer is redirected to this URL if the operation is cancelled

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 page
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
LocalCurrencya3CThe currency that the buyer will be charged in ISO 4217 format. Only possible for Amazon EU and UK markets.
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.

ChDescans..16COnly for sale type transactions: AuthorizeWithCapture.
Default: "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.

AmazonpaySimulationCode

ans..

O

A parameter used to simulate specific payment scenarios or behaviors during testing. For complete list of allowed simulation code, refer Amazonpay documentation.


Encrypted parameters for initializing an Amazon Pay payment


Address Restriction

It is possible for the merchants to specify restrictions whether addresses that match restrictions configuration should or should not be restricted.

To send address restriction use parameter addressRestriction json base64 encoded. Please find the overview of data elements and the schema below:

Key

Format

CND

Description

type

string

C

Specifies whether addresses that match restrictions configuration should or should not be restricted.

Supported values:

  • 'Allowed' Mark addresses that don't match restrictions configuration as restricted
  • 'NotAllowed' Mark addresses that match restrictions configuration as restricted

restriction

<countryCode:restriction>

C

Country-level restrictions that determine which addresses should or should not be restricted based on type parameter.

CountryCode is a string that represents the country code of the address in ISO 3166 format.

statesOrRegions: List of country-specific states that should or should not be restricted based on type parameter
 
zipCodes: List of country-specific zip codes that should or should not be restricted based on type parameter


Schema

{ "type": "Allowed", 
  "restrictions": { "US":{ "statesOrRegions": ["WA"], "zipCodes": ["95050", "93405"] }, 
                    "GB":{ "zipCodes": ["72046", "72047"] },
                    "IN":{ "statesOrRegions": ["AP"] },
                    "JP": {} 
                  } 
}
The above data should be base64 encoded and passed in the parameter
addressRestriction=
eyAidHlwZSI6ICJBbGxvd2VkIiwgInJlc3RyaWN0aW9ucyI6IHsgIlVTIjoKCnsgInN0YXRlc09yUmVnaW9ucyI6IFsiV0EiXSwgInppcENvZGVzIjogWyI5NTA1MCIsICI5MzQwNSJdIH0KCiwgIkdCIjoKCnsgInppcENvZGVzIjogWyI3MjA0NiIsICI3MjA0NyJdIH0KCiwgIklOIjoKCnsgInN0YXRlc09yUmVnaW9ucyI6IFsiQVAiXSB9CgosICJKUCI6IHt9IH0gfQ==


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Key

Format

CND

Description

buttonsignature

ans..256MSignature for the Amazon button

buttonpayload

ans..256MPayload for the Amazon button

buttonpublickeyid

ans..256MPublic Key ID for the Amazon button

Intermediate response parameters after initializing an Amazon Pay payment


Step 7: Render Review Page

Once you have initialized the checkout session with Amazon pay with the enriched payload, customer will be redirected to Amazon to login and choose payment method and shipping credentials. Once the customer finishes the step, Computop sends the payment method and shipping details to the ShopUrl you passed in the original request. Use this data to render the review page on your store.


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

Status

a..50

M

PENDING

KeyFormatCNDDescription
Code

an8

M

Error code according to Platform Response Codes (A4 Error codes)

Key

Format

CND

Description

AmountAuth

n..10MTotal amount which is reserved at Amazon

AmountCap

n..10MTotal amount which is already successfully captured at Amazon

AmountCred

n..10MTotal amount which is already successfully credited at Amazon

bdAddrName

ans..30CBilling address customer name

bdAddrStreet

a..32CBilling address street and street number

bdAddrZip

n..5CBilling address postal code

bdAddrCity

a..32CBilling address town/city

bdAddrState

a..32CBilling address state

bdAddrCountrycode

a2CBilling address alphabetic country code

bdPhoneNumber

ans..20CBilling address phone number

AddrName

ans..30CShipping address customer name

AddrStreet

a..32CShipping address  street and street number

AddrStreet2

a..32CShipping address line 2

AddrStreet3

a..32CShipping address line 3

AddrZip

n..5CShipping address  postal code

AddrCity

a..32CShipping address  town/city

AddrState

a..32CShipping address  state

AddrCountrycode

a2CShipping address  alphabetic country code

PhoneNumber

ans..20CShipping address  phone number
buyerId

ans..42

MUnique amazon pay buyer identifier
buyerName

ans..50

MBuyer name
buyerEmail

ans..64

MBuyer's email
buyerPhonenumber

ans..20

MBuyer phone number
AmazonMerchantid

ans..

MAmazon Merchant ID
RTF

ans..

M

onetime single order

recurring recurring order

AmazonStatus

a..50

MOPEN
AmazonpayRedirectUrl

ans..256

MURL provided by Amazon Pay
AmazoncheckoutSessionid

ans..32

MAmazon's checkout session ID
AmazonPaymentDescriptor

ans..64

MPayment descriptor. E.g: "Visa ****1111 (Amazon Pay)"
 


Step 8: Enable Payment and Shipping Updates

The review page should allow the customer to update their payment method and shipping details if needed.

Use amazon.Pay.bindChangeAction() to bind click events to HTML elements on your page. You can specify whether the buyer is editing shipping address or payment method by using the changeAction parameter. Below are the javascript samples for your reference. For detailed information, refer Amazon documentation

Changing Address

<script type="text/javascript" charset="utf-8">
  amazon.Pay.bindChangeAction('#changeButton1', {
    amazonCheckoutSessionId: 'xxxx',
    changeAction: 'changeAddress'
  });
</script>

Changing Payment Instrument

<script type="text/javascript" charset="utf-8">
  amazon.Pay.bindChangeAction('#changeButton2', {
    amazonCheckoutSessionId: 'xxxx',
    changeAction: 'changePayment'
  });
</script>


Step 9: Support amount changes

If you encounter amount changes scenarios during the review process, for example change in amount due to added shipping costs, or you support cart updates in the review page, the information needs to be updated in Platform as well as on Amazon's system.

In order to change the amount with Amazon Pay, please use the following URL:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Key

Format

CND

Description

EventTokenenumMStatic value: UpdateAuthorizeAmount

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key

Format

CND

Description

CountryCodean2MCountry code of used marketplace. Options EU, US and JP.


Parameters for changing the amount of an Amazon Pay payment


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform

Key

Format

CND

Description

Status

a..50

M

AUTHORIZE_REQUEST

KeyFormatCNDDescription
Code

an8

M

Error code according to Platform Response Codes (A4 Error codes)

Key

Format

CND

Description

AmountAuth

n..10MTotal amount which is reserved at Amazon

AmountCap

n..10MTotal amount which is already successfully captured at Amazon

AmountCred

n..10MTotal amount which is already successfully credited at Amazon
Response parameters for changing the amount of an Amazon Pay payment

Notice: Make sure to render or enable the final "Pay" button only after you receive a successful response for the UpdateAuthorizeAmount event. 


Step 10: Complete Checkout

Enable the final "Pay" button for the customer to complete the checkout with Amazon. Upon successful completion, Platform will provide you a response in URLSuccess/URLFailure and URLNotify. Below are the parameters of this response.

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

Status

a..50

M

OK

KeyFormatCNDDescription
Code

an8

M

Error code according to Platform Response Codes (A4 Error codes)

Key

Format

CND

Description

AmountAuth

n..10MTotal amount which is reserved at Amazon

AmountCap

n..10MTotal amount which is already successfully captured at Amazon

AmountCred

n..10MTotal amount which is already successfully credited at Amazon. Will be zero for the payment.

bdAddrName

ans..30CBilling address customer name

bdAddrStreet

a..32CBilling address street and street number

bdAddrZip

n..5CBilling address postal code

bdAddrCity

a..32CBilling address town/city

bdAddrState

a..32CBilling address state

bdAddrCountrycode

a2CBilling address alphabetic country code

bdPhoneNumber

ans..20CBilling address phone number

AddrName

ans..30CShipping address customer name

AddrStreet

a..32CShipping address  street and street number

AddrZip

n..5CShipping address  postal code

AddrCity

a..32CShipping address  town/city

AddrState

a..32CShipping address  state

AddrCountrycode

a2CShipping address  alphabetic country code

PhoneNumber

ans..20CShipping address  phone number
buyerId

ans..42

MUnique amazon pay buyer identifier
buyerName

ans..50

MBuyer name
buyerEmail

ans..64

MBuyer's email
buyerPhonenumber

ans..20

MBuyer phone number
AmazonMerchantid

ans..

MAmazon Merchant ID
RTF

ans..

M

onetime single order

recurring recurring order

chargeid

ans..

M

Charge ID assigned by Amazon

chargepermissionid

ans..

M

Charge Permission ID assigned by Amazon

AmazonStatus

a..50

MCompleted
AmazonpayRedirectUrl

ans..256

MURL provided by Amazon Pay
AmazoncheckoutSessionid

ans..32

MAmazon's checkout session ID
Final response parameters for an Amazon Pay payment


Capture a payment

Multiple partial captures are currently not supported.

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


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.

Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

KeyFormatCNDDescription

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Platform does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Platform.

Key

Format

CND

Description

ChDescans..16OText printed on the customer’s credit card bill alongside the payee
OrderDescans..127OUse this parameter for the simulation mode. During live mode this parameter has no effects.

AmazonpaySimulationCode

ans..

O

A parameter used to simulate specific payment scenarios or behaviors during testing. For complete list of allowed simulation code, refer Amazonpay documentation.
Encrypted parameters for capturing an authorized Amazon Pay payment


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

KeyFormatCNDDescription
Code

an8

M

Error code according to Platform Response Codes (A4 Error codes)

Key

Format

CND

Description

CodeExtans..10OError code from Amazon, if transferred
ErrorTextas..1024OError description from Amazon, if transferred

chargeid

ans..256MAmazon Pay Charge ID
AmazonStatusa..20MOrder status at Amazon. Following values are possible: „Opened“, „Completed, „Canceled“. Details see  Amazon API Reference Guide.

chargepermissionid

ans..256MAmazon Pay Permission ID

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key

Format

CND

Description

AmountAuthn..10MTotal amount which is reserved at Amazon
AmountCapn..10MTotal amount which is already successfully captured at Amazon
AmountCredn..10MTotal amount which is already successfully credited at Amazon
Response parameters after capturing an authorized Amazon Pay payment


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

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

KeyFormatCNDDescription
Code

an8

M

Error code according to Platform Response Codes (A4 Error codes)

Key

Format

CND

Description

CodeExtans..10OError code from Amazon, if transferred
ErrorTextas..1024OError description from Amazon, if transferred

chargeid

ans..256MAmazon Pay Charge ID
AmazonStatusa..20MOrder status at Amazon. Following values are possible: „Opened“, „Completed, „Canceled“. Details see  Amazon API Reference Guide.

chargepermissionid

ans..256MAmazon Pay Permission ID
OrderIDans..19MUnique ID for the order issued by Amazon. Corresponds to the OrderReferenceID.
AmazonRefIDans..27MUnique ID for the transaction issued by Amazon

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key

Format

CND

Description

AmountAuthn..10MTotal amount which is reserved at Amazon
AmountCapn..10MTotal amount which is already successfully captured at Amazon
AmountCredn..10MTotal amount which is already successfully credited at Amazon
NotificationTypea..25MDescribes the type of notification. Fixed value: <CaptureNotification>
Response parameters to URLNotify after capturing an authorized Amazon Pay payment


Credit a payment

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


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.

Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

KeyFormatCNDDescription

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Platform does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Platform.

Key

Format

CND

Description

OrderDescans..127ODescription of purchased goods, unit prices etc. for credit

AmazonpaySimulationCode

ans..

O

A parameter used to simulate specific payment scenarios or behaviors during testing. For complete list of allowed simulation code, refer Amazonpay documentation.
Encrypted parameters for crediting an Amazon Pay payment


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

KeyFormatCNDDescription
Code

an8

M

Error code according to Platform Response Codes (A4 Error codes)

Key

Format

CND

Description

CodeExtans..10OError code from Amazon, if transferred
ErrorTextas..1024OError description from Amazon, if transferred
AmazonStatusa..20MOrder status at Amazon. Following values are possible: „Opened“, „Completed, „Canceled“. Details see  Amazon API Reference Guide.
chargeidans..256MAmazon Pay Charge ID
refundidans..256MAmazon Pay Refund ID

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key

Format

CND

Description

AmountAuthn..10MTotal amount which is reserved at Amazon
AmountCapn..10MTotal amount which is already successfully captured at Amazon
AmountCredn..10MTotal amount which is already successfully credited at Amazon
Response parameters after crediting an authorized Amazon Pay payment


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

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

KeyFormatCNDDescription
Code

an8

M

Error code according to Platform Response Codes (A4 Error codes)

Key

Format

CND

Description

CodeExtans..10OError code from Amazon, if transferred
ErrorTextas..1024OError description from Amazon, if transferred
AmazonStatusa..20MOrder status at Amazon. Following values are possible: „Opened“, „Completed, „Canceled“. Details see  Amazon API Reference Guide.
chargeidans..256MAmazon Pay Charge ID
refundidans..256MAmazon Pay Refund ID

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key

Format

CND

Description

AmountAuthn..10MTotal amount which is reserved at Amazon
AmountCapn..10MTotal amount which is already successfully captured at Amazon
AmountCredn..10MTotal amount which is already successfully credited at Amazon
NotificationTypea..25MDescribes the type of notification. Fixed value: <CreditNotification>
Response parameters to URLNotify after credit of an Amazon Pay payment


Reverse an order

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


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.

Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

KeyFormatCNDDescription

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

Key

Format

CND

Description

Reasona..1024OReason for reversal

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Platform does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Platform.

Encrypted parameters for reversal of an Amazon Pay payment


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Platform for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Platform

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

KeyFormatCNDDescription
Code

an8

M

Error code according to Platform Response Codes (A4 Error codes)

Key

Format

CND

Description

CodeExt

ans..10

O

Error code from Amazon, if transferred

ErrorText

as..1024

O

Error description from Amazon, if it was transferred

AmazonStatusa..20MOrder status at Amazon. Following values are possible: „Opened“, „Completed, „Canceled“. Details see  Amazon API Reference Guide.
chargeidans..256MAmazon Pay Charge ID
chargepermissionidans..256MAmazon Pay Permission ID

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key

Format

CND

Description

AmountAuthn..10MTotal amount which is reserved at Amazon
AmountCapn..10MTotal amount which is already successfully captured at Amazon
AmountCredn..10MTotal amount which is already successfully credited at Amazon
Response parameters after reversing an Amazon Pay payment


Setup recurring payments

In order to set up a recurring payment with Amazon Pay, submit the below data in addition to the standard request described in Step 6 above.

Initial Payment

Key

Format

CND

Description

RTFans1MI = Initial payment in the series
cyclean..7MCycle. Supported values: 'Year', 'Month', 'Week', 'Day', 'Variable'
Valuen..4M

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
InstallmentAmountn..10CTransaction amount – choose zero if is not a fixed amount
Currencya3CTransaction currency code in ISO 4217 format, for example: EUR

Recurring Payment

Key

Format

CND

Description

RTFans1MR = Recurring
Amount

n..10

M

Updated Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key

Format

CND

Description

CountryCodean2MCountry code of used marketplace. Options EU, US and JP.
ChargePermissionIdans..256MCharge Permission ID that you received in the response to the initial payment in the series



  • No labels