Comment on page
Payment methods
The payment method object and the allowed CRUD operations on the related resource endpoint
Payment methods represent the type of payment sources (e.g., Credit Card, PayPal, Apple Pay, etc.) offered in a market. They can have a price and must be present before placing an order.
A payment method must be associated with a payment gateway. The payment source type used with a payment method depends on the associated gateway. The available payment method options can be differentiated by market.
At the payment method level, you can set a couple of options to configure at which step of the order lifecycle the payment capture is performed in your market(s):
- Auto-capture — set the
auto_capture
attribute totrue
if you want payments to be automatically captured as soon as they are authorized. Add theauto_capture_max_amount_cents
value if you want the auto-capture option to be enabled only for orders under a certain amount. - Delayed capture — set the
require_capture
attribute tofalse
if you want to start fulfilling your orders even if their payment is not captured yet and manually capture them when they’re ready to be shipped.
Check the related ER diagram and explore the flowchart that illustrates how the payment method resource relates to the other API entities.
Last modified 8mo ago