Maintenance Work Notice!

We will carry out maintenance work on this documentation on Tuesday, 15.06.2021 between 3 pm and 4 pm CEST. Thank you for your understanding.

Page tree

Search

Skip to end of metadata
Go to start of metadata

About Amazon Pay

General information about Amazon Pay

Payment processing with Amazon Pay (APA=Amazon Pay Advanced; LPA= Login and Pay with Amazon) requires the correct and timely coordinated cooperation of several systems working together.

To initialize a payment or a login with Amazon there is a direct interaction with Amazon required. Therefore a button widget provided by Amazon must be implemented in your shop.

Data from the first direct interaction with the Amazon widgets is then transferred to Computop Paygate in the following step. Computop Paygate resumes the follow-up actions in this process by a direct communication with the Amazon systems. Computop Paygate returns all answers of the Amazon systems to your systems (e.g. shop and ERP).

Please consult Computop Helpdesk during conceptual design for implementing Amazon Pay. Only when all steps are properly coordinated will a functional interface be guaranteed.

This manual describes the basics for configuring and using the Computop interface for Amazon Pay as well as:

  • the parameters of the interface
  • the Batch using of the interface


Logo

Info

“Amazon Pay and Login by Amazon” is a complete checkout and payment service. It allows millions of Amazon customers to complete their purchases with using their Amazon account without leaving the web page of the visited online shop. The A-Z-guarantee from Amazon gives a comprehensive protection.

TypePayments by eWallet EN


Further information you will find also on the Web page of Amazon Pay.

On this page


Configuration for Amazon Pay

Before using Amazon Pay you need to register at https://pay.amazon.com/de/signup. On this page you can configure a notify URL. Therefore follow the menu steps Settings – Integration settings – Settings for instant notifications – Modify. Enter the Computop Integrator URL https://www.computop-paygate.com/AmazonAPANotify.aspx and save it.

The second step is generating a MWS Auth Token. Therefore go to the webpage https://developer.amazonservices.co.uk/gp/mws/registration/register.html and enter the following Computop data:

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

Then submit the received MWS Authorisation Token on a secure way to Computop Support for configuration.


Steps within the process

The basic payment process with Amazon consists of several steps:

Step

Description

Display Button-Widget

The Amazon button widget must be properly implemented on the page of the webshop and must be called for each payment/login process. Afterwards a redirect to Amazon occurs. Within the redirect data from Amazon (AccessToken, TokenType, Expiry, Scope) is delivered.

Initialize payment via Computop Paygate (Server to Server)

With the delivered data from the button widget from Amazon (AccessToken, TokenType, Expiry, Scope) the payment process via Computop Paygate is initiated. Please use Eventtoken LGN. Return parameters will include (depending on scope) customer information such as email address and UserID (unique Amazon account ID). Use this information to identify the user and compare with your data.

Load and display address and wallet widgets

Both widgets must be integrated in the shop directly. The widgets communicate directly with the shop.

It is recommended to firstly call the address widget, to buffer the „OrderReferenceID“ (OrderReferenceId is generated by address widget – and can be read out via JavaScript with„orderReference.getAmazonOrderReferenceId()“)  and to execute immediately a call of AmazonAPA.aspx with Eventtoken „SOD“ and the „orderReferenceID“ via the Computop Paygate. In return, depending on the “scope”, you will receive delivery data including city, country and postcode and you can thereby calculate standard shipping costs.

Thus the wallet only shows valid payment methods for this order.

Each modification of delivery address (if the customer selects a different address for shipping than the standard address within the widget) involves an „OnAddressSelect“– whereupon your systems must react.

Request new shipping information

After an „OnAddressSelect“ a further call of AmazonAPA.aspx via Computop Paygate is necessary with Eventtoken „GOD“. The response gives information about the new selected delivery address (only for Scope=payments:shipping_address for recalculating the shipping costs).

Now call the AmazonAPA.aspx with Eventtoken SOD, to transfer the possible new total amount for this order.

Finalize the purchase

The purchase confirmation is completed via Computop Paygate with the option of one of two Eventtokens – „SCO“ „SetOrderDetails and ConfirmOrder“or „COD“ „ConfirmOrderDetails“.

The call with Eventtoken „SCO“ is preferred, because the following steps are easier due to the automatic provision of the final delivery address (with all address details).

Nevertheless after getting the response of finalizing the order a further call of AmazonAPA.aspx with Eventtoken „GOD“ should be made, in order to notice possible delivery address changes.

After finalizing the order there already doesn’t exits a pecuniary claim against the customer. Subsequently your systems also must execute authorizations and captures.

Confirmation flow

Due to Multi-factor Authentication it is necessary after a succesful confirmation of an order to start a new Javascript call, the ConfirmationFlow. With this AmazonPay can handle the Multi-factor Authentication if required.

The changes for Multi-Factor Authentication (MFA) needed, only effect the EUR and UK Amazon Platforms.

Authorisation

The authorization of amount payable must be done within 180 days. Authorizations are valid for 30 days and expire afterwards. After expiry the amount payable can be reauthorized (within 180 days after the order).

In the response to an authorization with Amazon you receive a unique Paygate-Parameter „XID“. This parameter is a sub-transaction number, which is uniquely associated with a „PayID“ within the Paygate. Please ensure that you store this parameter together with this transaction. Within respective „XID“ no further transactions like capture or credit can be executed. Captures and credits with Amazon always must reference to an authorization or capture (authorization „blue pullover“, capture „blue pullover“, credit „blue pullover“).

For an initialized Amazon order up to ten authorizations can be submitted simultaneously. Per order lifecycle up to a maximum of 50 authorizations can be submitted.

