List Active Payment Methods | BigCommerce Developer Center

Get all currently enabled payment methods across Companies. If multiple Companies have a given payment method enabled, each one will be returned in the results. Data is returned with pagination.

Authentication

X-Auth-Tokenstring

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

X-Store-Hashstring

Authentication header

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |

Query parameters

orderByenumOptional

Specifies the order data should be returned in. If not included, defaults to 'DESC'.

Allowed values:

sortByenumOptionalDefaults to updatedAt

Sorts data based on creation or modification time while respecting the orderBy parameter. If not included, defaults to ‘updatedAt’.

Allowed values:

limitintegerOptionalDefaults to 10

Sets the maximum number of records to display in the response.

offsetintegerOptionalDefaults to 0

Sets the number of records to skip before displaying the response.

companyIdstringOptional

Filters results by companyId, only showing payment methods enabled for the specified Company.

qstringOptional

The search string by which data should be filtered. Currently supports payment method code & payment method title, so that a value of q=auth would return any payment method with ‘auth’ in either the code or the title.

Response

SUCCESS

codeintegerDefaults to 200

Operation status code.

datalist of objects

metaobject

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v3/io/company-payment-methods"
4
5	payload = {}
6	headers = {
7	"X-Auth-Token": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.get(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"code": 200,
3	"data": [
4	{
5	"companyId": 7826480,
6	"paymentId": 1,
7	"createdAt": 1753818625,
8	"updatedAt": 1753818625,
9	"paymentMethodCode": "authorizenet",
10	"paymentMethodTitle": "Authorize.net"
11	},
12	{
13	"companyId": 7826481,
14	"paymentId": 2,
15	"createdAt": 1753818600,
16	"updatedAt": 1753818700,
17	"paymentMethodCode": "paypal_express",
18	"paymentMethodTitle": "PayPal Express Checkout"
19	},
20	{
21	"companyId": 7826482,
22	"paymentId": 3,
23	"createdAt": 1753818650,
24	"updatedAt": 1753818750,
25	"paymentMethodCode": "stripe",
26	"paymentMethodTitle": "Stripe"
27	}
28	],
29	"meta": {
30	"pagination": {
31	"totalCount": 100,
32	"limit": 10,
33	"offset": 0
34	},
35	"message": "Success"
36	}
37	}