Let customers securely make payments using Apple Pay on your website or mobile application.
Parameter Name | Required | Description |
---|---|---|
currencyCode | ✓ | 3-letter currency code in ISO 4217 format, e.g. USD for US dollars |
order ↳ lineItems | ✓ | Details of the line items of the order |
order ↳ countryCode | ✓ | The country in which the order is created |
paymentMethod ↳ options ↳ APPLE_PAY ↳ merchantName | For payments using the Apple Pay payment method, use this field to override the default merchant name for the Primer account from showing on the Apple Pay flow. For example, if your merchant name on your account is “Company X” but you want to display a specific store name on the Apple Pay flow, you can set the merchantName to “Store name A”. | |
paymentMethod ↳ options ↳ APPLE_PAY ↳ recurringPaymentRequest | Required for recurring payments. Include to specify that the payment is a recurring payment, typically for subscriptions. | |
paymentMethod ↳ options ↳ APPLE_PAY ↳ deferredPaymentRequest | Required for deferred payments. Include to specify that payment will be charged at a future date, such as hotel bookings or pre-orders. | |
paymentMethod ↳ options ↳ APPLE_PAY ↳ automaticReloadRequest | Required for automatic reload payments. Include to enable automatic top-ups when account balance falls below a threshold, such as transit cards or loyalty programs. |
vaultOnSuccess: true
):
Use the appropriate MPAN request configuration based on your payment use case.
firstPaymentReason | MPAN Request Type | Use Cases | Required |
---|---|---|---|
Recurring | Recurring Payments | Subscriptions, memberships, scheduled billing | recurringPaymentRequest |
Unscheduled | Deferred Payments | Buy-now-pay-later, layaway, delayed billing | deferredPaymentRequest |
Unscheduled | Automatic Reload | Wallet top-ups, account reloads | automaticReloadRequest |
vaultOnSuccess: false
):