Peculiarity for authorizations with Amazon:

There are two different authorization types: Synchronous and asynchronous authorization.

Synchronous authorizations always give a clear answer about the authorization result immediately, thus OK or FAILED.

Asynchronous authorizations are followed up by a notify, which gives an answer about the authorization result after a definable maximum time period (the notify can be returned earlier).

The maximum time period between submitting the authorization and the latest allowed status message per notify can be configured for each Paygate MID (in minutes, multiple of 5, maximum 1440 minutes – a value of 0 means synchronous authorization).

Capture

Authorizations can be captured synchronous within seven days starting from the time of authorization. This means the capture gets an „OK“ from Amazon immediately. Between seven and thirty days after authorization the captures are asynchronous and produce a notify to your notify-URL (simultaneously extended risk assessments are started at Amazon). Please ensure to start the delivery only after receiving the notify. For an authorization a capture ≤ authorization amount can be submitted. The „XID“ of the underlying authorization must be submitted to Computop Paygate for capture. Captures without XID are refused.

If a capture < authorization was submitted, the difference amount can be authorized again immediately. The Computop Paygate does not make an automatic reauthorization of the difference amount.

Conclude order process after dispatch

After end of the order process (e.g. after shipment of the last article or after successful last  capture) it is recommended, to close the process at Amazon. If the process is not closed, the customer will see an open order in his backend of Amazon Pay. Please use therefore the Eventtoken „COR“. After closing of this process captures on open authorizations as well as credits are still possible – but no further authorizations related to an order process.

Close an authorization

If an article cannot be delivered anymore (or did no longer have to be delivered) existing authorizations that are not captured can be closed. Therefore use the Eventtoken „RAN“.

Credits

According to Amazon credits can issue without time limit. This can be up to a maximum of one year in the case of Computop. For a credit the „XID“ of the underlying capture must be submitted to Computop Paygate. Credits without XID are refused. Up to ten credits are allowed per capture.

 


Integrate Button-Widget

The following example code shows how to integrate the button widget:

<div id="AmazonPayButton"/>
<script type="text/javascript">
  var authRequest;
  OffAmazonPayments.Button("AmazonPayButton", "YOUR_SELLER_ID ", {
    type:  "ENTER_TYPE_PARAMETER",
    color: "ENTER_COLOR_PARAMETER",
    size:  "ENTER_SIZE_PARAMETER",
    language: "ENTER_LANGUAGE_PARAMETER",
    authorization: function() {
      loginOptions = {scope: "ENTER_SCOPES", popup: "ENTER_POPUP_PARAMETER"};            
      authRequest = amazon.Login.authorize (loginOptions, "YOUR_REDIRECT_URL ");
    },
    onError: function(error) {
      // your error handling code
    }
  });
</script>

Notice: Because Computop has no influence on the widget code, we recommend you to follow the documentation of Amazon Pay.

In this case the following parameters must be completed within the Widget:

Parameter

Description

Value

YOUR_SELLER_ID

SellerId issued by Amazon

 

Type

The parameter Type is an optional parameter for defining the button layout of the button widget.


Permissible values:

LwA, Login, PwA,

Pay, A

Color

The parameter Color defines the color of the button widget


Permissible values:

Gold, LightGray, DarkGray

Size

The parameter Size defines the size of the button widget


Permissible values for normal display resolution:

small, medium


Permissible values for Retina Displays:

large, x-large

Language

The parameter Language 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:

en-GB, de-DE, fr-FR, it-IT, es-ES


Scope

The parameter Scope defines the scope of return parameters after the customer login as well as the contents of the consent form for the customer.

Example: scope=payments:shipping_address returns the purchaser’s delivery address.

Permissible values:

profile, profil:user_id, payments:widget, pay-ments:shipping_address, pay-ments:billing_address

 

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



Integrate address book and wallet widget

The following example code shows how to implement the address book widget:

<div id="addressBookWidgetDiv">
</div>
<script>
new OffAmazonPayments.Widgets.AddressBook({
  sellerId: 'YOUR_SELLER_ID_HERE',
  onOrderReferenceCreate: function(orderReference) {
    orderReference.getAmazonOrderReferenceId();
    // Send SetOrderDetails Request with OrderReferenceId to Computop to    
    // set the amount and get the default address    
  },
  onAddressSelect: function(orderReference) {
    // Send GetOrderDetails Request to get the selected address
  },
  design: {
    designmode: 'responsive'
  },
  onError: function(error) {
    // your error handling code
  }      
}).bind("addressBookWidgetDiv");
</script>

 

The following example code shows how to implement the wallet widget:

<div id="walletWidgetDiv">

</div>
<script>
new OffAmazonPayments.Widgets.Wallet({
  sellerId: 'YOUR_SELLER_ID_HERE',
  onPaymentSelect: function(orderReference) {
    // Replace this code with the action that you want to perform
    // after the payment method is selected.
  },
  design: {
    designMode: 'responsive'
  },
  onError: function(error) {
    // your error handling code
  }
}).bind("walletWidgetDiv");
</script>


 

The option to logout is usually a link which removes all user data from the website and then re-displays the login page via the amazon.Login.logout() method. Use the following codes for this:

<script type="text/javascript">
  document.getElementById('Logout').onclick = function() {
    amazon.Login.logout();
  };
</script>

 

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


Javascript for confirmation flow

Due to Multi Factor Authentication it is necessary after a succesful confirmation of an order to start a new call, the ConfirmationFlow.

The following example code shows how to implement the Javscript function for that:

Function confirmationFlow()

