Apple Pay

🚧
Early release
Online payments is in early development (MVP). This section may change.

With Apple Pay, shoppers pay on Apple devices with a card stored in their Apple wallet. The card details are replaced by a secure token.

Apple Pay from your own checkout

If you run your own Apple Pay integration, you get a payment token from Apple when the shopper pays. Send it to Aera with Create direct payment session. Pass the token on exactly as you got it from Apple.

Example paymentMethodInfo: Apple Pay

"paymentMethodInfo": {
  "paymentMethodDetails": [
    {
      "method": "APPLEPAY",
      "applePay": {
        "poiChannel": "APP",
        "merchantIdentifier": "merchant.com.example.shop",
        "token": {
          "paymentMethod": {
            "displayName": "Visa 1234",
            "network": "Visa",
            "type": "debit"
          },
          "transactionIdentifier": "…",
          "paymentData": { }
        }
      }
    }
  ]
}

Field	Required	Description
`poiChannel`	Yes	Where the shopper started Apple Pay. `WEB`: on a website. `APP`: in your iOS app.
`merchantIdentifier`	Only for `APP`	Your Apple Pay merchant identifier, from your Apple developer account. It tells Apple which merchant is asking for the payment.
`token.paymentMethod.network`	Yes	The card network, for example `Visa` or `Mastercard`. Aera uses it to route the payment.
`token.paymentMethod.displayName`	No	The card label Apple shows the shopper, for example "Visa 1234".
`token.paymentMethod.type`	No	The card type, for example `credit`, `debit` or `prepaid`.
`token.transactionIdentifier`	No	Apple's identifier for the transaction.
`token.paymentData`	Yes	Apple's encrypted payment data.

See Direct payments for how the response works.