Common required parameters
When implementing multiple APMs, it is important to ensure that you include the complete set of required parameters when making the Create APM one-time-use token request.
You can also include other, non-required parameters, in the request, depending on your needs for the transaction and your records.
The following information provides details about these parameters across all the APMs. For more information about a specific parameter, see the integration guides or the API.
Required for all APMs
The following parameters are required for all APMs:
| Parameter | Description |
|---|---|
data.amount | Transaction amount. |
data.currency | Transaction currency. Note that not every currency is supported by all APMs. See Supported currencies for APMs for information about which ones are supported for each APM. |
data.customer.orderNumber | Unique order number. |
Required for most APMs
The following parameters are required for most of the APMs:
| Parameter | Description |
|---|---|
data.customer.firstName | Required for all APMs except the "Continue Button" flow for PayPal (with Braintree) |
data.customer.lastName | Required for all APMs except the "Continue Button" flow for PayPal (with Braintree) |
data.customer.email | Required for all APMs except the "Continue Button" flow for PayPal (with Braintree) |
data.customer.billToCountry | Required for Afterpay through Citcon, Apple Pay (applePayCyberSource), Google Pay, Klarna Optional for Apple Pay (applePayAuthNet), Paynet, PayPal, PayPal (with Braintree), Sofort (sofortCheckout) |
data.customer.billToAddressOne | Required for Afterpay through Citcon, Apple Pay (applePayCyberSource), Google Pay, Klarna (klarnaPayments) Optional for Apple Pay (applePayAuthNet), Klarna (klarnaCheckout), Paynet, PayPal, PayPal (with Braintree), Sofort |
data.customer.billToCity | Required for Afterpay through Citcon, Apple Pay (applePayCyberSource), Google Pay, Klarna (klarnaPayments) Optional for Apple Pay (applePayAuthNet), Klarna (klarnaCheckout), Paynet, PayPal, PayPal (with Braintree), Sofort |
data.customer.billToState | Required for Afterpay through Citcon, Apple Pay (applePayCyberSource), Google Pay, Klarna (klarnaPayments) Optional for Apple Pay (applePayAuthNet), Klarna (klarnaCheckout), Paynet, PayPal, PayPal (with Braintree), Sofort |
data.customer.billToPostal | Required for Afterpay through Citcon, Apple Pay (applePayCyberSource), Google Pay, Klarna (klarnaPayments) Optional for Apple Pay (applePayAuthNet), Klarna (klarnaCheckout), Paynet, PayPal, PayPal (with Braintree), Sofort |
Required for specific APMs
The following parameters are required by at least one APM:
| Parameter | Description |
|---|---|
data.applePayDomain | Required for Apple Pay |
data.customer.billToPhone | Required for Afterpay through Citcon, Klarna (klarnaPayments) |
data.customer.customerRef | Required for Apple Pay and for recurring transactions through PayPal (with Braintree) |
data.description | Required for Apple Pay (applePayCyberSource) |
data.cart.items[n].itemdata.cart.items[n].descriptiondata.cart.items[n].quantitydata.cart.items[n].price | Required for Klarna |
processingOptions.doNotProcessPayment | Required for "Continue Button" flow for PayPal (with Braintree) |
processingOptions.saveRecurringToken | Required for "Continue Button" flow for PayPal (with Braintree) if the amount to process on the Confirm/Place Order page will be more than the current amount (for example, if adding tax and shipping costs to the amount). Also required if needing to save a recurring token for a future merchant-initiated transaction for PayPal (with Braintree) |
Updated 10 days ago