{

    // Get the ResultCode from Computop Call AmazonAPA.aspx EventToken: COR

    var resultCode_Computop = callComputopAmazonAPA_Confirmation();

    // Your AmazonSellerID / AmazonMerchantID

    var amazonSellerId = ‚ABCDEFG123456‘;

    // AmazonOrderReferenceID generated by AdressWidget

    var orderReferenceId = ‚P02-1234567-1234567‘;

    // Initiate Conformation Flow

    OffAmazonPayments.initConfirmationFlow(amazonSellerId, orderReferenceId, function (confirmationFlow) {

        if(resultCode_Computop = ‚00000000‘)

        {

            // Do confirmationFlow with Success Confirm

            confirmationFlow.success();

        }

        else

        {

            // Do confirmationFlow with Failured Confirm

            confirmationFlow.error();

        }

    });

}

 


Available Event-Token

For Amazon Pay there are numerous possible actions whose selection is controlled at the interface via the EventToken parameter.

The following table gives an overview of possible Eventtoken for AmazonAPA.aspx:

EventToken

Action

Description

LGN

Login

Initializing of a payment/login-process with Amazon via Computop Paygate

SOD

SetOrderDetails

Transfer of amount payable and further information – controls also the payment methods selectable for an order at Amazon

SCO

SetOrderDetailsAndConfirmOrder

Order confirmation again with transfer of amount payable and further information – with this Eventtoken the order is finalized. After successfully confirmation authorizations can be submitted to Amazon immediately.

COD

ConfirmOrderDetails

Optional, if amount payable and further information should not transferred once more for order confirmation (Computop recommends using the Eventtoken SCO for order confirmation.)

GOD

GetOrderDetails

Request of order information, e.g. to get information about a newly selected delivery address. After a call with Eventtoken COD or SCO, GOD returns also the billing address oft he customer

When Scope enters “payments:shipping_address” and “payments:billing_address” you receive the full delivery and shipping address after the display of the Address widget. Please transfer the OrderReferenceId on call up.

ATH

Authorize

Eventtoken for authorization

COR

CloseOrderReference

Closing an Amazon order. Captures related to open authorizations as well as credits are possible furthermore.

RAN

ReverseAuthorization

Closing an open authorization

ATD

AuthorizeDetails

Status request for an authorization

CAD

CaptureDetails

Status request for an capture

CRD

CreditDetails

Status request for an credit



Process flow chart

draw.io

Source page access restriction: Click the link below to check if the page is accessible.
/display/DEWORK/Amazon+Pay

Process flow for Amazon Pay within Paygate

Process flow for Multi-factor authentication

This action should be triggered by clicked the "Buy Now" button. When MFA is required, the Confirmation Flow (see Javascript above) shows the credit card issuer’s MFA challenge to the buyer. After the buyer interacts with the Confirmation Flow (for example, completes the MFA challenge), the buyer is returned to the merchant’s site (for example, order confirmation page). The merchant should be able to handle the redirection (URLSuccess / URLFailure) with the result of the MFA Challenge.

In case of amazonstatus=Success the purchase is completed. In case of amazonstatus=Failure or amazonStatus=Abandoned the customer is redirected to the URLFailure and the merchant should cancel the order by calling reverse,aspx (see below in chapter "Amazon Pay reverse an authorization"). The customer can be redirected to select a different payment method or in case of Abandoned to replace the order and complete the MFA challange.

Instead of the one-step solution with EventToken=SCO the process can be splitted into EventToken=SOD and EventToken=COD followed by the Confirmation Flow.

Process flow for Multi-factor authentication with Amazon Pay (amazonstatus=Success)

Process flow for failed Multi-factor authentication with Amazon Pay (amazonstatus=Failure or Abandoned)


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 visit the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

O

Unique reference number

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

CountryCode

an2

M

Country code of used marketplace. Presently only DE and GB permitted.

URLNotify

ans..256

C

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.
Optional if an URLNotify is permanently defined at the Paygate.

AccessToken

a..512

M

Parameter „access_token“ which is transferred during the redirect from Amazon after the customer has logged in. Used to request the full delivery address during the checkout process.

Important: It can be used only, if for Scope is given at least „payments:shipping_address“ within the button widget.

TokenType

ans..6

M

Parameter „token_type“ which is transferred during the redirect from Amazon after the customer has logged in.

Expiry

n..4

M

Parameter „expires_in“ which is transferred during the redirect from Amazon after the customer has logged in.

Scope

a..128

M

Parameter „scope“ which is transferred during the redirect from Amazon after the customer has logged in.

Important: Within the button widget use at least the values „profile payments:widget and payments:shipping_address“.

EventToken

enum

M

Abbreviation of the action to be done:

<LGN> = Login

OrderDesc

ans..127

O

Use this parameter for the simulation mode. During live mode this parameter has no effects.

Encrypted parameters for initializing an Amazon Pay payment


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was transferred

Shipping information

UserID

as..64

O

part of the userprofile information. Unique ID issued by Amazon per user.

BuyerName

as..50

O

part of the userprofile information. User name

BuyerMail

as..128

O

part of the userprofile information. E-mail address

AddrZip

as..128

O

part of the userprofile information. Postcode in the standard delivery address

Response parameters after initializing an Amazon Pay payment



Amazon Pay set order details

In order to confirm the order details of a payment with Amazon Pay with the function „SetOrderDetails“, please visit 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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits.

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

O

Unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..127

M

Description of purchased goods, unit prices etc.

OrderReferenceID

ans..19

O

OrderReferenceId generated by button widget or by address widget which is read out via JavaScript using „OrderReference.getAmazonOrderReferenceId()“

StoreName

ans..1024

O

Name of the shop. Is printed in email to customer.

