BigCommerce Docs

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), as this is not currently manageable via API. To learn more about Company credit and payment on terms, see B2B Edition Settings and Companies.

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.

Endpoint	Description	Use Cases
Get Payment Methods	Returns a list of all payment methods available on the store.	This endpoint allows you to confirm which payment methods and provides the payment’s identifier for future requests.
Get Company Payment Methods	Returns the list of payment methods for a specific Company account.	Use this endpoint to identify payment methods that are available for a particular Company, but not currently enabled.
Get All Active Payment Methods	Get all currently enabled payment methods across Companies.	This allows you to identify enabled payment methods for all Company accounts in a store. Use the `companyid` parameter to identify enabled payment methods on a particular Company account more efficiently than the Get Company Payment Methods endpoint.