Guides

Apple Pay

Suggest Edits

See the Apple Pay feature page for more information and options on how to integrate Apple Pay with BR-DGE.

🚧

To process Apple Pay via the BR-DGE REST API you will need to provide us with your Apple Pay Payment Processing Certificate (PPC). To create your PPC and upload it to your BR-DGE retail channel please read the "REST API" section of our Apple Pay onboarding article, and get in contact with our support team.

Apple Pay on the Web

For more information on integrating with Apple Pay on the Web, including Apple's requirements, please see the Apple developer documentation.

Payment Flow

  • Your customer initiates a payment using a supported device, or browser.

  • You create an Apple Pay session directly with Apple. See Apple's creating an Apple Pay payment session documentation for more information.

  • You pass the session details from your server back to the client.

  • You customer authorizes the payment on their device, using Touch ID or Face ID.

  • The Apple Pay JS SDK then calls an event in the web client which provides an encrypted token object, following the Apple Pay Payment Token structure.

  • You pass this encrypted ApplePayPayment object back to your server where is is used as an applePay type of paymentInstrument when you call BR-DGE's POST /v1/payments endpoint.

    • See the "Payment With Apple Pay Payment Instrument Example" on the POST /v1/payments endpoint for an example of how to use this payment instrument type.

  • BR-DGE process the payment to the relevant payment processor, and return you the final response.

{
  "code": 1000,
  "message": "Approved",
  "id": "4fad8e2e06a15656",
  "paymentId": "22669f90-5bf0-45df-ba8c-ea6d4235a5da",
  "psp": {
    "name": "Nuvei",
    "transactionId": "a83a53a2-dcc8-45be-bf70-2b1e4b719f7c"
  }
}

For an automated integration of the above steps, please see our BR-DGE SDK documentation.

Apple Pay PassKit via BR-DGE REST API

To accept Apple Pay payments from a native app you must use PassKit to interface with Apple Pay. BR-DGE can process Apple Pay payments using payment processing certificates associated with, and created in your Apple Pay Developer account. For more information on integrating Apple Pay using the PassKit solution, please see the Apple PassKit integration guide.

Once your PPC has been uploaded to your retail channel you can begin testing Apple Pay via BR_DGE. Please see the "Payment With Apple Pay Payment Instrument" request example from the [POST v1/payments endpoint] for more information on how to make a payment using an Apple Pay token.

Updated about 2 months ago