EventToken

enum

M

Abbreviation of the action to be done:

<SOD> = SetOrderDetails

<SCO> = SetOrderDetailsAndConfirmOrder

URLSuccessans..256MThe buyer is redirected to this URL if the Multi Factor Authentication is successful.
URLFailureans..256OThe buyer is redirected to this URL if the Multi Factor Authentication is unsuccessful.
AuthorizationAmountn..10O

The amount to authenticate during Multi Factor Authentication completion.

Use this parameter if you want to set a payment amount that is different than the OrderTotal provided in the SetOrderReferenceDetails operation call.

If this parameter is not set, the amount authenticated during Multi Factor Authentication will be equal to the OrderTotal provided in the SetOrderReferenceDetails operation call.

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Encrypted parameters for calling SetOrderDetails and SetOrderDetailsAndConfirmOrder for an Amazon Pay payment


Notice: You can combine calling SetOrderDetails and ConfirmOrderDetails, if you are using EventToken <SCO> for SetOrderDetailsAndConfirmOrder.

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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was 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 .

OrderID

ans..19

M

Unique ID for the order issued by Amazon. Corresponds to the OrderReferenceID.

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Shipping information

BuyerName

a..50

O

part of the userprofile information. User name

BuyerMail

as..128

O

part of the userprofile information. E-mail address

AddrName

a..50

O

First name and surname of addressee

PhoneNumber

a..128

O

Phone number of addressee

AddrCountryCode

a2

O

Country code of delivery country according to ISO 3166

AddrState

a..50

O

Federal state of the delivery address

AddrCounty

a..50

O

County of delivery address

AddrDistrict

a..50

O

District of delivery address

AddrZip

a..20

O

Postcode in the delivery address

AddrCity

a..50

O

Town/city in the delivery address

AddrStreet

a..180

O

Company name (if given) or street name and street number

AddrStreet2

a..60

O

Street name and house number

AddrStreet3

a..60

O

Other additions

Response parameters after SetOrderDetails and SetOrderDetailsAndConfirmOrder for an Amazon Pay payment



Amazon Pay request order details

In order to request the order details of a payment with Amazon Pay with the function „GetOrderDetails“, please visit 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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits.

EventToken

a3

M

Abbreviation of the action to be done:

<GOD> = GetOrderDetails

OrderReferenceID

ans..19

O

If not already submitted for <SOD> SetOrderDetails

OrderDesc

ans..127

O

Use this parameter for the simulation mode. During live mode this parameter has no effects.

Encrypted parameters for calling GetOrderDetails for an Amazon Pay payment


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was 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 .

OrderID

ans..19

M

Unique ID for the order issued by Amazon. Corresponds to the OrderReferenceID.

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

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

Shipping information

BuyerName

a..50

O

part of the userprofile information. User name

BuyerMail

as..128

O

part of the userprofile information. E-mail address

AddrName

a..50

O

First name and surname of addressee

PhoneNumber

a..128

O

Phone number of addressee

AddrCountryCode

a2

O

Country code of delivery country according to ISO 3166

AddrState

a..50

O

Federal state of the delivery address

AddrCounty

a..50

O

County of delivery address

AddrDistrict

a..50

O

District of delivery address

AddrZip

a..20

O

Postcode in the delivery address

AddrCity

a..50

O

Town/city in the delivery address

AddrStreet

a..180

O

Company name (if given) or street name and street number

AddrStreet2

a..60

O

Street name and house number

AddrStreet3

a..60

O

Other additions

Billing address (only for Scope="payments:billing_address")

bdAddrName

a..50

O

First name and surname of addressee in the billing address

bdPhoneNumber

a..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of the billing country according to ISO 3166

bdAddrState

a..50

O

Federal state in the invoicing address

bdAddrCounty

a..50

O

County of billing address

bdAddrDistrict

a..50

O

District of billing address

bdAddrZip

a..20

O

Postcode in the invoicing address

bdAddrCity

a..50

O

Name of town/city in the billing address

bdAddrStreet

a..180

O

Company name (if given) or street name and street number in the billing address

bdAddrStreet2

a..60

O

Street name and street number in the billing address

bdAddrStreet3

a..60

O

Other additions in the billing address

Response parameters after GetOrderDetails of an Amazon Pay payment



Amazon Pay confirm order details

In order to confirm the order details of a payment with Amazon Pay with the function „ConfirmOrderDetails“, please visit 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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits.

RefNr

ans..30

O

Merchant’s unique reference number

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

EventToken

a3

M

Abbreviation of the action to be done: <COD> = ConfirmOrderDetails

URLSuccessans..256MThe buyer is redirected to this URL if the Multi Factor Authentication is successful.
URLFailureans..256OThe buyer is redirected to this URL if the Multi Factor Authentication is unsuccessful.
URLNotifyans..256MComplete 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.
AuthorizationAmountn..10O

The amount to authenticate during Multi Factor Authentication completion.

Use this parameter if you want to set a payment amount that is different than the OrderTotal provided in the SetOrderReferenceDetails operation call.

If this parameter is not set, the amount authenticated during Multi Factor Authentication will be equal to the OrderTotal provided in the SetOrderReferenceDetails operation call.

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Encrypted parameters for calling ConfirmOrderDetails for an Amazon Pay payment


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was 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 .

OrderID

ans..19

M

Unique ID for the order issued by Amazon. Corresponds to the OrderReferenceID.

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

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

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Shipping information

BuyerName

a..50

O

part of the userprofile information. User name

BuyerMail

as..128

O

part of the userprofile information. E-mail address

AddrName

a..50

O

First name and surname of addressee

