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 Recurring

General information about Amazon Pay Recurring

The processing of recurring payments with Amazon Pay Recurring requires the precise and timely coordinated teamwork of several separately working systems.

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 Recurring. 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 Recurring as well as the interface parameters. The initial configuration equals to that for Amazon Pay.


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.

Configuration for Amazon Pay

Before using Amazon Pay you register at https://pay.amazon.com/de/signup. At this page you configure your notification URL. Therefore follow the menu Settings – Integration settings – Sofort notify settings – Modify. Enter the Computop Integrator URL https://www.computop-paygate.com/AmazonAPANotify.aspx and save it.

In the second step generate a MWS Auth Token. Therefore go to the website https://developer.amazonservices.de/gp/mws/registration/register.html and enter the following Computop identifiers:

Developer name: Computop GmbH
Developer account number: 0143-6461-8727

Communicate the finally received MWS Authorisation Token via a safe method to Computop Support for setting up.


On this page

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, wallet and content widgets

All three 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 „BillingAgreementId“ (BillingAgreementId is generated by address widget – and can be read out via JavaScript with„billingAgreement.getBillingAgreementId()“) and to execute immediately a request of AmazonAPA.aspx with Eventtoken „SBA“ and the „BillingAgreementID“ 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.

Please ensure that the „BillingAgreementID“ is stored together with the transaction as this will be needed for recurring authorizations.

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 request 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).

Obtaining payment consent

Make sure with the function „onConsent“ of Consent Widget that the customer has agreed with a recurring payment. If customer does not confirm the Confirm in the subsequent request fails.

Finalize the purchase

The confirmation of purchase takes place also via Computop Paygate optionally with one out of three event token – „SCA“ „SetBillingAgreement and Confirm and Authorize“, „SCB“ „SetBillingAgreement and Confirm“ or „COB“ „Confirm“.

The request with event token „SCA“ is preferable, if you want to make an authorization immediately after the purchase. This request gives you the final delivery address as well as the „XID“ for capturing the authorization. With parameter „CAPTURE=AUTO“ the authorization is captured immediately. 

The request with event token „SCB“ is preferable, if you don't make an authorization immediately after the purchase. The authorization will be made separately with event token „ABA“. The request simplifies the following steps because the final delivery address (with all address details) is returned automatically.

If you haven't executed an authorization there also is no payment claim against the customer. Subsequently your systems also must execute authorizations and captures.

Check Billing Agreement

In order to check the BillingAgreement please use event token „VBA“ „Validate Billing Agreement“. This step is optional.

Authorisation

With the BillingAgreement created now you can make an authorization. Therefore among other things submit the BillingAgreementId within the request with event token „ABA“. This is the Amazon reference for the agreement between the merchant and the customer. The response parameters AmountLimitPerTimePeriod and CurrentRemainingBalanceAmount specify the maximum total amount to be authorized respectively the still remaining amount to be authorized within a time period. Please note that the upper limit has to be negotiated with Amazon Pay.

Us the parameter „CAPTURE=AUTO“ in order to capture the amount immediately. For each following delivery repeat this process until termination of agreement with the customer.

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.

Conclude order process after dispatch

After completion of a first payment (e.g. delivery of goods within the subscription) it is recommended to close this single transaction with Amazon. The customer is notified by email that this single delivery is finished and no further authorizations will be made. The customer can see in the Amazon Pay backend that the process is finished. Please use therefore the Eventtoken „COR“. After closing of this process captures on open authorizations as well as credits are still posssible – but no further authorizations related to an order process.

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, wallet and consent 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',

  agreementType: 'BillingAgreement',

  onReady: function (billingAgreement) {

     billingAgreement.getAmazonBillingAgreementId();

     // Send Request to AmazonAPA.aspx with Eventtoken SBA

     // (“SetBillingAgreement”) and BillingAgreementId to Computop Paygate

     // or save the BillingAgreementId for Request with Eventtoken SCA or

     // SCB

  },

  onAddressSelect: function(billingAgreement) {

    // Send Request to AmazonAPA.aspx with Eventtoken GBA

    // (“GetBillingDetails”) to get the selected address to Computop

    // Paygate

  },

  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',

  // amazonBillingAgreementId obtained from the AddressBook widget

  amazonBillingAgreementId: amazonBillingAgreementId,

  onPaymentSelect: function(orderReference) {

    // Send Request to AmazonAPA.aspx with Eventtoken GBA

    // (“GetBillingDetails”) to get the selected billing address

    // to Computop Paygate

  },

  design: {

    designMode: 'responsive'

  },

  onError: function(error) {

    // your error handling code

  }

}).bind("walletWidgetDiv");

