Get Company Payments Methods

Deprecated

GET

https://api-b2b.bigcommerce.com/api/v2/io/companies/:companyId/payments

GET

/api/v2/io/companies/:companyId/payments

$ curl https://api-b2b.bigcommerce.com/api/v2/io/companies/companyId/payments \
>      -H "authToken: <apiKey>"

200Payment_companies_payments_list_example

1 {
2   "code": 200,
3   "data": [
4     {
5       "code": "cheque",
6       "isEnabled": "1",
7       "name": "Check",
8       "paymentId": 3
9     },
10     {
11       "code": "bankdeposit",
12       "isEnabled": "0",
13       "name": "Bank Deposit",
14       "paymentId": 6
15     },
16     {
17       "code": "cod",
18       "isEnabled": "0",
19       "name": "Cash on Delivery",
20       "paymentId": 7
21     },
22     {
23       "code": "moneyorder",
24       "isEnabled": "0",
25       "name": "Money Order",
26       "paymentId": 8
27     },
28     {
29       "code": "testgateway",
30       "isEnabled": "0",
31       "name": "Test Payment Gateway",
32       "paymentId": 5
33     }
34   ],
35   "message": "SUCCESS"
36 }

Get company payments methods, include inactive

Authentication

authTokenstring

API Key authentication via header

Path parameters

companyIdstringRequired

Response

Response Success

codedoubleOptional

Response status code

datalist of objectsOptional

messagestringOptional

Response message

Authentication

Path parameters

Headers

Response