PhoneNumber

a..128

O

Phone number of addressee

AddrCountryCode

a2

O

Country code of delivery country according to ISO 3166

AddrState

a..50

O

Federal state of the delivery address

AddrCounty

a..50

O

County of delivery address

AddrDistrict

a..50

O

District of delivery address

AddrZip

a..20

O

Postcode in the delivery address

AddrCity

a..50

O

Town/city in the delivery address

AddrStreet

a..180

O

Company name (if given) or street name and street number

AddrStreet2

a..60

O

Street name and house number

AddrStreet3

a..60

O

Other additions

Billing address (only for Scope="payments:billing_address")

bdAddrName

a..50

O

First name and surname of addressee in the billing address

bdPhoneNumber

a..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of the billing country according to ISO 3166

bdAddrState

a..50

O

Federal state in the invoicing address

bdAddrCounty

a..50

O

County of billing address

bdAddrDistrict

a..50

O

District of billing address

bdAddrZip

a..20

O

Postcode in the invoicing address

bdAddrCity

a..50

O

Name of town/city in the billing address

bdAddrStreet

a..180

O

Company name (if given) or street name and street number in the billing address

bdAddrStreet2

a..60

O

Street name and street number in the billing address

bdAddrStreet3

a..60

O

Other additions in the billing address

Response parameters after ConfirmOrderDetails of an Amazon Pay payment


In case of an error (e.g. if Amazon refuses the payment) you get a notify to your specified URLNotify with following parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was 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 .

NotificationType

a..25

M

Describes the type of notification. Fixed value: <OrderNotification>

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Response parameters to URLNotify after ConfirmOrderDetails for an Amazon Pay payment



Amazon Pay finalize authorization

In order to authorize a payment with Amazon Pay, please visit 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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits.

TransID

ans..32

M

Merchant’s transaction number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

RefNr

ans..30

O

Merchant’s unique reference number

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Capture

a..6

O

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696).

OrderDesc

ans..127

M

Description of purchased goods, unit prices etc. for authorization

ChDesc

ans..16

O

Text printed on the customer’s credit card bill alongside the payee (only for Capture=AUTO or Capture=<NUMBER>)

EventToken

enum

M

Abbreviation of the action to be done: <ATH> = Authorize

Encrypted parameters for authorizing an Amazon Pay payment


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits.

XID

an32

M

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

TransID

ans..64

M

Merchant transaction number for authorization

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was transferred

AmazonStatus

a..20

M

Order status at Amazon. Following values are possible: „Pending“, „Open“, „Declined“, „Abandoned“, „Closed“. Details see Amazon API Reference Guide .

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

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

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

Shipping information

BuyerName

a..50

O

part of the userprofile information. User name

BuyerMail

as..128

O

part of the userprofile information. E-mail address

AddrName

a..50

O

First name and surname of addressee

PhoneNumber

a..128

O

Phone number of addressee

AddrCountryCode

a2

O

Country code of delivery country according to ISO 3166

AddrState

a..50

O

Federal state of the delivery address

AddrCounty

a..50

O

County of delivery address

AddrDistrict

a..50

O

District of delivery address

AddrZip

a..20

O

Postcode in the delivery address

AddrCity

a..50

O

Town/city in the delivery address

AddrStreet

a..180

O

Company name (if given) or street name and street number

AddrStreet2

a..60

O

Street name and house number

AddrStreet3

a..60

O

Other additions

Invoicing address

bdAddrName

a..50

O

First name and surname of addressee in the billing address

bdPhoneNumber

a..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of the billing country according to ISO 3166

bdAddrState

a..50

O

Federal state in the invoicing address

bdAddrCounty

a..50

O

County of billing address

bdAddrDistrict

a..50

O

District of billing address

bdAddrZip

a..20

O

Postcode in the invoicing address

bdAddrCity

a..50

O

Name of town/city in the billing address

bdAddrStreet

a..180

O

Company name (if given) or street name and street number in the billing address

bdAddrStreet2

a..60

O

Street name and street number in the billing address

bdAddrStreet3

a..60

O

Other additions in the billing address

Response parameters after authorization of an Amazon Pay payment


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits.

XID

an32

M

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

TransID

ans..64

M

Merchant transaction number for authorization

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was transferred

AmazonStatus

a..20

M

Order status at Amazon. Following values are possible: „Pending“, „Open“, „Declined“, „Abandoned“, „Closed“. Details see Amazon API Reference Guide .

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

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

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

Shipping information

BuyerName

a..50

O

part of the userprofile information. User name

BuyerMail

as..128

O

part of the userprofile information. E-mail address

AddrName

a..50

O

First name and surname of addressee

PhoneNumber

a..128

O

Phone number of addressee

AddrCountryCode

a2

O

Country code of delivery country according to ISO 3166

AddrState

a..50

O

Federal state of the delivery address

AddrCounty

a..50

O

County of delivery address

AddrDistrict

a..50

O

District of delivery address

AddrZip

a..20

O

Postcode in the delivery address

AddrCity

a..50

O

Town/city in the delivery address

AddrStreet

a..180

O

Company name (if given) or street name and street number

AddrStreet2

a..60

O

Street name and house number

AddrStreet3

a..60

O

Other additions

Invoicing address

bdAddrName

a..50

O

First name and surname of addressee in the billing address

bdPhoneNumber

a..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of the billing country according to ISO 3166

bdAddrState

a..50

O

Federal state in the invoicing address

bdAddrCounty

a..50

O

County of billing address

bdAddrDistrict

a..50

O

District of billing address

bdAddrZip

a..20

O

Postcode in the invoicing address

bdAddrCity

a..50

O