</script>

 

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

 

<div id=" consentWidgetDiv">

</div>

<script>

new OffAmazonPayments.Widgets.Consent({  sellerId: 'YOUR_SELLER_ID_HERE',  // amazonBillingAgreementId obtained from the Amazon Address Book   // widget.   amazonBillingAgreementId: amazonBillingAgreementId,   design: {    designMode: 'responsive'  },  onReady: function(billingAgreementConsentStatus){    // Called after widget renders    buyerBillingAgreementConsentStatus =      billingAgreementConsentStatus.getConsentStatus();    // getConsentStatus returns true or false    // true – checkbox is selected    // false – checkbox is unselected - default  },  onConsent: function(billingAgreementConsentStatus) {    buyerBillingAgreementConsentStatus =      billingAgreementConsentStatus.getConsentStatus();    // getConsentStatus returns true or false    // true – checkbox is selected – buyer has consented    // false – checkbox is unselected – buyer has not consented     // Replace this code with the action that you want to perform    // after the consent checkbox is selected/unselected.   },  onError: function(error) {    // your error handling code   }}).bind("consentWidgetDiv ");

</script>

 

The option for cancellations usually is a link to remove all user information from the website. Extend this process with the following code to remove customer's user information from the browser cache:

<script type="text/javascript">

  document.getElementById('Logout').onclick = function() {

    amazon.Login.logout();

  };

</script>

 

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


Available Event-Token

For Amazon Pay Recurring 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

SBA

SetBillingAgreement

Transmission of BillingAgreementID and return of delivery address (depending on scope in Button Widget).

SCA

SetBillingAgreement and Confirm and Authorize

Order confirmation and simultaneous first authorization – with this event token the order is finished and the first authorization will be made. In case of successful confirmation further authorizations can be submitted to Amazon

SCB

SetBillingAgreement and Confirm

Order confirmation – with this Eventtoken the order is finalized. After successfully confirmation authorizations can be submitted to Amazon immediately.

COB

Confirm Billing Agreement

Optional, if the order confirmation has to be carried out separately. (Computop recommends using event token SCB or SCA for order confirmation)

GBA

GetBillingAgreement

Request of information about BillingAgreement, e.g. to get information about a newly selected delivery address. After a request with event token SCA, SCB or COB, GOD returns also the billing address of the 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.

ABA

Authorize

Event token for authorization. The request uses the BillingAgreementID and initiates a new transaction (PayID) with Computop.

CLB

Close Billing Agreement

Close a recurring order with Amazon. Captures related to open authorizations as well as credits are possible furthermore.

VBA

Validate Billing Agreement

Validation of a Billing Agreement.

ATD

AuthorizeDetails

Status request for an authorization

CAD

CaptureDetails

Status request for an capture

CRD

CreditDetails

Status request for an credit


Process flow charts

Process flow for Amazon Pay Recurring within Paygate

 

Please note that calling event token SCB in step 56 can be replaced with request with event token SCA. By this way together with the confirmation also an authorization of the requested amount is made and den validation request in step 61 becomes superfluous.

Process flow for Amazon Pay Recurring EventToken=SCA within Paygate

 

Then the authorization of recurring payments is done with one request.

Process flow for Amazon Pay Recurring EventToken=APA within Paygate

Test Amazon Pay Recurring

The usual simulation options are available for Amazon Pay Recurring. Merchants can simulate errors with transferring the value „TEST:[last 4 digits ErrorCode]“ in the parameter „OrderDesc“ and a successful payment with transferrring „TEST:0000“.

Furthermore there is a possibility to check errors with Amazon Pay and thus receiving also error messages form the downstream system. In order to do this transmit the „Simulation String“ (see Amazon documentation) in the parameter „OrderDesc“ within the appropriate request. Further details can be found in the documentation from Amazon Pay.


Allocate address parameters to an address

For different requests Computop Paygate returns address parameters (e.g. for the request with event token=GBA (Get Billing Agreement Details)). Following pseudo code may help for mapping of address data for customers in DE and AT in your backend system. The description is valid for delivery address parameters as well as invoicing address parameters.

if (AddrCountryCode in ("AT","DE")) {

   if (addrstreet3 != "") {

      Street = addrstreet3

      if (addrstreet1 isNumber or addrstreet1 + addrstreet2 contains “Packstation”) {

         PO box = addrstreet1 + addrstreet2

      }

      else{

         Company = addrstreet1 + addrstreet2

      }

      } else if (addrstreet2 != "") {

         Street = addrstreet2

         if (addrstreet1 isNumber or addrstreet1 contains “Packstation”) {

            PO box = addrstreet1

         } else {

            Company = addrstreet1

         }

      } else if (addrstreet1 != "") {

         Street = addrstreet1

      }

   } else {

      Street = “”

      if (addrstreet1 != "") {

         Street .= addrstreet1

      }

      if (addrstreet2 != "") {

         Street .= addrstreet2

     }

     if (addrstreet3 != "") {

         Street .= addrstreet3

     }

}




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.


Amazon Pay Recurring: Login

In order to make the login with Amazon Pay, go to 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.

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 login with Amazon Pay Recurring


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

ans..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 login with Amazon Pay Recurring



Amazon Pay Recurring: SetBillingAgreementDetails

In order to transfer the details of BillingAgreement to Amazon, 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.

Notice: Requesting the interface SetBillingAgreementDetails is not necessary if you use the request SetBillingAgreement and Confirm (Eventtoken=“SCB“).

Notice: Please note that optional address parameters are transferred only if correct scope is given within the Button-Widget. Depending on scope the invoicing address data can be transferred already before completion of payment. See also description of scope at section „Integrate Button-Widget“.

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

MAC

an64

M

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

OrderDesc

ans..126

O

Description of purchased goods, unit prices etc. This will be displayed in the email from Amazon to customer.

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

CustomInformation

ans..256

O

Additional information that should be store with the Billing-Agreement

StoreName

ans..1024

O

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

EventToken

enum

M

Abbreviation of the action to be done:

<SBA> = SetBillingAgreementDetails

Encrypted parameters for SetBillingAgreementDetails with Amazon Pay Recurring


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“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

AmountLimitPerTimePeriod

n..7

M

Limit set by Amazon for the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrencyLimitPerTimePeriod

a3

M

Currency for the determined limit according to ISO 4217

PeriodStart

an10

M

Start of time interval in the format DD.MM.YYYY

PeriodEnd

an10

M

End of time interval in the format DD.MM.YYYY

CurrentRemainingBalanceAmount

n..7

M

Remaining limit of the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrentRemainingBalanceCurrency

a3

M

Currency for the remaining limit according to ISO 4217

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

ans..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

an..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

ans..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of delivery country of the invoicing address 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

an..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 returned from SetBillingAgreement with Amazon Pay Recurring



Amazon Pay Recurring: GetBillingAgreementDetails

To request data for a BillingAgreement, please enter 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.

Notice: Please note that optional address parameters are transferred only if correct scope is given within the Button-Widget. Depending on scope the invoicing address data can be transferred already before completion of payment. See also description of scope at section „Integrate Button-Widget“.

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

C

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

If PayID is already available then this should be transmitted. Otherwise als the BillingAgreementId can be transmitted.

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

OrderDesc

ans..126

O

Description of purchased goods, unit prices etc. This will be displayed in the email from Amazon to customer.

BillingAgreementID

ans..64

C

Is created at loading time of address widget (see above).

If PayID is not specified and the BillingAgreementID was not already transmitted to Computop then the BillingAgreementID must be specified.

CountryCode

a2

C

If PayID was not specified: 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 a PayID is specified ot an URLNotify is permanently defined at the Paygate.

EventToken

enum

M

Abbreviation of the action to be done:

<GBA> = GetBillingAgreementDetails

Encrypted parameters for GetBillingAgreementDetails with Amazon Pay Recurring


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“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

AmountLimitPerTimePeriod

n..7

M

Limit set by Amazon for the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrencyLimitPerTimePeriod

a3

M

Currency for the determined limit according to ISO 4217

PeriodStart

an10

M

Start of time interval in the format DD.MM.YYYY

PeriodEnd

an10

M

End of time interval in the format DD.MM.YYYY

CurrentRemainingBalanceAmount

n..7

M

Remaining limit of the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrentRemainingBalanceCurrency

a3

M

Currency for the remaining limit according to ISO 4217

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

ans..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

an..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

ans..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of delivery country of the invoicing address 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

an..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 returned from GetBillingAgreement with Amazon Pay Recurring



Amazon Pay Recurring: ConfirmBillingAgreement

In order to transfer the customer's acknowledgement of BillingAgreement to Amazon, 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.

Notice: Please note that optional address parameters are transferred only if correct scope is given within the Button-Widget. Depending on scope the invoicing address data can be transferred already before completion of payment. See also description of scope at section „Integrate Button-Widget“.

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

EventToken

enum

M

Abbreviation of the action to be done:

<COB> = ConfirmBillingAgreement

Parameters for confirming the BillingAgreement with Amazon Pay Recurring


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“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

AmountLimitPerTimePeriod

n..7

M

Limit set by Amazon for the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrencyLimitPerTimePeriod

a3

M

Currency for the determined limit according to ISO 4217

PeriodStart

an10

M

Start of time interval in the format DD.MM.YYYY

PeriodEnd

an10

M

End of time interval in the format DD.MM.YYYY

CurrentRemainingBalanceAmount

n..7

M

Remaining limit of the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrentRemainingBalanceCurrency

a3

M

Currency for the remaining limit according to ISO 4217

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

ans..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

an..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

ans..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of delivery country of the invoicing address 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

an..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 confirming the BillingAgreement with Amazon Pay Recurring



Amazon Pay Recurring: ValidateBillingAgreement

To review a BillingAgreement, please enter 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.

Notice: Please note that optional address parameters are transferred only if correct scope is given within the Button-Widget. Depending on scope the invoicing address data can be transferred already before completion of payment. See also description of scope at section „Integrate Button-Widget“.

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

EventToken

enum

M

Abbreviation of the action to be done:

<VBA> = ValidateBillingAgreement

Parameters for reviewing the BillingAgreement with Amazon Pay Recurring


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“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

AmountLimitPerTimePeriod

n..7

M

Limit set by Amazon for the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrencyLimitPerTimePeriod

a3

M

Currency for the set limit according to ISO 4217

PeriodStart

an10

M

Start of time interval in the format DD.MM.YYYY

PeriodEnd

an10

M

End of time interval in the format DD.MM.YYYY

CurrentRemainingBalanceAmount

n..7

M

Remaining limit of the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrentRemainingBalanceCurrency

a3

M

Currency for the remaining limit according to ISO 4217

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

ans..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

an..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

ans..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of delivery country of the invoicing address 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

an..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 reviewing a BillingAgreement with Amazon Pay Recurring



Amazon Pay Recurring: Authorization of a BillingAgreement

In order to execute (another) authorization of a BillingAgreement, go to 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.

Notice: Use this call in order to collect money from your customer periodically. This call can be repeated any number as long as the limit of authorizations agreed with Amazon Pay was not exceeded (see parameter AmountLimitPerTimePeriod and CurrentRemainingBalanceAmount). Please note that the limit has to be coordinated with Amazon Pay.

Notice: Please note that optional address parameters are transferred only if correct scope is given within the Button-Widget. Depending on scope the invoicing address data can be transferred already before completion of payment. See also description of scope at section „Integrate Button-Widget“.

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

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

CountryCode

a2

M

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

RefNr

ans..30

O

Unique reference number

MAC

an64

M

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

OrderDesc

ans..126

O

Description of purchased goods, unit prices etc. This will be displayed in the email from Amazon to customer.

EventToken

enum

M

Abbreviation of the action to be done:

<ABA> = AuthorizeBillingAgreement

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

CustomInformation

ans..256

O

Additional information that should be store with the Billing-Agreement

StoreName

ans..1024

O

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

ShoppingBasketAmount

enum

O

Categorizes the shopping basket:

„DIGITAL“ for shopping baskets with solely digital goods

„DIGITAL“ for shopping baskets with solely physical goods

„MIXED“ for shopping baskets with digital and physical goods

For shopping baskets Digital and Mixed the Amazon address data are not included in this risk assessment.

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).

ChDesc

ans..12

C

Text printed on the customer’s credit card bill (only for Capture=AUTO)

If Capture=AUTO is selected than ChDesc must be transmitted.

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.

ReqID

ans..32

O

To 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 authorization of a BillingAgreement with Amazon Pay Recurring


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“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

AmazonRefID

ans..27

M

Unique ID for the transaction issued by Amazon

OrderID

ans..19

C

Only for Capture=AUTO: Unique ID for the order issued by Amazon. Corresponds to the Order-ReferenceID.

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

AmountLimitPerTimePeriod

n..7

M

Limit set by Amazon for the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrencyLimitPerTimePeriod

a3

M

Currency for the determined limit according to ISO 4217

PeriodStart

an10

M

Start of time interval in the format DD.MM.YYYY

PeriodEnd

an10

M

End of time interval in the format DD.MM.YYYY

CurrentRemainingBalanceAmount

n..7

M

Remaining limit of the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrentRemainingBalanceCurrency

a3

M

Currency for the remaining limit according to ISO 4217

NotificationType

a..25

C

Is transmitted only in case of Notify: Describes the type of notification. Fixed value: <AuthorizeNotification>

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

ans..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

an..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

ans..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of delivery country of the invoicing address 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

an..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 authorization of a BillingAgreement with Amazon Pay Recurring and parameters to URLNotify



Amazon Pay Recurring: SetBillingAgreementDetails and Confirm

In order to execute SetBillingAgreementDetails and the confirmation within one single step, go to 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.

Notice: Please note that SCB should be called only once, because the Confirm can be performed successfully only once. Therefore essentially use ReqID in order to avoid double requests.

Notice: Please note that optional address parameters are transferred only if correct scope is given within the Button-Widget. Depending on scope the invoicing address data can be transferred already before completion of payment. See also description of scope at section „Integrate Button-Widget“.

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

MAC

an64

M

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

OrderDesc

ans..126

O

Description of purchased goods, unit prices etc. This will be displayed in the email from Amazon to customer.

EventToken

enum

M

Abbreviation of the action to be done:

<SCB> = SetBillingAgreement & Confirm

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

CustomInformation

ans..256

O

Additional information that should be store with the Billing-Agreement

StoreName

ans..1024

O

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

ReqID

ans..32

O

To 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 SetBillingAgreementDetails und confirmation for a BillingAgreement with Amazon Pay Recurring


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“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

AmountLimitPerTimePeriod

n..7

M

Limit set by Amazon for the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrencyLimitPerTimePeriod

a3

M

Currency for the determined limit according to ISO 4217

PeriodStart

an10

M

Start of time interval in the format DD.MM.YYYY

PeriodEnd

an10

M

End of time interval in the format DD.MM.YYYY

CurrentRemainingBalanceAmount

n..7

M

Remaining limit of the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrentRemainingBalanceCurrency

a3

M

Currency for the remaining limit according to ISO 4217

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

ans..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

an..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

ans..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of delivery country of the invoicing address 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

an..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 SetBillingAgreementDetails and Confirm with Amazon Pay Recurring



Amazon Pay Recurring: SetBillingAgreement, Confirmation and Authorization

In order to execute SetBillingAgreementDetails, confirmation and authorization to an BillingAgreement within one single step, go to 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.

Notice: Please note that SCB should be called only once, because the Confirm can be performed successfully only once. Therefore essentially use ReqID in order to avoid double requests.

Notice: Please note that optional address parameters are transferred only if correct scope is given within the Button-Widget. Depending on scope the invoicing address data can be transferred already before completion of payment. See also description of scope at section „Integrate Button-Widget“.

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

MAC

an64

M

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

OrderDesc

ans..126

O

Description of purchased goods, unit prices etc. This will be displayed in the email from Amazon to customer.

EventToken

enum

M

Abbreviation of the action to be done:

<SCA> = SetBillingAgreement & Confirm & Authorize BillingAgreement

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

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

CustomInformation

ans..256

O

Additional information that should be store with the Billing-Agreement

StoreName

ans..1024

O

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

ShoppingBasketAmount

enum

O

Categorizes the shopping basket:

„DIGITAL“ for shopping baskets with solely digital goods

„DIGITAL“ for shopping baskets with solely physical goods

„MIXED“ for shopping baskets with digital and physical goods

For shopping baskets Digital and Mixed the Amazon address data are not included in this risk assessment.

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).

