Once you have successfully implemented Apple Pay on your website or app, Appla-X Gate can now start consuming the payment data:

1. You as a merchant create the initial order. Example:

   {
       //required
       "client":{
           "email": "adam.smith@company.com"
       },
       "products": [
           {
               "quantity": "1",
               "price": "0.30",
               "title": "My Product"
           }
       ],
       //optional
       "currency": "EUR"
   }
   

   As a response from Appla-X you will receive a parameter called api_do_applepay to send encrypted payload received from Apple Pay and allow Appla-X to handle decryption.

2. Whenever your customer finishes authorizing the Apple Pay payment, you will receive the Apple Pay payment result that contains Apple Pay payment token. To let Appla-X handle token decryption, Apple Pay token can be provided as the request body to Appla-X Gate Apple Pay api_do_applepay endpoint. This endpoint is used for completing the Apple Pay transaction. It accepts data from the payment token and then processes the payment. More information on the payment token and its format can be found here.

   Send the Apple Pay token you got from the Apple Pay Pay API and provide it in your request to Appla-X Gate Apple Pay api_do_applepay endpoint. Example:

   {
     "data": "...",
     "version": "...",
     "signature": "...",
     "ephemeralPublicKey": "...",
     "publicKeyHash": "...",
     "transactionId": "...",
     "applicationData": "...",
     "ip_address": "127.0.0.1"
   }
   

3. After successfully proceeded payment, the payment status is updated for the merchant by Appla-X and the appropriate webhook about the status is sent out.

Once you have successfully implemented Apple Pay on your website or app, Appla-X Gate can now start consuming the payment data:

1. You as a merchant create the initial order. Example:

   {
       //required
       "client":{
           "email": "adam.smith@company.com"
       },
       "products": [
           {
               "quantity": "1",
               "price": "0.30",
               "title": "My Product"
           }
       ],
       //optional
       "currency": "EUR"
   }
   

   As a response from Appla-X you will receive a parameter called api_do_url to send decrypted payload data.

2. Whenever your customer finishes authorizing the Apple Pay payment, you will receive the Apple Pay payment result that contains Apple Pay payment token. Now you decrypt the Apple Pay token yourself. More information on the payment token and its format can be found here.

   Provide the data from decrypted payload in your request to Appla-X Gate api_do_url endpoint. Example:

   {
     "card_number": "...",
     "exp_month": "...",
     "exp_year": "...",
     "eci": "...", //optional
     "cavv": "...",
     "wallet": "applepay",
     "merchant_url": "..."
   }
   

3. After successfully proceeded payment, the payment status is updated for the merchant by Appla-X and the appropriate webhook about the status is sent out.

Once you have set up Google Pay for your account, you can start to accept Google Pay payments.

NB: When you submit a payment data request to the Google API, be sure to include the following parameters:

• 'gateway': 'appla-x'
• gatewayMerchantId': '<your merchant website ID>'

1. Submit a payment data request to the Google API. Example:

   {
     "type": "CARD",
     "parameters": {
       "allowedAuthMethods": ["PAN_ONLY", "CRYPTOGRAM_3DS"],
       "allowedCardNetworks": ["MASTERCARD", "VISA"]
     },
     "tokenizationSpecification": {
       "type": "PAYMENT_GATEWAY",
       "parameters": {
         "gateway": "<gateway_name>",
         "gatewayMerchantId": "<YOUR_MERCHANT_WEBSITE_ID>"
       }
     }
   }
   

   If your gateway account is set up to process card authorisation requests with AVS checks, you can request BillingAddressParameters in your Google Pay API request (it is advised to request the FULL version of the billing address). If you do not request a billing address through Google Pay, you still have the option to use the address you have on file.

2. You as a merchant create the initial order. Example:

   {
     //required
     "client":{
       "email": "adam.smith@company.com",
       "address": "Sunny str, 128", // mandatory field for the AVS functionality
       "zip_code": "12 3456" // mandatory field for the AVS functionality
     },
     "products": [
       {
         "quantity": "1",
         "price": "0.30",
         "title": "My Product"
       }
     ],
     //optional
     "currency": "EUR"
   }
   

   As a response from Appla-X you will receive a parameter called api_do_googlepay to send encrypted payload received from Google Pay and allow Appla-X to handle decryption.

