How to process an Apple Pay payment
This how-to guide covers:
- Setting up Apple Pay with Mangopay for the first time
- Making payment requests
- Renewing your Apple Pay certification with Mangopay
Prerequisites
- A
ClientIdand an API key – if you don’t have these, contact Sales to get access to the Mangopay Hub - A User object created for your end user, and their associated Wallet
- The user’s card registered in their Apple Pay account (see testing information)
- Enrollment in the Apple Developer Program
SETUP
1. Create your Apple Pay Merchant ID using the Mangopay format
The Apple Pay Merchant ID is a unique identifier that identifies your platform to Apple Pay. You need a separate Merchant ID for each Mangopay ClientId, in both Sandbox and Production.
Use the formats below to create your Apple Pay Merchant ID:
Sandbox:
- mangopay.com.payline.58937646344908.
ClientId
Production:
- mangopay.com.payline.43461661979437.
ClientId
Warning - Respect the Merchant ID formatting
Because the Apple Pay merchant identifier must match the processing certificate that will be created by Mangopay, it is important to respect the nomenclature above.
The full string must be less than 50 characters, meaning that there are 14 characters available for the ClientId. If your Sandbox or Production ClientId is longer than 14 characters, you need to truncate it.
2. Send your Merchant ID to Mangopay
Once generated, send your Merchant ID to Mangopay by contacting the Support team via the Hub.
Mangopay will generate a Certificate Signing Request (CSR) file and return it to you.
3. Create your Payment Processing Certificate with the CSR file
Once you receive the CSR file from Mangopay, create a Payment Processing Certificate, uploading this file in the process.
Warning - Do not activate your certificate
You must not activate your Payment Processing Certificate at this stage - only create it.
4. Download and send the CER file to Mangopay
Download the Payment Processing Certificate’s CER file and send it to Mangopay Support team via the Hub.
5. Await confirmation from Mangopay
Mangopay will use the CER file to finalize the configuration of Apple Pay on your Mangopay API environment. One of our team members will confirm that everything is ready.
6. Activate your certificate
Once you have received confirmation from Mangopay that everything is ready, activate your Payment Processing Certificate.
Your certificate has limited validity and expires every 25 months. To renew your certificate, see Step 9.
PAYMENTS
7. Configure your Apple Pay integration for Mangopay
For an overview of the data flows, see the Apple Pay guide.
When making payment requests to the Apple Pay API from your app or website, use the following values for the PKPaymentNetwork:
visamasterCard
Note - Ensure readiness of the rest of your Apple Pay integration
Further integration steps are necessary to be able to offer Apple Pay in your app or website, including creating the Apple Pay button in line with their guidance.
For more information, see the Apple Pay documentation.
8. Include payment data in the pay-in call
Include the payment data received from Apple Pay in the PaymentData parameter in your request to the Create an Apple Pay PayIn endpoint.
To be notified of the outcome, you can use the same webhook event types as for other pay-ins. The same pay-in functional errors are also possible.
RENEWAL
9. Renew your Payment Processing Certificate
The process to renew your certificate is the same as when you created it first time. You create a new certificate which, when activated, automatically revokes the previous one.
When your certificate is nearing expiry, Mangopay will send you a CSR file for your ClientId. Use this file to create a new Payment Processing Certificate.
Warning - Do not activate your certificate
You must not activate your Payment Processing Certificate when you create it. Activation must be done later once you have received confirmation from Mangopay.
Follow Steps 4 to 6 to complete the renewal of your certificate.
Related resources
Was this page helpful?