Name of town/city in the billing address

bdAddrStreet

a..180

O

Company name (if given) or street name and street number in the billing address

bdAddrStreet2

a..60

O

Street name and street number in the billing address

bdAddrStreet3

a..60

O

Other additions in the billing address

Response parameters to URLNotify after authorization of an Amazon Pay payment



Amazon Pay capture a payment

In order to capture an authorized payment with Amazon Pay, please visit 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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits

XID

an32

M

ID for the transaction given by Paygate. Transfer here the XID of the authorization that should be captured.

TransID

ans..64

M

ID assigned by Merchant for the payment process to be captured

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

RefNr

ans..30

O

Merchant’s unique reference number

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

ChDesc

ans..16

O

Text printed on the customer’s credit card bill alongside the payee

OrderDesc

ans..127

M

Use this parameter for the simulation mode. During live mode this parameter has no effects.

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Encrypted parameters for capturing an authorized Amazon Pay payment


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

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

TransID

ans..64

M

Merchant transaction number for capture

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK, PENDING or FAILED

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!

Code

n8

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 it was transferred

AmazonStatus

a..20

M

Order status at Amazon. Following values are possible: „Pending“, „Declined“, „Completed“, „Closed“. Details see Amazon API Reference Guide .

OrderID

ans..19

M

Unique ID for the order issued by Amazon. Corresponds to the OrderReferenceID.

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

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:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

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

TransID

ans..64

M

Merchant transaction number for capture

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was transferred

AmazonStatus

a..20

M

Order status at Amazon. Following values are possible: „Pending“, „Declined“, „Completed“, „Closed“. Details see Amazon API Reference Guide .

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

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

AmountAuth

n..10

M

Total amount which is reserved at Amazon

AmountCap

n..10

M

Total amount which is already sucessfully captured at Amazon

AmountCred

n..10

M

Total amount which is already sucessfully 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 visit 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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment

XID

an32

M

ID for the transaction given by Paygate. Transfer here the XID of the capture that should be credited.

TransID

ans..64

M

ID assigned by Merchant for the payment process to be credited

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

RefNr

ans..30

O

Merchant’s unique reference number

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

ChDesc

ans..16

O

Text printed on the customer’s credit card bill alongside the payee

OrderDesc

ans..127

M

Description of purchased goods, unit prices etc. for authorization

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Encrypted parameters for crediting an Amazon Pay payment


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

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

TransID

ans..64

M

Merchant transaction number for credit

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

REQUEST (Because credits are not carried our real time, the status is always pending.)

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!

Code

n8

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 it was transferred

AmazonStatus

a..20

M

Order status at Amazon. Following values are possible: „Pending“, „Declined“, „Completed“. Details see Amazon API Reference Guide .

OrderID

ans..19

M

Unique ID for the order issued by Amazon. Corresponds to the OrderReferenceID.

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

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:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

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

TransID

ans..64

M

Merchant transaction number for capture

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was transferred

AmazonStatus

a..20

M

Order status at Amazon. Following values are possible: „Pending“, „Declined“, „Completed“. Details see Amazon API Reference Guide .

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

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

AmountAuth

n..10

M

Total amount which is reserved at Amazon

AmountCap

n..10

M

Total amount which is already sucessfully captured at Amazon

AmountCred

n..10

M

Total amount which is already sucessfully 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 close an order

In order to close an order with Amazon Pay with the function „CloseOrder“, please visit 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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits.

EventToken

an3

M

Abbreviation of the action to be done:

<COR> = CloseOrderReference

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..127

O

Use this parameter for the simulation mode. During live mode this parameter has no effects.

Encrypted parameters for closing an Amazon Pay payment


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was transferred

AmazonStatus

a..20

M

Order status at Amazon. Following values are possible: „Pending“, „Declined“, „Completed“. Details see Amazon API Reference Guide .

OrderID

ans..19

M

Unique ID for the order issued by Amazon. Corresponds to the OrderReferenceID.

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

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

Shipping information

BuyerName

a..50

O

part of the userprofile information. User name

BuyerMail

as..128

O

part of the userprofile information. E-mail address

AddrName

a..50

O

First name and surname of addressee

PhoneNumber

a..128

O

Phone number of addressee

AddrCountryCode

a2

O

Country code of delivery country according to ISO 3166

AddrState

a..50

O

Federal state of the delivery address

AddrCounty

a..50

O

County of delivery address

AddrDistrict

a..50

O

District of delivery address

AddrZip

a..20

O

Postcode in the delivery address

AddrCity

a..50

O

Town/city in the delivery address

AddrStreet

a..180

O

Company name (if given) or street name and street number

AddrStreet2

a..60

O

Street name and house number

AddrStreet3

a..60

O

Other additions

Invoicing address

bdAddrName

a..50

O

First name and surname of addressee in the billing address

bdPhoneNumber

a..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of the billing country according to ISO 3166

bdAddrState

a..50

O

Federal state in the invoicing address

bdAddrCounty

a..50

O

County of billing address

bdAddrDistrict

a..50

O

District of billing address

bdAddrZip

a..20

O

Postcode in the invoicing address

bdAddrCity

a..50

O

Name of town/city in the billing address

bdAddrStreet

a..180

O

Company name (if given) or street name and street number in the billing address

bdAddrStreet2

a..60

O

Street name and street number in the billing address

bdAddrStreet3

a..60

O

Other additions in the billing address

Response parameters after authorization 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 visit 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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Reason

a..1024

O

Reason for reversal

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Encrypted parameters for reversal of an Amazon Pay payment


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

M

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

OrderID

ans..19

M