ChDesc

ans..12

C

Text printed on the customer’s credit card bill (only for Capture=AUTO)

If Capture=AUTO is selected than ChDesc must be transmitted.

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.

ReqID

ans..32

O

To 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.

Parameters for SetBillingAgreementDetails, confirmation and authorization for a BillingAgreement with Amazon Pay Recurring


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“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

OrderID

ans..19

C

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

Is returned only if Capture=AUTO.

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

AmountLimitPerTimePeriod

n..7

M

Limit set by Amazon for the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrencyLimitPerTimePeriod

a3

M

Currency for the determined limit according to ISO 4217

PeriodStart

an10

M

Start of time interval in the format DD.MM.YYYY

PeriodEnd

an10

M

End of time interval in the format DD.MM.YYYY

CurrentRemainingBalanceAmount

n..7

M

Remaining limit of the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrentRemainingBalanceCurrency

a3

M

Currency for the remaining limit according to ISO 4217

NotificationType

a..25

C

Is transmitted only in case of Notify: Describes the type of notification. Fixed value: <AuthorizeNotification>

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

ans..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

an..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

ans..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of delivery country of the invoicing address 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

an..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 SetBillingAgreementDetails, confirmation and authorization with Amazon Pay Recurring and parameters to URLNotify



Amazon Pay Recurring: Capturing a payment

