Get started with PayPal
Before you begin
If this is your first payment method, make sure to follow the Get started guide to begin processing payments with Primer.Configure in the Dashboard
- Add PayPal payment method to your Dashboard
- Activate PayPal on the Checkout
- Configure a Workflow to process payments made with PayPal
Prepare the client session
PayPal leverages the following parameters to process a payment. Pass them when creating the client session.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 code of the user is required for PayPal. |
metadata ↳ paypal_custom_id | Primer’s direct integration to PayPal enables you send a custom ID to PayPal to link your orders to a specific custom ID. | |
metadata ↳ paypal_invoice_id | Primer’s direct integration to PayPal enables you send a Invoice ID to PayPal to link your orders to a specific invoice ID. | |
metadata ↳ paypal_client_metadata_id | ✓ | Required field if the Billing Agreement is being created. |