3. Make a request to process the Google Pay payment. Send the PaymentData you got from the Google Pay API and provide it in your request to Appla-X Gate api_do_googlepay endpoint. Example:

   {
     "signature": "...",
     "intermediateSigningKey": {
     "signedKey": "...",
     "signatures": [...]
     },
     "protocolVersion": "...",
     "signedMessage": "...",
     "ip_address": "127.0.0.1"
   }
   

   Response example in case of CRYPTOGRAM_3DS:

   {
     "processing_status": "000"
   }
   

   Response example in case of PAN_ONLY:

   {
     "threed_check_url":"<https://transactions.decta.com/p/a03b5962-1218-4dfd-b78c-1b5ec686ef22/EbbM%252FxU4j8YMDnjAD9qKYTT7%252BcZizmxD51yPZPZj09jTRvePwybnCoOz3Exj%252B%252Bfo8iKX8nP0FdsS1LNBrrXusl%252BPr3rviH38CtLalnRpU38kRRiIU0Qq8TBMQLsXAPreZ8o%252BKYN/3d/>"
   }
   

4. Analyze the response:

   • In case you receive a processing_status, wait for a webhook about the final status from the Appla-X Gate;
   • In case you receive a threed_check_url, redirect the shopper to this link to complete the 3D Secure authentication and wait for a webhook about the final status from the Appla-X Gate.

Once you have set up Google Pay for your account, you can start to accept Google Pay payments.

NB: When you submit a payment data request to the Google API, be sure to include the following parameters:

• 'gateway': 'appla-x'
• gatewayMerchantId': '<your merchant website ID>'

1. Submit a payment data request to the Google API. Example:

   {
     "type": "CARD",
     "parameters": {
       "allowedAuthMethods": ["PAN_ONLY", "CRYPTOGRAM_3DS"],
       "allowedCardNetworks": ["MASTERCARD", "VISA"]
     },
     "tokenizationSpecification": {
       "type": "PAYMENT_GATEWAY",
       "parameters": {
         "gateway": "<gateway_name>",
         "gatewayMerchantId": "<YOUR_MERCHANT_WEBSITE_ID>"
       }
     }
   }
   

   When you submit a payment data request to the Google API, be sure to include the following parameters:

   • 'gateway': '<gateway_name>'
   • gatewayMerchantId': '<your merchant website ID>'
   
   

   If your gateway account is set up to process card authorisation requests with AVS checks, you can request BillingAddressParameters in your Google Pay API request (it is advised to request the FULL version of the billing address). If you do not request a billing address through Google Pay, you still have the option to use the address you have on file.

2. You as a merchant create the initial order. Example:

   {
     //required
     "client":{
       "email": "adam.smith@company.com",
       "address": "Sunny str, 128", // mandatory field for the AVS functionality
       "zip_code": "12 3456" // mandatory field for the AVS functionality
     },
     "products": [
       {
         "quantity": "1",
         "price": "0.30",
         "title": "My Product"
       }
     ],
     //optional
     "currency": "EUR"
   }
   

   As a response from Appla-X you will receive a parameter called api_do_url to send decrypted payload data.

3. Make a request to process the Google Pay payment. Send the data from the decrypted payload in your request to Appla-X Gate api_do_url endpoint.

   Example, if decrypted payload is CRYPTOGRAM_3DS:

   {
     "card_number": "...",
     "exp_month": "...",
     "exp_year": "...",
     "eci": "...", // optional
     "cavv": "...",
     "wallet": "googlepay"
   }
   

   Example, if decrypted payload is PAN_ONLY:

   {
     "card_number": "...",
     "exp_month": "...",
     "exp_year": "...",
     "wallet": "googlepay"
   }
   

   Note that in case when the decrypted payload is PAN_ONLY, all of the 3DS authentication options (i.e. Automatic, Partly Automatic, Third Party MPI, and Manual 3DS Handling) are supported.

   Response example in case of CRYPTOGRAM_3DS:

   {
     "processing_status": "000"
   }
   

   If the decrypted message contains PAN_ONLY, the response depends on the 3DS Authentication option (i.e. there response may be either an URL to threed_check_url, an immediate result with processing_status, or an URL to perform the manual 3DS).

4. Analyze the response:

   • In case you receive a processing_status, wait for a webhook about the final status from the Appla-X Gate;
   • In case you receive a threed_check_url, redirect the shopper to this link to complete the 3D Secure authentication and wait for a webhook about the final status from the Appla-X Gate.