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.

Placement options

At the payment method level, you can set an option to configure when the order is placed upon asynchronous authorization:

  • Auto-place — set the auto_place attribute to true if you want your orders to be automatically placed as soon as we get a successful webhook from the payment gateway.

Capture options

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 to true if you want payments to be automatically captured as soon as they are authorized. Add the auto_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 to false 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.

Data model

Check the related ER diagram and explore the flowchart that illustrates how the payment method resource relates to the other API entities.


Last updated