Attributes

• METHOD TYPEE-wallet
• PAYMENTS
• PAYOUTS
• REFUNDS
• RECURRING

Overview

ApplePay was launched in 2014 as a mobile payment method by Apple. It allows users to make payments in person, in iOS apps and on the Web. It works similarly to other NFC technology-based mobile payments, such as GooglePay or Samsung Pay. In addition, the ApplePay payments require two-factor authentication via Touch ID, Face ID, PIN or passcode.

This guide describes how to implement ApplePay using Nuvei REST API 2.0.

Supported Countries

• Australia
• Austria
• Belarus
• Belgium
• Brazil
• Bulgaria
• Canada
• China
• Croatia
• Cyprus
• Czech Republic
• Denmark
• Estonia
• Faroe Islands
• Finland
• France
• Georgia
• Germany
• Greece
• Greenland
• Guernsey
• Hong Kong
• Hungary
• Iceland
• Ireland
• Isle of Man
• Italy
• Japan
• Jersey
• Kazakhstan
• Latvia
• Liechtenstein
• Lithuania
• Luxembourg
• Macau
• Malta
• Monaco
• Netherlands
• New Zealand
• Norway
• Poland
• Portugal
• Romania
• Russia
• San Marino
• Saudi Arabia
• Singapore
• Slovakia
• Slovenia
• Spain
• Sweden
• Switzerland
• Taiwan
• Ukraine
• United Arab Emirates
• United Kingdom
• United States
• Vatican City

Supported Currencies

Apple Pay supports all currencies supported by Nuvei.

Implementation

Follow these steps to implement ApplePay using Nuvei REST API 2.0:

1. Register with ApplePay.
2. Implement a dynamic ApplePay button.
   Instead of initiating a session by sending a REST API 1.0 /openOrder request and instead of sending a REST API 1.0 /payment request:

   1. Follow the REST 2.0 Authentication instructions.
   2. Integrate ApplePay for payments – Nuvei decrypts the ApplePay token.
3. Test ApplePay integration.

Upon completion, customers are able to make payments using ApplePay.

Payments – Nuvei Decrypts Token

The ApplePay token contains ApplePay authentication values from a successful ApplePay authentication. The merchant sends the encrypted ApplePay token as-is in a non-3DS /payments request. Nuvei decrypts the token and uses the relevant data extracted from it.

Send a non-3DS POST /payments request with its mandatory parameters and include:

• paymentOption class with:
  • store: “none“
  • networkToken class with:
    • provider: “ApplePay“
    • token: “<token received from ApplePay>“

Example ApplePay /payments Request

{
  "processingEntityId": "<your processingEntityid>",
  "transactionType": "Sale",
  "amount": 20,
  "currency": "USD",
  "paymentOption": {
    "store": "none",
    "networkToken": {
      "provider": "ApplePay",
      "token": "<token received from ApplePay>"
    }
  },
  "deviceDetails": {
    "ipAddress": "<customer's IP address>"
  },
  "buyerDetails": {
    "buyerId": "<unique customer identifier in merchant system>",
    "firstName": "John",
    "lastName": "Smith",
    "email": "[email protected]",
    "phone": "6175551414",
    "billingAddress": {
      "address": "22 Main Street",
      "zip": "02460",
      "city": "Boston",
      "phone": "6175551414",
      "countryCode": "US"
    },
    "shippingAddress": {
      "sameAsBilling": true
    }
  }
}

Example ApplePay /payments Response

{
  "paymentId": "6aeeec0ea2e74fb382f2ffdf1f43786d",
  "transactionId": "8110000000001643449",
  "amount": 20,
  "currency": "USD",
  "transactionType": "Sale",
  "result": {
    "status": "approved"
  },
  "authCode": "111185",
  "partialApproval": {
    "requestedAmount": 20,
    "requestedCurrency": "USD"
  },
  "paymentOption": {
    "networkToken": {
      "provider": "ApplePay",
      "expirationMonth": "10",
      "expirationYear": "27",
      "bin": "520424",
      "last4Digits": "2826",
      "acquirerId": "19",
      "cardType": "Credit",
      "cardBrand": "MASTERCARD"
    }
  }
}