Unique ID for the order issued by Amazon. Corresponds to the OrderReferenceID.

Currency

a3

M

Currency, three digits DIN / ISO 4217

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


Notice: If you are reversing an order completely, you will get also a notify like for an incorrect order as described above.



Amazon Pay reverse an authorization

In order to reverse a single authorization with Amazon Pay with the function „CancelAuthorize“, please visit 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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment

XID

an32

M

ID for the transaction given by Paygate. Transfer here the XID of the authorization that should be reversed.

Reason

as..1024

M

Reason for reversal

EventToken

an3

M

Abbreviation of the action to be done: <RAN> = ReverseAuthorization

Encrypted parameters for reverse an Amazon Pay authorization


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was transferred

AmazonStatus

a..20

M

Order status at Amazon. Following values are possible: „Pending“, „Open“, „Declined“, „Closed“. Details see Amazon API Reference Guide .

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

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

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

Shipping information

BuyerName

a..50

O

part of the userprofile information. User name

BuyerMail

as..128

O

part of the userprofile information. E-mail address

AddrName

a..50

O

First name and surname of addressee

PhoneNumber

a..128

O

Phone number of addressee

AddrCountryCode

a2

O

Country code of delivery country according to ISO 3166

AddrState

a..50

O

Federal state of the delivery address

AddrCounty

a..50

O

County of delivery address

AddrDistrict

a..50

O

District of delivery address

AddrZip

a..20

O

Postcode in the delivery address

AddrCity

a..50

O

Town/city in the delivery address

AddrStreet

a..180

O

Company name (if given) or street name and street number

AddrStreet2

a..60

O

Street name and house number

AddrStreet3

a..60

O

Other additions

Invoicing address

bdAddrName

a..50

O

First name and surname of addressee in the billing address

bdPhoneNumber

a..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of the billing country according to ISO 3166

bdAddrState

a..50

O

Federal state in the invoicing address

bdAddrCounty

a..50

O

County of billing address

bdAddrDistrict

a..50

O

District of billing address

bdAddrZip

a..20

O

Postcode in the invoicing address

bdAddrCity

a..50

O

Name of town/city in the billing address

bdAddrStreet

a..180

O

Company name (if given) or street name and street number in the billing address

bdAddrStreet2

a..60

O

Street name and street number in the billing address

bdAddrStreet3

a..60

O

Other additions in the billing address

Response parameters after reversal of an Amazon Pay authorization


Notice: If you reverse an authorization you will also get a notify similar to the above described notify for authorization.



Amazon Pay request authorization details

In order to request the details of an authorization with Amazon Pay, please visit 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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits

XID

an32

M

ID issued by Paygate for the authorization for which details should be requested

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..127

O

Use this parameter for the simulation mode. During live mode this parameter has no effects.

EventToken

an3

M

Abbreviation of the action to be done:

<ATD> = AuthorizeDetails

Encrypted parameters for requesting details of an Amazon Pay authorization


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was transferred

AmazonStatus

a..20

M

Order status at Amazon. Following values are possible: „Pending“, „Open“, „Declined“, „Closed“. Details see Amazon API Reference Guide .

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

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

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

Shipping information

BuyerName

a..50

O

part of the userprofile information. User name

BuyerMail

as..128

O

part of the userprofile information. E-mail address

AddrName

a..50

O

First name and surname of addressee

PhoneNumber

a..128

O

Phone number of addressee

AddrCountryCode

a2

O

Country code of delivery country according to ISO 3166

AddrState

a..50

O

Federal state of the delivery address

AddrCounty

a..50

O

County of delivery address

AddrDistrict

a..50

O

District of delivery address

AddrZip

a..20

O

Postcode in the delivery address

AddrCity

a..50

O

Town/city in the delivery address

AddrStreet

a..180

O

Company name (if given) or street name and street number

AddrStreet2

a..60

O

Street name and house number

AddrStreet3

a..60

O

Other additions

Invoicing address

bdAddrName

a..50

O

First name and surname of addressee in the billing address

bdPhoneNumber

a..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of the billing country according to ISO 3166

bdAddrState

a..50

O

Federal state in the invoicing address

bdAddrCounty

a..50

O

County of billing address

bdAddrDistrict

a..50

O

District of billing address

bdAddrZip

a..20

O

Postcode in the invoicing address

bdAddrCity

a..50

O

Name of town/city in the billing address

bdAddrStreet

a..180

O

Company name (if given) or street name and street number in the billing address

bdAddrStreet2

a..60

O

Street name and street number in the billing address

bdAddrStreet3

a..60

O

Other additions in the billing address

Response parameters for requesting details of an Amazon Pay authorization



Amazon Pay request capture details

In order to request the details of a capture with Amazon Pay, please visit 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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits

XID

an32

M

ID issued by Paygate for the capture for which details should be requested

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

EventToken

an3

M

Abbreviation of the action to be done:

<CAD> = CaptureDetails

Encrypted parameters for requesting details of an Amazon Pay capture


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was transferred

AmazonStatus

a..20

M

Order status at Amazon. Following values are possible: „Pending“, „Declined“, „Completed“, „Closed“. Details see Amazon API Reference Guide .

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

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

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 for requesting details of an Amazon Pay capture



Amazon Pay request credit details

In order to request the details of a credit with Amazon Pay, please visit 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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter. See separate appendix to the programming manual for cancellation error messages and their causes.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits.

XID

an32

M

ID issued by Paygate for the credit for which details should be requested

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

EventToken

an3

M

Abbreviation of the action to be done:

<CRD> = CreditDetails

Encrypted parameters for requesting details of an Amazon Pay credit


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID issued by the Paygate for the payment, e.g. for the referencing of cancellations, captures and credits

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

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!

