Payment
Get Company Payments Methods
GET https://api-b2b.bigcommerce.com/api/v2/io/companies/{companyId}/payments⚠️
This endpoint is deprecated.
Request
Get company payments methods, include inactive
Authentication
- authToken in header
Parameters
- companyId in path - stringrequired
- authToken in header - stringrequiredAuth token in header.
example
curl --request GET \
--url 'https://api-b2b.bigcommerce.com/api/v2/io/companies/[companyId]/payments' \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
Response Success
Body
object | application/json
codenumber
Response status codedataarray[object]
example
{
"code": 200,
"data": [
{
"code": "cheque",
"isEnabled": "1",
"name": "Check",
"paymentId": 3
},
{
"code": "bankdeposit",
"isEnabled": "0",
"name": "Bank Deposit",
"paymentId": 6
},
{
"code": "cod",
"isEnabled": "0",
"name": "Cash on Delivery",
"paymentId": 7
},
{
"code": "moneyorder",
"isEnabled": "0",
"name": "Money Order",
"paymentId": 8
},
{
"code": "testgateway",
"isEnabled": "0",
"name": "Test Payment Gateway",
Update Company Payments Methods
PUT https://api-b2b.bigcommerce.com/api/v2/io/companies/{companyId}/payments⚠️
This endpoint is deprecated.
Request
Update Company payments methods' status, change them active or not
Authentication
- authToken in header
Parameters
- companyId in path - stringrequired
- authToken in header - stringrequiredAuth token in header.
Body
object | application/json
Request body
paymentsarray[object]
example
{
"payments": [
{
"isEnabled": "string",
"paymentId": "string"
}
]
}
Response
Response Success
Body
object | application/json
codenumber
Response status codedataobject
Response data
example
{
"code": 200,
"data": {
"customerId": 2
},
"message": "Success"
}
Get Store's All Payments
GET https://api-b2b.bigcommerce.com/api/v2/io/store/payments⚠️
This endpoint is deprecated.
Request
Get store's all payments
Authentication
- authToken in header
Parameters
- authToken in header - stringrequiredAuth token in header.
example
curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v2/io/store/payments \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
Response Success
Body
object | application/json
codenumber
Response status codedataobject
Response data
example
{
"code": 200,
"data": {
"list": [
{
"paymentCode": "authorizenet",
"paymentTitle": "Authorize.net"
},
{
"paymentCode": "braintree",
"paymentTitle": "Braintree"
},
{
"paymentCode": "cheque",
"paymentTitle": "Check"
},
{
"paymentCode": "testgateway",
"paymentTitle": "Test Payment Gateway"
}
]
},
"message": "SUCCESS"
}
Did you find what you were looking for?