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:

ParameterDescription
data.amountTransaction amount.
data.currencyTransaction 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.orderNumberUnique order number.

Required for most APMs

The following parameters are required for most of the APMs:

ParameterDescription
data.customer.firstNameRequired for all APMs except the "Continue Button" flow for PayPal (with Braintree)
data.customer.lastNameRequired for all APMs except the "Continue Button" flow for PayPal (with Braintree)
data.customer.emailRequired for all APMs except the "Continue Button" flow for PayPal (with Braintree)
data.customer.billToCountryRequired for Afterpay through Citcon, Apple Pay (applePayCyberSource), Google Pay, Klarna

Optional for Apple Pay (applePayAuthNet), Paynet, PayPal, PayPal (with Braintree), Sofort (sofortCheckout)
data.customer.billToAddressOneRequired 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.billToCityRequired 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.billToStateRequired 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.billToPostalRequired 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:

ParameterDescription
data.applePayDomainRequired for Apple Pay
data.customer.billToPhoneRequired for Afterpay through Citcon, Klarna (klarnaPayments)
data.customer.customerRefRequired for Apple Pay and for recurring transactions through PayPal (with Braintree)
data.descriptionRequired for Apple Pay (applePayCyberSource)
data.cart.items[n].item
data.cart.items[n].description
data.cart.items[n].quantity
data.cart.items[n].price
Required for Klarna
processingOptions.doNotProcessPaymentRequired for "Continue Button" flow for PayPal (with Braintree)
processingOptions.saveRecurringTokenRequired 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)