Web

Apple Pay purchase operation

To integrate the Apple Pay button on the payment page of an online store, you need to implement the ApplePaySession.canMakePaymentsWithActiveCard method, this method determines whether this device supports payment using Apple Pay.

If it supports payment, you need to draw the “Buy using Apple Pay” button.

Next, you need to create an object ApplePaySession, with the purchase parameters:

  countryCode: 'UA',
  currencyCode: 'UAH',
  supportedNetworks: ['visa', 'masterCard'],
  merchantCapabilities: ['supports3DS'],
  total: { label: 'Your Merchant Name', amount: '10.00' },

For a description of the fields, see the Apple Pay on Web documentation.

On the event onvalidatemerchant you need to hang a handler in which it will be called API “api/apple/validate” . The description of the method will be below.

On the event onpaymentauthorized you need to hang a handler that will call API “api/apple/payment”.

After confirming the payment in onpaymentauthorized, you must call the method

ApplePaySession.completePayment.

ApplePaySession documentation can be found on the Apple site.

Merchant Validation Apple Pay (api/apple/validate)

Production url: https://****.procard-ltd.com/api/apple/validate

POST parameters:

Parameter	Description	Type	Value
operation	Type of transaction	String	Purchase
apple_validation_url	This parameter comes in the event onvalidatemerchant, event.validationURL	String
	Example:
	session.onvalidatemerchant = (event) => {   console.log(event.validationURL); }
merchant_id	merchant identifier	String
amount	The amount of the transaction. Example 500.00	Float
signature	In order to confirm the validity of the data, a verification signature must be generated and transmitted in the HMAC_SHA512 request using the SecretKey merchant.	String
	The string to be HMAC_SHA512 is generated by concatenating the parameters merchant_id, order_id, amount, currency_iso, description separated by “;” (semicolon) in UTF-8 encoding.
	The order of parameters during concatenation is important!
order_id	Unique transaction number on the merchant side. If the operation is duplicated, the merchant receives an error.	String
currency_iso	Currency of payment	String	UAH
description	Purpose of payment. It is displayed on the payment page when entering payment details. Displayed in the account statement and registries	String
add_params	An array with additional parameters. Additional parameters are then returned to the merchant in a callback call	Array
callback_url	URL to which information about the result of the payment will be sent	String

The following parameters come in response:

Parameter	Description	Type
apple_validate_data	Data to pass to session.completeMerchantValidation method	String
order_key	Order ID in the payment system	Integer
code	Answer code (0 - success)	String
message	Decoding of the response code	String

Payment confirmation Apple Pay (api/apple/payment)

Production url: https://****.procard-ltd.com/api/apple/payment

The system itself determines which authentication path goes with or without 3DS depending on the data received from Apple.

POST parameters:

Parameter	Description	Type
order_key	Order ID in the payment system	String
apple_pay_payment_data	Base64 encoded data received in new event onpaymentauthorized in parameter event.payment.	String
	Example:
	session.onpaymentauthorized = (event) => {   console.log(event.payment);} }
apple_pay_payment_data_decrypted	The parameter is passed instead of apple_pay_payment_data if payment with a decrypted token is used. Base64 encoded data received in new event onpaymentauthorized in parameter event.payment	String

The answer comes:

Parameter	Description	Type	Value
transactionStatus	Transaction Status	String	Approved - Successfully Declined - Renouncement
reason	Text reason for rejection	String
reasonCode	Failure Error Code	String

After calling this method, a callback comes to the backend trader.

Request for payment with decrypted token example:

{
  "order_key": "9910ae2538be76b828f63a08f14ddf4a267d5148713cb2bb2742848fd622cfd266d86cab7f44b",
  "apple_pay_payment_data_decrypted": "ewoiYXBwbGljYXRpb25QcmltYXJ5QWNjb3VudE51bWJlciI6ICI0MDEyMDAwMDAwMDAzMTE5IiwKImFwcGxpY2F0aW9uRXhwaXJhdGlvbkRhdGUiOiAiMjgxMTMwIiwKImN1cnJlbmN5Q29kZSI6ICI5ODAiLAoidHJhbnNhY3Rpb25BbW91bnQiOiAxMDAwMCwKImRldmljZU1hbnVmYWN0dXJlcklkZW50aWZpZXIiOiAiMDQwMDEwMDMwMjczIiwKInBheW1lbnREYXRhVHlwZSI6ICIzRFNlY3VyZSIsCiJwYXltZW50RGF0YSI6ewoib25saW5lUGF5bWVudENyeXB0b2dyYW0iOiIxMjMiLAoiZWNpSW5kaWNhdG9yIjoiNSIKfQp9Cg=="
}

Decrypted token structure:

Parameter	Description	Type
applicationPrimaryAccountNumber	The tokenized card number	String
applicationExpirationDate	Expiration date of the card (YYMMDD format)	String
currencyCode	Currency of payment	String
transactionAmount	The amount of the transaction. Example 500.00	Float
deviceManufacturerIdentifier	Unique identifier for the device manufacturer	String
paymentDataType	Type of payment data	String
paymentData
onlinePaymentCryptogram	A cryptogram for secure online transactions	String
eciIndicator	Electronic Commerce Indicator, shows the security level of the transaction	String

Decrypted token example:

{
  "applicationPrimaryAccountNumber": "4012000000003119",
  "applicationExpirationDate": "281130",
  "currencyCode": "980",
  "transactionAmount": 10000,
  "deviceManufacturerIdentifier": "040010030273",
  "paymentDataType": "3DSecure",
  "paymentData": {
    "onlinePaymentCryptogram": "123",
    "eciIndicator": "5"
  }
}