Payments

The B2B Edition Payments API provides endpoints for enabling, disabling, and updating active payment methods on a Company-to-Company basis. Every payment method you have enabled on the store-level can be enabled or disabled as needed on the Company level. In addition, the specific behaviors for Company credit and payment on terms can be adjusted with this API.

NOTE
The Company credit and payment on terms features must be enabled in order to use their respective API paths. Using either path with the corresponding store-level feature disabled will cause errors or unexpected behavior. Refer to each endpoint for details.

For information on managing the payment methods available to the B2B Edition Payments API, refer to Payments (Help Center) (opens in a new tab), as this is not currently manageable via API. To learn more about Company credit and payment on terms, see B2B Edition Settings (opens in a new tab) and Companies (opens in a new tab).

Retrieving Payment Method Information for Companies

The B2B Edition Payments API has three endpoints for returning the payment methods available to Company accounts, each with its own context and use cases.