Archive
B2B Edition
V2 API
Payment

Payment

Get Company Payments Methods

GET /companies/{companyId}/payments
⚠️
This endpoint is deprecated.

Request

Get company payments methods, include inactive

Authentication

  • authToken in header

Parameters

  • companyId in path - string
    required
  • authToken in header - string
    required
    Auth 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

  • code    number

    Response status code

  • data    array[object]

  • message    string

    Response message

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 /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 - string
    required
  • authToken in header - string
    required
    Auth token in header.

Body

object | application/json
Request body

  • payments    array[object]

example

{
"payments": [
{
"isEnabled": "string",
"paymentId": "string"
}
]
}

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

    Response data

  • message    string

    Response message

example

{
"code": 200,
"data": {
"customerId": 2
},
"message": "Success"
}

Get Store's All Payments

GET /store/payments
⚠️
This endpoint is deprecated.

Request

Get store's all payments

Authentication

  • authToken in header

Parameters

  • authToken in header - string
    required
    Auth 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

  • code    number

    Response status code

  • data    object

    Response data

  • message    string

    Response message

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?
Get Order ProductGet Company Payments Methods