SolutionsSystem status
Documentation
Create accountContact
  1. Jesse

Required parameters test

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.

FlowRequired properties and exceptions
directamount, currency, description, gateway, order_id; customer is required except for Belfius and iDEAL.
redirectamount, 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 methodRequired property
Amazon Paycustomer.first_name, customer.last_name, customer.address1, customer.house_number, customer.zip_code, customer.city, and customer.phone
Bizumcustomer.phone
PayPal Seller Protectioncustomer.country

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

Payment methodGateway IDDirectRedirect
iDEALIDEALBanking properties; customer optionalBanking properties; customer required
iDEAL QRIDEALQRBanking properties; use the supported QR/component flowBanking properties; customer required
BancontactMISTERCASHNot supported for custom direct requests; use Payment ComponentsBanking properties; customer.locale required
BelfiusBELFIUSBanking properties; customer optionalBanking properties; customer required
BizumBIZUMBanking properties; customer.phone requiredBanking properties; customer.phone required
CBCCBCBanking propertiesBanking properties
Bank transferBANKTRANSBanking properties; customer.country and customer.email requiredBanking properties; customer.country and customer.email required
Direct debitDIRDEBBanking propertiesBanking properties
DotpayDOTPAYBanking propertiesBanking properties
EPSEPSBanking propertiesBanking properties
KBCKBCBanking propertiesBanking properties
MB WAYMBWAYBanking properties; customer.phone requiredBanking properties; customer.phone required
MultibancoMULTIBANCOBanking propertiesBanking properties
TrustlyTRUSTLYBanking properties; customer.first_name, customer.last_name, and customer.email requiredBanking properties; customer.first_name, customer.last_name, and customer.email required
AMEXAMEXCard propertiesCard properties
MastercardMASTERCARDCard propertiesCard properties
MaestroMAESTROCard propertiesCard properties
VisaVISACard propertiesCard properties
Credit cardCREDITCARDCard propertiesCard properties
AfterPayAFTERPAYBNPL propertiesBNPL properties
BillinkBILLINKBNPL properties and Billink customer fieldsBNPL properties and Billink customer fields
e-InvoicingEINVOICEBNPL propertiesBNPL properties
in3IN3BNPL propertiesBNPL properties
KlarnaKLARNABNPL propertiesBNPL properties
AlipayALIPAYWallet properties; customer requiredWallet properties; customer required
Alipay+ALIPAYPLUSWallet properties; customer requiredWallet properties; customer required
Amazon PayAMAZONBTNWallet properties and Amazon Pay customer fieldsWallet properties and Amazon Pay customer fields
Apple PayAPPLEPAYWallet properties; customer optionalWallet properties; customer required
Google PayGOOGLEPAYWallet properties; customer optionalWallet properties; customer required
PayPalPAYPALWallet properties; customer requiredWallet properties; customer required
WeChat PayWECHATWallet properties; customer optionalWallet properties; customer required
Gift cards and vouchersGateway-specificamount, currency, description, gateway, order_idamount, currency, description, gateway, order_id

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.

Updated about 3 hours ago

Did this page help you?