In order to capture an authorized payment with Amazon Pay Recurring, 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.

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 payment with Amazon Pay Recurring


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 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 after capturing an authorized payment with Amazon Pay Recurring


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 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 payment with Amazon Pay Recurring



Amazon Pay Recurring: Credit a payment

In order to credit a captured payment with Amazon Pay Recurring, 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.

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 a payment with Amazon Pay Recurring


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 out 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.

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 after credting an authorized payment with Amazon Pay Recurring


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 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 crediting a payment with Amazon Pay Recurring



Amazon Pay Recurring: Close Billing Agreement

In order to close a BillingAgreement with Amazon Pay Recurring with the function „CloseBillingAgreement“, 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.

Notice: Please note that optional address parameters are transferred only if correct scope is given within the Button-Widget. Depending on scope the invoicing address data can be transferred already before completion of payment. See also description of scope at section „Integrate Button-Widget“.

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.

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

EventToken

enum

M

Abbreviation of the action to be done:

<CLB> = Close Billing Agreement

MAC

an64

M

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

OrderDesc

ans..127

M

Description of purchased goods, unit prices etc. for authorization

Encrypted parameters for closing a recurring payment with Amazon Pay Recurring


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.

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

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

AmountLimitPerTimePeriod

n..7

M

Limit set by Amazon for the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrencyLimitPerTimePeriod

