Required parameters by payment method

This reference lists the required API properties for the payment methods documented in this repository. It covers direct and redirect orders. Existing payment-method pages remain unchanged.

Common order properties

Banking orders

For banking methods, the API schema requires amount, currency, description, gateway, order_id, and customer.

type is optional in the banking schema. Set it to direct or redirect; if omitted, the API uses redirect.

Card orders

For AMEX, CREDITCARD, MAESTRO, MASTERCARD, and VISA, the API schema requires amount, currency, description, gateway, and order_id.

For card payment pages, include these billing properties when they are collected by the page: customer.address1, customer.city, customer.country, customer.first_name, customer.house_number, customer.last_name, and customer.zip_code.

BNPL orders

For AFTERPAY, BILLINK, EINVOICE, IN3, and KLARNA, the API schema requires:

amount, currency, customer, delivery, description, gateway, order_id, shopping_cart, and checkout_options.

These properties are required for both direct and redirect orders. type is optional; set it to direct or redirect, and redirect is used when it is omitted.

For Billink, the payment-method documentation identifies these required customer properties: customer.last_name, customer.email, customer.address1, customer.house_number, customer.zip_code, customer.city, and customer.country.

Wallet orders

For ALIPAY, ALIPAYPLUS, AMAZONBTN, APPLEPAY, BIZUM, GOOGLEPAY, PAYPAL, and WECHAT, the API schema requires amount, currency, description, gateway, order_id, and customer.

The customer object is not required for direct Apple Pay, Google Pay, and WeChat Pay orders. It is required for their redirect orders.

Additional wallet fields defined by the API schemas:

Payment components

Payment components support direct orders only. The API schema requires amount, currency, description, gateway, order_id, payment_data, and type.

A direct payment component request must set type to direct. Redirect payment components are not supported.

Payment-method matrix

Notes

• gateway identifies the payment method. A redirect payment page that displays all available methods may omit gateway where the selected order schema allows it.
• shopping_cart is required for BNPL orders and is not a universal requirement for banking, card, or wallet orders.
• The payment-method response includes required_customer_data and shopping_cart_required. Use those fields as the final authority for an account-specific configuration.
• Payment-method-specific requirements can depend on country, provider, account configuration, and flow. The API reference takes precedence if a schema changes.