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
The buyer clicks on the Amazon Pay button to start checkout.
The buyer signs in, confirms their preferred payment instrument, and optionally selects a shipping address on the Amazon Pay-hosted page.
The buyer is redirected back to your order review page for confirmation.
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.
Amazon Pay redirects the buyer back to your confirmation page.
Further information you will find also on the:
Checkout Demo page from Amazon: Demo page
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".
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.2 | Comment |
Country Code* | Code of the Amazon market used (DE=EU, UK, JP and US) |
MerchantID | taken from Amazon seller central |
MWS Authorization Token | Example: amzn.mws.a4a8d852-3d9e-f441-0674-d042baa3cf6452 |
merchant Store Name | Name of the store |
StoreID | Example: 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 Computop permission to conduct transactions for your shop.
The second step is generating a MWS Auth Token. This is the data needed:
German :
Developer name: CT_Sandbox_EU
Developer account number: 0143-6461-8727
United Kingdom:
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 Computop Helpdesk 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 Computop Helpdesk 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 Paygate notify URL.
URL: https://www.computop-paygate.com/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:
Here please add the following URL to the integrator URL and click on the "Update"-button
https://www.computop-paygate.com/amazonAPAV2Notify.aspx
2. The merchant can also save his own notify URL if he so wishes. Computop 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 amazonAPA.aspx (Server to Server) | You will call Paygate endpoint https://www.computop-paygate.com/amazonapa.aspx according to description below. Paygate 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 Paygate. |
6 | Redirect back to your webshop | After 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 Computop 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:
Add the new Amazon Cv.2 Button (Step 1)
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 Paygate.
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 Paygate to obtain additional data, which are required for updating the Amazon Pay button.
1var amazonPayButton = amazon.Pay.renderButton('#AmazonPayButton', {2 merchantId: 'xxxxx',3 publicKeyId: 'SANDBOX-xxxxxxxxxx',4 ledgerCurrency: 'EUR',5 checkoutLanguage: 'en_GB',6 productType: 'PayAndShip',7 placement: 'Cart',8 buttonColor: 'Gold',9});10
11amazonPayButton.onClick(function () {12 const [payload, signature, publicKeyId] = your_call_to_paygate();13
14 amazonPayButton.initCheckout({15 createCheckoutSessionConfig: {16 payloadJSON: payload,17 signature: signature,18 publicKeyId: publicKeyId,19 },20 });21});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:
|
placement | Placement 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:
|
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:
|
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
Computop Data
This is the Computop 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
JS example
This is an JS Example that merchants can use to accommodate changes if necessary
1let session = document.getElementById('sessionId').value;2let link = document.getElementById('redirectUrl').value;3let buyNow = document.getElementById('buy-now');4buyNow.addEventListener('click', () => {5 window.location = link;6});7amazon.Pay.bindChangeAction('#change-paymethod', {8 amazonCheckoutSessionId: session,9 changeAction: 'changePayment',10});11amazon.Pay.bindChangeAction('#change-shipping', {12 amazonCheckoutSessionId: session,13 changeAction: 'changeAddress',14});The Amazon description can be found here:
Update Amount:
If the amount changes during the Review Process, then following amount update request need to be sent to Paygate.
Request URL:
https://www.computop-paygate.com/amazonAPA.aspx
1Request Parameter:2
3Amount=999&4Currency=EUR&5CountryCode=EU&6eventToken=UpdateAuthorizeAmount&7PayId=be30427125a94801a4c3757f4ea21118
9
10Response Parameter:11
12mid=ct_teamtest13PayID=be30427125a94801a4c3757f4ea2111114TransID=n/a15Status=AUTHORIZE_REQUEST16Code=017XID=d1708fcca09945e6b3e195156848b2f818AmountAuth=019AmountCap=020AmountCred=0Process 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)
Recurring Subsequent
Subsequent actions
Capture a payment
Credit a payment
Reverse an order
Paygate 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.
Initialize Amazon Pay interface
In order to initialize a payment with Amazon Pay, please use the following URL:
https://www.computop-paygate.com/amazonAPA.aspx
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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
ans..30 | O | Merchant’s unique reference number | |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
CountryCode | an2 | M | Country code of used marketplace. Options EU, US and JP. |
n..10 | M | 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). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
URLSuccess | ans..256 | M | The buyer is redirected to this URL if action was successful |
URLFailure | ans..256 | M | The buyer is redirected to this URL if action was unsuccessful |
ans..256 | M | Complete URL which Paygate 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 UserDataparameter instead. Common notes:
| |
URLCancel | ans..256 | M | The 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 |
TxType | an..20 | C | Payment flow for charging the buyer. Supported values:
|
LocalCurrency | a3 | C | The currency that the buyer will be charged in ISO 4217 format. Only possible for Amazon EU and UK markets. |
Scope | a..128 | O | The buyer details that you're requesting access to. Possible values:
If not included, all buyer information is requested. |
ChDesc | ans..16 | C | Only 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. |
Recurring | |||
RTF | ans1 | O | For repeated payments (subscriptions): I = Initial payment of series of payments. Default is OTP, one time payment. |
cycle | an..7 | C | Cycle. Supported values: 'Year', 'Month', 'Week', 'Day', 'Variable' |
Value | n..4 | C | 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.
|
InstallmentAmount | n..10 | C | Transaction amount – choose zero if is not a fixed amount |
currency | a3 | C | Transaction currency code in ISO 4217 format. Example: EUR |
Encrypted parameters for initializing an Amazon Pay payment
Intermediate response with button additional parameters
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
ans..30 | O | Merchant’s unique reference number | |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
buttonsignature | ans..256 | M | Signature for the Amazon button |
buttonpayload | ans..256 | M | Payload for the Amazon button |
buttonpublickeyid | ans..256 | M | Public Key ID for the Amazon button |
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.
1<div id="AmazonPayButton"></div>2<script src="https://static-na.payments-amazon.com/checkout.js"></script>3<script type="text/javascript" charset="utf-8">4var amazonPayButton = amazon.Pay.renderButton('#AmazonPayButton', {5merchantId: 'xxxxx',6ledgerCurrency: 'EUR', 7checkoutLanguage: 'en_GB', 8productType: 'PayAndShip', 9placement: 'Cart',10buttonColor: 'Gold'11});12
13amazonPayButton.onClick(function(){14// Here you need to call your shop server, which creates the initial Call towards Paygate15// and then returns the required data payloadJSON, signature, publicKeyId from the response16var buttonData = getSignedButtonData()17
18amazonPayButton.initCheckout({19 createCheckoutSessionConfig: { 20 payloadJSON: buttonData.payloadJSON,21 signature: buttonData.signature,22 publicKeyId: buttonData.publicKeyId23 }24});25</script>Intermediate response with customer information to your ShopUrl
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
ans..30 | O | Merchant’s unique reference number | |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
RTF | ans1 | O | Onetime or recurring. For repeated payments (subscriptions): I = Initial payment of series of payments. |
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:
https://www.computop-paygate.com/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.
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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
n..10 | M | 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). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
ans..30 | O | Merchant’s unique reference number | |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
ChDesc | ans..16 | O | Text printed on the customer’s credit card bill alongside the payee |
OrderDesc | ans..127 | O | Use this parameter for the simulation mode. During live mode this parameter has no effects. |
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 Paygate 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 Paygate. |
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
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
ans..30 | O | Merchant’s unique reference number | |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
CodeExt | ans..10 | O | Error code from Amazon, if transferred |
ErrorText | as..1024 | O | Error description from Amazon, if transferred |
chargeid | ans..256 | M | Amazon Pay Charge ID |
AmazonStatus | a..20 | M | Order status at Amazon. Following values are possible: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details see Amazon API Reference Guide. |
chargepermissionid | ans..256 | M | Amazon Pay Permission ID |
n..10 | M | 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). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
AmountAuth | n..10 | M | Total amount which is reserved at Amazon |
AmountCap | n..10 | M | Total amount which is already successfully captured at Amazon |
AmountCred | n..10 | M | Total 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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
ans..30 | O | Merchant’s unique reference number | |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
CodeExt | ans..10 | O | Error code from Amazon, if transferred |
ErrorText | as..1024 | O | Error description from Amazon, if transferred |
chargeid | ans..256 | M | Amazon Pay Charge ID |
AmazonStatus | a..20 | M | Order status at Amazon. Following values are possible: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details see Amazon API Reference Guide. |
chargepermissionid | ans..256 | M | Amazon Pay Permission ID |
OrderID | ans..19 | M | Unique ID for the order issued by Amazon. Corresponds to the OrderReferenceID. |
AmazonRefID | ans..27 | M | Unique ID for the transaction issued by Amazon |
n..10 | M | 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). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
AmountAuth | n..10 | M | Total amount which is reserved at Amazon |
AmountCap | n..10 | M | Total amount which is already successfully captured at Amazon |
AmountCred | n..10 | M | Total amount which is already successfully credited at Amazon |
NotificationType | a..25 | M | Describes the type of notification. Fixed value: <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:
https://www.computop-paygate.com/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.
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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
n..10 | M | 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). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
ans..30 | O | Merchant’s unique reference number | |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
OrderDesc | ans..127 | M | Description of purchased goods, unit prices etc. for credit |
chargeid | ans..256 | M | Amazon Pay Charge ID |
Encrypted parameters for crediting an Amazon Pay payment
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
ans..30 | O | Merchant’s unique reference number | |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
CodeExt | ans..10 | O | Error code from Amazon, if transferred |
ErrorText | as..1024 | O | Error description from Amazon, if transferred |
AmazonStatus | a..20 | M | Order status at Amazon. Following values are possible: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details see Amazon API Reference Guide. |
chargeid | ans..256 | M | Amazon Pay Charge ID |
refundid | ans..256 | M | Amazon Pay Refund ID |
n..10 | M | 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). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
AmountAuth | n..10 | M | Total amount which is reserved at Amazon |
AmountCap | n..10 | M | Total amount which is already successfully captured at Amazon |
AmountCred | n..10 | M | Total 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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
ans..30 | O | Merchant’s unique reference number | |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
CodeExt | ans..10 | O | Error code from Amazon, if transferred |
ErrorText | as..1024 | O | Error description from Amazon, if transferred |
AmazonStatus | a..20 | M | Order status at Amazon. Following values are possible: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details see Amazon API Reference Guide. |
chargeid | ans..256 | M | Amazon Pay Charge ID |
refundid | ans..256 | M | Amazon Pay Refund ID |
n..10 | M | 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). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
AmountAuth | n..10 | M | Total amount which is reserved at Amazon |
AmountCap | n..10 | M | Total amount which is already successfully captured at Amazon |
AmountCred | n..10 | M | Total amount which is already successfully credited at Amazon |
NotificationType | a..25 | M | Describes the type of notification. Fixed value: <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:
https://www.computop-paygate.com/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.
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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
Reason | a..1024 | O | Reason for reversal |
chargeid | ans..256 | M | Amazon Pay Charge ID |
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 Paygate 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 Paygate. |
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
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
ans..30 | O | Merchant’s unique reference number | |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
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! | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
CodeExt | ans..10 | O | Error code from Amazon, if transferred |
ErrorText | as..1024 | O | Error description from Amazon, if transferred |
AmazonStatus | a..20 | M | Order status at Amazon. Following values are possible: „Draft“, „Open“, „Suspended“, „Abandoned“, „Canceled“, „Closed“. Details see Amazon API Reference Guide. |
chargeid | ans..256 | M | Amazon Pay Charge ID |
chargepermissionid | ans..256 | M | Amazon Pay Permission ID |
n..10 | M | 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). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | |
AmountAuth | n..10 | M | Total amount which is reserved at Amazon |
AmountCap | n..10 | M | Total amount which is already successfully captured at Amazon |
AmountCred | n..10 | M | Total amount which is already successfully credited at Amazon |
Response parameters after reversing an Amazon Pay payment