About Amazon Pay
General information about Amazon Pay
Payment processing with Amazon Pay (APA=Amazon Pay Advanced; LPA= Login and Pay with Amazon) requires the correct and timely coordinated cooperation of several systems working together.
To initialize a payment or a login with Amazon there is a direct interaction with Amazon required. Therefore a button widget provided by Amazon must be implemented in your shop.
Data from the first direct interaction with the Amazon widgets is then transferred to Pay-Jet Cockpit in the following step. Pay-Jet Cockpit resumes the follow-up actions in this process by a direct communication with the Amazon systems. Pay-Jet Cockpit returns all answers of the Amazon systems to your systems (e.g. shop and ERP).
Please consult Pay-Jet Support during conceptual design for implementing Amazon Pay. Only when all steps are properly coordinated will a functional interface be guaranteed.
This manual describes the basics for configuring and using the Pay-Jet interface for Amazon Pay as well as:
- the parameters of the interface
- the Batch using of the interface
| Logo |
|
|---|---|
| Info | “Amazon Pay and Login by Amazon” is a complete checkout and payment service. It allows millions of Amazon customers to complete their purchases with using their Amazon account without leaving the web page of the visited online shop. The A-Z-guarantee from Amazon gives a comprehensive protection. |
| Type | Payments by eWallet |
Further information you will find also on the Web page of Amazon Pay.
On this page
Configuration for Amazon Pay
Before using Amazon Pay you need to register at https://pay.amazon.com/de/signup. On this page you can configure a notify URL. Therefore follow the menu steps Settings – Integration settings – Settings for instant notifications – Modify. Enter the Pay-Jet Integrator URL https://www.payjet-cockpit.de/ AmazonAPANotify.aspx and save it.
The second step is generating a MWS Auth Token. Therefore go to the webpage https://developer.amazonservices.co.uk/gp/mws/registration/register.html and enter the following Pay-Jet data:
Developer name: Computop Ltd
Developer account number: 8662-2365-9858
Then submit the received MWS Authorisation Token on a secure way to Pay-Jet Support for configuration.
Steps within the process
The basic payment process with Amazon consists of several steps:
Step | Description |
|---|---|
Display Button-Widget | The Amazon button widget must be properly implemented on the page of the webshop and must be called for each payment/login process. Afterwards a redirect to Amazon occurs. Within the redirect data from Amazon (AccessToken, TokenType, Expiry, Scope) is delivered. |
Initialize payment via Pay-Jet Cockpit (Server to Server) | With the delivered data from the button widget from Amazon (AccessToken, TokenType, Expiry, Scope) the payment process via Pay-Jet Cockpit is initiated. Please use Eventtoken LGN. Return parameters will include (depending on scope) customer information such as email address and UserID (unique Amazon account ID). Use this information to identify the user and compare with your data. |
Load and display address and wallet widgets | Both widgets must be integrated in the shop directly. The widgets communicate directly with the shop. It is recommended to firstly call the address widget, to buffer the „OrderReferenceID“ (OrderReferenceId is generated by address widget – and can be read out via JavaScript with„orderReference.getAmazonOrderReferenceId()“) and to execute immediately a call of AmazonAPA.aspx with Eventtoken „SOD“ and the „orderReferenceID“ via the Pay-Jet Cockpit . In return, depending on the “scope”, you will receive delivery data including city, country and postcode and you can thereby calculate standard shipping costs. Thus the wallet only shows valid payment methods for this order. Each modification of delivery address (if the customer selects a different address for shipping than the standard address within the widget) involves an „OnAddressSelect“– whereupon your systems must react. |
Request new shipping information | After an „OnAddressSelect“ a further call of AmazonAPA.aspx via Pay-Jet Cockpit is necessary with Eventtoken „GOD“. The response gives information about the new selected delivery address (only for Scope=payments:shipping_address for recalculating the shipping costs). Now call the AmazonAPA.aspx with Eventtoken SOD, to transfer the possible new total amount for this order. |
Finalize the purchase | The purchase confirmation is completed via Pay-Jet Cockpit with the option of one of two Eventtokens – „SCO“ „SetOrderDetails and ConfirmOrder“or „COD“ „ConfirmOrderDetails“. The call with Eventtoken „SCO“ is preferred, because the following steps are easier due to the automatic provision of the final delivery address (with all address details). Nevertheless after getting the response of finalizing the order a further call of AmazonAPA.aspx with Eventtoken „GOD“ should be made, in order to notice possible delivery address changes. After finalizing the order there already doesn’t exits a pecuniary claim against the customer. Subsequently your systems also must execute authorizations and captures. |
| Confirmation flow | Due to Multi-factor Authentication it is necessary after a succesful confirmation of an order to start a new Javascript call, the ConfirmationFlow. With this AmazonPay can handle the Multi-factor Authentication if required. The changes for Multi-Factor Authentication (MFA) needed, only effect the EUR and UK Amazon Platforms. |
Authorisation | The authorization of amount payable must be done within 180 days. Authorizations are valid for 30 days and expire afterwards. After expiry the amount payable can be reauthorized (within 180 days after the order). In the response to an authorization with Amazon you receive a unique Cockpit -Parameter „XID“. This parameter is a sub-transaction number, which is uniquely associated with a „PayID“ within the Cockpit . Please ensure that you store this parameter together with this transaction. Within respective „XID“ no further transactions like capture or credit can be executed. Captures and credits with Amazon always must reference to an authorization or capture (authorization „blue pullover“, capture „blue pullover“, credit „blue pullover“). For an initialized Amazon order up to ten authorizations can be submitted simultaneously. Per order lifecycle up to a maximum of 50 authorizations can be submitted. Peculiarity for authorizations with Amazon: There are two different authorization types: Synchronous and asynchronous authorization. Synchronous authorizations always give a clear answer about the authorization result immediately, thus OK or FAILED. Asynchronous authorizations are followed up by a notify, which gives an answer about the authorization result after a definable maximum time period (the notify can be returned earlier). The maximum time period between submitting the authorization and the latest allowed status message per notify can be configured for each Cockpit 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 Pay-Jet Cockpit for capture. Captures without XID are refused. If a capture < authorization was submitted, the difference amount can be authorized again immediately. The Pay-Jet Cockpit does not make an automatic reauthorization of the difference amount. |
Conclude order process after dispatch | After end of the order process (e.g. after shipment of the last article or after successful last capture) it is recommended, to close the process at Amazon. If the process is not closed, the customer will see an open order in his backend of Amazon Pay. Please use therefore the Eventtoken „COR“. After closing of this process captures on open authorizations as well as credits are still possible – but no further authorizations related to an order process. |
Close an authorization | If an article cannot be delivered anymore (or did no longer have to be delivered) existing authorizations that are not captured can be closed. Therefore use the Eventtoken „RAN“. |
Credits | According to Amazon credits can issue without time limit. This can be up to a maximum of one year in the case of Pay-Jet . For a credit the „XID“ of the underlying capture must be submitted to Pay-Jet Cockpit . 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>
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, payments:shipping_address, payments:billing_address |
Further information can be found in the documentation from Amazon Pay.
Integrate address book and wallet widget
The following example code shows how to implement the address book widget:
<div id="addressBookWidgetDiv">
</div>
<script>
new OffAmazonPayments.Widgets.AddressBook({
sellerId: 'YOUR_SELLER_ID_HERE',
onOrderReferenceCreate: function(orderReference) {
orderReference.getAmazonOrderReferenceId();
// Send SetOrderDetails Request with OrderReferenceId to Computop to
// set the amount and get the default address
},
onAddressSelect: function(orderReference) {
// Send GetOrderDetails Request to get the selected address
},
design: {
designmode: 'responsive'
},
onError: function(error) {
// your error handling code
}
}).bind("addressBookWidgetDiv");
</script>
<!--Set your sellerId and import JavaScript libraries necessary for rendering the
wallet widget as explained in the documentation linked to below.-->
<div id="walletWidgetDiv"></div>
<script>
new OffAmazonPayments.Widgets.Wallet({
sellerId: 'YOUR_SELLER_ID_HERE', amazonOrderReferenceId: 'ORO_ID_RETREIVED', displayMode: 'Edit', presentmentCurrency: 'EUR', design: { designMode: 'responsive' },
onPaymentSelect: function(orderReference){
// Replace this code with the action that you want to perform
// after the payment method is chosen.
// Ideally this would enable the next action for the buyer
// including either a "Continue" or "Place Order" button.
},
onError: function(error){
// Your error handling code.
// During development you can use the following
// code to view error messages:
// console.log(error.getErrorCode() + ': ' + error.getErrorMessage()); // See "Handling Errors" for more information.
}
}).bind("walletWidgetDiv");
</script>
The option to logout is usually a link which removes all user data from the website and then re-displays the login page via the amazon.Login.logout() method. Use the following codes for this:
<script type="text/javascript">
document.getElementById('Logout').onclick = function() {
amazon.Login.logout();
};
</script>
Javascript for confirmation flow
Due to Multi Factor Authentication it is necessary after a succesful confirmation of an order to start a new call, the ConfirmationFlow.
The following example code shows how to implement the Javscript function for that:
Function confirmationFlow()
{
// Get the ResultCode from Computop Call AmazonAPA.aspx EventToken: COR
var resultCode_Computop = callComputopAmazonAPA_Confirmation();
// Your AmazonSellerID / AmazonMerchantID
var amazonSellerId = ‚ABCDEFG123456‘;
// AmazonOrderReferenceID generated by AdressWidget
var orderReferenceId = ‚P02-1234567-1234567‘;
// Initiate Conformation Flow
OffAmazonPayments.initConfirmationFlow(amazonSellerId, orderReferenceId, function (confirmationFlow) {
if(resultCode_Computop = ‚00000000‘)
{
// Do confirmationFlow with Success Confirm
confirmationFlow.success();
}
else
{
// Do confirmationFlow with Failured Confirm
confirmationFlow.error();
}
});
}
Available Event-Token
For Amazon Pay there are numerous possible actions whose selection is controlled at the interface via the EventToken parameter.
The following table gives an overview of possible Eventtoken for AmazonAPA.aspx:
Process flow chart
conditio
Process flow for Amazon Pay within Cockpit 
draw.io
/pages/viewpage.action?pageId=332330
Process flow for Multi-factor authentication
This action should be triggered by clicked the "Buy Now" button. When MFA is required, the Confirmation Flow (see Javascript above) shows the credit card issuer’s MFA challenge to the buyer. After the buyer interacts with the Confirmation Flow (for example, completes the MFA challenge), the buyer is returned to the merchant’s site (for example, order confirmation page). The merchant should be able to handle the redirection (URLSuccess / URLFailure) with the result of the MFA Challenge.
In case of amazonstatus=Success the purchase is completed. In case of amazonstatus=Failure or amazonStatus=Abandoned the customer is redirected to the URLFailure and the merchant should cancel the order by calling reverse,aspx (see below in chapter "Amazon Pay reverse an authorization"). The customer can be redirected to select a different payment method or in case of Abandoned to replace the order and complete the MFA challange.
Instead of the one-step solution with EventToken=SCO the process can be splitted into EventToken=SOD and EventToken=COD followed by the Confirmation Flow.
Process flow for Multi-factor authentication with Amazon Pay (amazonstatus=Success)
Process flow for failed Multi-factor authentication with Amazon Pay (amazonstatus=Failure or Abandoned)
draw.io
draw.io
Cockpit interface
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) Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.Definitions
Data formats
Abbreviations
Comment If a parameter is mandatory, then it must be present If a parameter is optional, then it can be present, but it is not required If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional
Initialize Amazon Pay interface
In order to initialize a payment with Amazon Pay, please use the following URL:
https://www.payjet-cockpit.de/ AmazonAPA.aspx |
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for initializing an Amazon Pay payment
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters after initializing an Amazon Pay payment
Amazon Pay set order details
In order to confirm the order details of a payment with Amazon Pay with the function „SetOrderDetails“, please visit the following URL:
https://www.payjet-cockpit.de/ AmazonAPA.aspx |
The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for calling SetOrderDetails and SetOrderDetailsAndConfirmOrder for an Amazon Pay payment
Notice: You can combine calling SetOrderDetails and ConfirmOrderDetails, if you are using EventToken <SCO> for SetOrderDetailsAndConfirmOrder.
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters after SetOrderDetails and SetOrderDetailsAndConfirmOrder for an Amazon Pay payment
Amazon Pay request order details
In order to request the order details of a payment with Amazon Pay with the function „GetOrderDetails“, please visit the following URL:
https://www.payjet-cockpit.de/ AmazonAPA.aspx |
The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for calling GetOrderDetails for an Amazon Pay payment
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters after GetOrderDetails of an Amazon Pay payment
Amazon Pay confirm order details
In order to confirm the order details of a payment with Amazon Pay with the function „ConfirmOrderDetails“, please visit the following URL:
https://www.payjet-cockpit.de/ AmazonAPA.aspx |
The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for calling ConfirmOrderDetails for an Amazon Pay payment
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters after ConfirmOrderDetails of an Amazon Pay payment
In case of an error (e.g. if Amazon refuses the payment) you get a notify to your specified URLNotify with following parameters:
Response parameters to URLNotify after ConfirmOrderDetails for an Amazon Pay payment
Amazon Pay finalize authorization
In order to authorize a payment with Amazon Pay, please visit the following URL:
https://www.payjet-cockpit.de/ AmazonAPA.aspx |
The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for authorizing an Amazon Pay payment
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters after authorization of an Amazon Pay payment
After an authorization you get a notify to your specified URLNotify with following parameters:
Response parameters to URLNotify after authorization of an Amazon Pay payment
Amazon Pay capture a payment
In order to capture an authorized payment with Amazon Pay, please visit the following URL:
https://www.payjet-cockpit.de/ capture.aspx |
The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for capturing an authorized Amazon Pay payment
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters after capturing an authorized Amazon Pay payment
After a capture you get a notify to your specified URLNotify with following parameters:
Response parameters to URLNotify after capturing an authorized Amazon Pay payment
Amazon Pay credit a payment
In order to credit a captured payment with Amazon Pay, please visit the following URL:
https://www.payjet-cockpit.de/ credit.aspx |
The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for crediting an Amazon Pay payment
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters after crediting an authorized Amazon Pay payment
After a credit you get a notify to your specified URLNotify with following parameters:
Response parameters to URLNotify after credit of an Amazon Pay payment
Amazon Pay close an order
In order to close an order with Amazon Pay with the function „CloseOrder“, please visit the following URL:
https://www.payjet-cockpit.de/ AmazonAPA.aspx |
The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for closing an Amazon Pay payment
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters after closing an Amazon Pay payment
Amazon Pay reverse an order
In order to reverse a complete order with Amazon Pay with the function „CancelOrderReference“, please visit the following URL:
https://www.payjet-cockpit.de/ reverse.aspx |
The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for reversal of an Amazon Pay payment
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters after reversing an Amazon Pay payment
Notice: If you are reversing an order completely, you will get also a notify like for an incorrect order as described above.
Amazon Pay reverse an authorization
In order to reverse a single authorization with Amazon Pay with the function „CancelAuthorize“, please visit the following URL:
https://www.payjet-cockpit.de/ AmazonAPA.aspx |
The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for reverse an Amazon Pay authorization
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters after reversal of an Amazon Pay authorization
Notice: If you reverse an authorization you will also get a notify similar to the above described notify for authorization.
Amazon Pay request authorization details
In order to request the details of an authorization with Amazon Pay, please visit the following URL:
https://www.payjet-cockpit.de/ AmazonAPA.aspx |
The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for requesting details of an Amazon Pay authorization
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters for requesting details of an Amazon Pay authorization
Amazon Pay request capture details
In order to request the details of a capture with Amazon Pay, please visit the following URL:
https://www.payjet-cockpit.de/ AmazonAPA.aspx |
The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for requesting details of an Amazon Pay capture
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters for requesting details of an Amazon Pay capture
Amazon Pay request credit details
In order to request the details of a credit with Amazon Pay, please visit the following URL:
https://www.payjet-cockpit.de/ AmazonAPA.aspx |
The following tables describe the transfer parameters and return values which are exchanged via the socket connection. The server-to-server communication process is described in the manual Programming basics.
Notice: For security reasons, Pay-Jet Cockpit 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:
Encrypted parameters for requesting details of an Amazon Pay credit
The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Response parameters for requesting details of an Amazon Pay credit
Batch processing via the interface
Basic information about using Batch files and about their structure you can find inside the separate manual for the Batch manager. Within batch processing not alle functions are available which are usually available for the online interface.
This section describes the parameters which must be transferred within the data set (Record) for executing a payment with Amazon Pay and which information can be found within the response file about the payment status.
For Amazon Pay the transactions AUTHORIZE, CAPTURE, CREDIT, COR, REVERSE and RAN are possible via Batch. Batch versions X.0; X.1; 1.X and 2.X are supported.
Following table gives an overview of all batch versions that are possible for a specific action an their specialities:
Description of the possible batch versions
The structure for a payment with Amazon Pay within a Batch file to be submitted is the following:
HEAD,<MerchantID>,<Date>,<Version> AmazonAPA,AUTHORIZE,(<MID>,)<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,<Capture>(,<ChDesc>,<OrderDesc>) AmazonAPA,CAPTURE,(<MID>,)<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,<AuthXID>(,<ChDesc>,<OrderDesc>) AmazonAPA,CREDIT,(<MID>,)<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,<CapXID>(,<ChDesc>,<OrderDesc>) AmazonAPA,COR,(<MID>,)<PayID> AmazonAPA,REVERSE,(<MID>,)<PayID>(,<Reason>) AmazonAPA,RAN,(<MID>,)<PayID>,<AuthXID>(,<Reason>) FOOT,<CountRecords>,<SumAmount>
Example for Master MID function:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks the following way:
AmazonAPA,AUTHORIZE,(<MID>,)<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,<Capture>,(<ChDesc>,)(<OrderDesc>,)<Status>,(<Code>,)<AuthXID>,<AmazonStatus>,<OrderID>,<AmazonRefId>,<AmountAuth>,<AmountCap>,<AmountCred> AmazonAPA,CAPTURE,(<MID>,)<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,<AuthXID>,(<ChDesc>,)(<OrderDesc>,)<Status>,(<Code>,)<CapXID>,<AmazonStatus>,<OrderID>,<AmazonRefId>,<AmountAuth>,<AmountCap>,<AmountCred> AmazonAPA,CREDIT,(<MID>,)<Betrag>,<Währung>,<TransID>,(<RefNr>,)<PayID>,<CapXID>,(<ChDesc>,)(<OrderDesc>,)<Status>,(<Code>,)<CredXID>,<AmazonStatus>,<OrderID>,<AmazonRefId>,<AmountAuth>,<AmountCap>,<AmountCred> AmazonAPA,COR,(<MID>,)<PayID>,<Status>,(<Code>,)<AmazonStatus>,<OrderID>,<AmountAuth>,<AmountCap>,<AmountCred> AmazonAPA,REVERSE,(<MID>,)<PayID>,(<Reason>,)<Status>,(<Code>,)<OrderId> AmazonAPA,RAN,(<MID>,)<PayID>,<AuthXID>,(<Reason>,)<Status>,(<Code>,)<AmazonStatus>,<OrderID>,<AmazonRefId>,<AmountAuth>,<AmountCap>,<AmountCred>
Description of result parameters within the record for Batch files