a3

M

Currency for the determined limit according to ISO 4217

PeriodStart

an10

M

Start of time interval in the format DD.MM.YYYY

PeriodEnd

an10

M

End of time interval in the format DD.MM.YYYY

CurrentRemainingBalanceAmount

n..7

M

Remaining limit of the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrentRemainingBalanceCurrency

a3

M

Currency for the remaining limit according to ISO 4217

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

ans..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

an..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

ans..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of delivery country of the invoicing address 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

an..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 closing a Billing Agreement of a recurring payment with Amazon Pay Recurring



Amazon Pay Recurring: Request authorization details

In order to request the details of an authorization with Amazon Pay Recurring, 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.

Notice: Please note that optional address parameters are transferred only if correct scope is given within the Button-Widget. Depending on scope the invoicing address data can be transferred already before completion of payment. See also description of scope at section „Integrate Button-Widget“.

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

enum

M

Abbreviation of the action to be done:

<ATD> = AuthorizeDetails

Encrypted parameters for requesting the details of an authorization with Amazon Pay Recurring


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 the details of an authorization with Amazon Pay Recurring



Amazon Pay Recurring: Request capture details

In order to request the details of a capture with Amazon Pay Recurring, 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.

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

enum

M

Abbreviation of the action to be done:

<CAD> = CaptureDetails