Code

n8

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 it was transferred

AmazonStatus

a..20

M

Order status at Amazon. Following values are possible: „Pending“, „Declined“, „Completed“, „Closed“. Details see Amazon API Reference Guide .

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

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

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 for requesting details of an Amazon Pay credit



Batch processing via the interface

Basic information about using Batch files and about their structure you can find inside the separate manual for the Batch manager. Within batch processing not alle functions are available which are usually available for the online interface.

This section describes the parameters which must be transferred within the data set (Record) for executing a payment with Amazon Pay and which information can be found within the response file about the payment status.

For Amazon Pay the transactions AUTHORIZE, CAPTURE, CREDIT, COR, REVERSE and RAN are possible via Batch. Batch versions X.0; X.1; 1.X and 2.X are supported.

Following table gives an overview of all batch versions that are possible for a specific action an their specialities:

Action

Version

Description

Authorize

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Capture

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Credit

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

COR

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Reverse

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

RAN

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2x.

with RefNr (valid for all versions other than 1.0)

Description of the possible batch versions


The structure for a payment with Amazon Pay within a Batch file to be submitted is the following:

HEAD,<MerchantID>,<Date>,<Version>

AmazonAPA,AUTHORIZE,(<MID>,)<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,<Capture>(,<ChDesc>,<OrderDesc>)

AmazonAPA,CAPTURE,(<MID>,)<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,<AuthXID>(,<ChDesc>,<OrderDesc>)

AmazonAPA,CREDIT,(<MID>,)<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,<CapXID>(,<ChDesc>,<OrderDesc>)

AmazonAPA,COR,(<MID>,)<PayID>

AmazonAPA,REVERSE,(<MID>,)<PayID>(,<Reason>)

AmazonAPA,RAN,(<MID>,)<PayID>,<AuthXID>(,<Reason>)

FOOT,<CountRecords>,<SumAmount>


Example for Master MID Funktion:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount


The following table describes the individual fields and values used within the data set (record) within the batch file:

Parameter

Format

CND

Description

Type

a..11

M

HEAD for Header, FOOT for Footer, AmazonAPA for Amazon Pay

Action

a..20

M

The parameter Action defines the type of transaction:

AUTHORIZE (authorization)

CAPTURE (Capture)

CREDIT (Credit)

COR (CloseOrderReference – Close order)

REVERSE (cancellation)

RAN (ReverseAuthorize – cancel authorization)

MID

ans..30

C

MerchantID, assigned by Computop. Must be submitted only in Version 2.X.

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency code, three digits DIN / ISO 4217

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

O

Unique reference number

PayID

an32

M

ID assigned by Paygate for this transaction and for further reference

Capture

a..6

M

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696).

AuthXID

an32

M

ID assigned by Paygate for all single transactions (authorization, capture, credit), which are made for one payment. Transfer here the XID of the authorization that should be captured.

CapXID

an32

M

ID assigned by Paygate for all single transactions (authorization, capture, credit), which are made for one payment. Transfer here the XID of the capture that should be credited.

ChDesc

ans..16

OC

Optional: Text printed on the customer’s credit card bill alongside the payee (only for Capture=AUTO or Capture=<NUMBER>)

OrderDesc

ans..127

O

Description of purchased goods, unit prices etc.

Reason

ans..1024

O

Reason for reversal

Description of fields within the record for Batch files

 

The record area within the response file for Batch transactions looks the following way:

AmazonAPA,AUTHORIZE,(<MID>,)<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,<Capture>,(<ChDesc>,)(<OrderDesc>,)<Status>,(<Code>,)<AuthXID>,<AmazonStatus>,<OrderID>,<AmazonRefId>,<AmountAuth>,<AmountCap>,<AmountCred>

AmazonAPA,CAPTURE,(<MID>,)<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,<AuthXID>,(<ChDesc>,)(<OrderDesc>,)<Status>,(<Code>,)<CapXID>,<AmazonStatus>,<OrderID>,<AmazonRefId>,<AmountAuth>,<AmountCap>,<AmountCred>

AmazonAPA,CREDIT,(<MID>,)<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,<CapXID>,(<ChDesc>,)(<OrderDesc>,)<Status>,(<Code>,)<CredXID>,<AmazonStatus>,<OrderID>,<AmazonRefId>,<AmountAuth>,<AmountCap>,<AmountCred>

AmazonAPA,COR,(<MID>,)<PayID>,<Status>,(<Code>,)<AmazonStatus>,<OrderID>,<AmountAuth>,<AmountCap>,<AmountCred>

AmazonAPA,REVERSE,(<MID>,)<PayID>,(<Reason>,)<Status>,(<Code>,)<OrderId>

AmazonAPA,RAN,(<MID>,)<PayID>,<AuthXID>,(<Reason>,)<Status>,(<Code>,)<AmazonStatus>,<OrderID>,<AmazonRefId>,<AmountAuth>,<AmountCap>,<AmountCred>

 

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> correspond to the call as specified above):

Parameter

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction like capture or credit.

PayID

an32

M

ID for this transaction given by Paygate

Status

a..50

M

OK or FAILED

Code

n8

M

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

AuthXID

an32

M

ID assigned by Paygate for the authorization

CapXID

an32

M

ID assigned by Paygate for the capture

CredXID

an32

M

ID assigned by Paygate for the credit

AmazonStatus

a..20

M

Order status at Amazon. The available values depend on the Action already carried out and correspond to the values explained above as with the direct implementation of this action via the interface. Details see Amazon API Reference Guide .

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

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

Description of result parameters within the record for Batch files