Step by Step Set-Up Guide for Apple Pay
- Validate acquirer supports Apple Pay
- How to obtain the CSR to generate the payment processing certificate
- Where to send the generated certificate. (Currently not specified)
Configure Apple Pay on the Web
Paygate interface
Calling the interface
Two transactions are created when making a credit card payment via Apple Pay. In the Apple Pay transaction the required credit card data are determined first and the actual credit card transaction is then carried out automatically. This takes place via a server-to-server connection and supports all usual credit card transaction options. The difference here, however, is that you don't transmit the credit card information, which you don't know. Instead, you transmit the PKPaymentToken generated by Apple Pay, which contains the required credit card data in encrypted form.
In order to make a credit card payment with Apple Pay, go to the following URL:
https://www.computop-paygate.com/applepay.aspx |
Info |
---|
Notice: For security reasons, Axepta rejects all payment requests with formatting errors, please use the correct data type for each parameters. The following table describes the encrypted payment request parameters: The table describes just basic parameters. It is also possible to include all credit card payment parameters (without credit card data). More information about this you can find within Card processing. If you are processing Recurring or stored Credential on File transactions, please make sure to review all the necessary information in "COF Mandate Integration Guide". If there are any specific parameters that are mandatory for credit card payment, these parameters are also mandatory for Apple Pay. |
Parameters for Apple Pay
Key | Format | CND | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Axepta. Additionally this parameter has to be passed in plain language too. | ||||||||
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment | ||||||||
RefNr | an..12 | C | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional settlement file (CTSF) we cannot add the additional payment data. Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional settlement file we cannot add the additional payment data. Notes:
| ||||||||
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) 100 is the smallest currency unit | ||||||||
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. | ||||||||
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. | ||||||||
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. | ||||||||
RTF | a1 | O | Establishment of Credential on File Agreement (Cardholder agrees that his card data can be stored for further transactions). | ||||||||
Capture | an..6 | OM | Determines the type and time of capture.
| ||||||||
OrderDesc | ans..64 | M | Description of purchased goods, unit prices etc. | ||||||||
URLNotify | ans..256 | O | Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.
| ||||||||
MerchantIDExt | ans..128 | C | Merchant Identifier of Public Key Mandatory if more then one Merchant Identifiers are stored with Computo | ||||||||
TokenExt | ans..6000 | M | Apple Pay PKPaymentToken as JSON string in the Base64 format
| ||||||||
Channel | a..10 | O | Channel over which the order is processed. Allowed value : ECOM |
Result parameters for Apple Pay
The following table describes the result parameters with which Axepta responds to your system
- Please be prepared to receive additional parameters at any time and do not check the order of parameters
- The key (e.g. MerchantId, RefNr) should not be checked case-sentive
Key | Format | CND | Description |
---|---|---|---|
mid | ans..30 | M | MerchantID, assigned by Axepta |
Description | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files This ID refers to the credit card transaction unless an error occurs already at the Apple Pay transaction. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
refnr | ns..30 | O | Merchant’s unique reference number |
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
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 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. |
schemeReferenceID | an64 | C | Card scheme specific transaction ID required for subsequent credential-on-file payments, delayed authorizations and resubmssions. |
Capture / Credit / Reversal
Captures, credits and reversals do not refer to the Apple Pay transaction but directly to the credit card transaction.
Batch processing via the interface
Captures, credits and reversals via batch do not refer to the Apple Pay transaction but directly to the credit card transaction.