Encrypted parameters for requesting the details of a capture with Amazon Pay Recurring


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 the details of a capture with Amazon Pay Recurring



Amazon Pay Recurring: Request credit details

In order to request the details of a credit with Amazon Pay Recurring, 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.

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

enum

M

Abbreviation of the action to be done:

<CRD> = CreditDetails

Encrypted parameters for requesting the details of a credit with Amazon Pay Recurring


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 the details of a credit with Amazon Pay Recurring



Amazon Pay Recurring: Customer amendments at a Billing Agreement

In the customer backend of Amazon Pay the customer may amend their payment method and also the invoicing address and delivery address. The merchant gets informed about this with a Notify to the Notify URL which was specified together with initializing the Billing Agreement. There is no request call.

Notice: Please note that optional address parameters are transferred only if correct scope is given within the Button-Widget. Depending on scope the invoicing address data can be transferred already before completion of payment. See also description of scope at section „Integrate Button-Widget“.

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

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“, „Canceled“, „Closed“. Details see Amazon API Reference Guide.

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

BillingAgreementID

ans..64

M

Is created at loading time of address widget (see above)

AmountLimitPerTimePeriod

n..7

M

Limit set by Amazon for the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrencyLimitPerTimePeriod

a3

M

Currency for the determined limit according to ISO 4217

PeriodStart

an10

M

Start of time interval in the format DD.MM.YYYY

PeriodEnd

an10

M

End of time interval in the format DD.MM.YYYY

CurrentRemainingBalanceAmount

n..7

M

Remaining limit of the BillingAgreement within specified interval in the smallest currency unit (e.g. EUR Cent)

CurrentRemainingBalanceCurrency

a3

M

Currency for the remaining limit according to ISO 4217

NotificationType

a..25

M

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

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

ans..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

an..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

ans..128

O

Phone number of addressee in the billing address

bdAddrCountryCode

a2

O

Country code of delivery country of the invoicing address 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

an..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 customer amendments to a Billing Agreement