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), 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.

Payment method support and limitations

B2B Edition supports payment methods that are integrated as standard checkout modules, identified by a code such as squarev2 or braintree, when calling the Get All Payment Methods endpoint. These payment methods can be enabled or disabled on a company-by-company basis.

Supported payment methods

These gateways have checkout module representation and are returned by the Get All Payment Methods endpoint. B2B Edition can enable or disable these payment methods on a company-by-company basis.

Payment methods not supported

These providers are known to BigCommerce Payments infrastructure but don’t have checkout module representation, so they aren’t returned by the Get All Payment Methods endpoint. B2B Edition doesn’t reliably recognize these — a Company using one of them can have it automatically removed from payment settings.

If a payment method you’ve configured on the store doesn’t appear in B2B Edition’s Company payment settings, or disappears after previously being enabled, check whether it’s in the supported list above. If it isn’t, it currently falls outside what B2B Edition can reliably track, and BigCommerce support can help with a workaround.