B2B Edition
B2B Edition APIs
Server to Server Management APIs
Payment

Payment

BigCommerce B2B Edition Payment management

Get Payments of Store

GET /payments

Request

Get all payments of stores.

Authentication

  • authToken in header

example

Response

OK

Body

object | application/json
Response for successful request

  • code    integer

    Response code of success request.
    Example: 200

  • meta    object

  • data    array[object]

example-1

Get Company Payments

GET /companies/{companyId}/payments

Request

Get all payments of one company.

Authentication

  • authToken in header

Parameters

  • companyId in path - integer
    required
    Company ID

example

Response

OK

Body

object | application/json
Response for successful request

  • code    integer

    Response code of success request.
    Example: 200

  • meta    object

  • data    array[object]

example-1

Update Company Payments

PUT /companies/{companyId}/payments

Request

Update payment method to the company in batch.

Authentication

  • authToken in header

Parameters

  • companyId in path - integer
    required
    Company ID

Body

object | application/json

  • payments    array[object]

example-1

Response

OK

Body

object | application/json
Response for successful request

  • code    integer

    Response code of success request.
    Example: 200

  • meta    object

  • data    array[]

example-1

Get all Company Payment Methods

GET /company-payment-methods

Request

Get all company payment methods, can use filter & search parameters.

Authentication

  • authToken in header

Parameters

  • orderBy in query with default of DESC - string
    Order by, DESC or ASC, default: DESC
  • sortBy in query with default of updatedAt - string
    Sort by, support updatedAt & createdAt
  • limit in query with default of 10 - string
    Pagination limit default: 10
  • offset in query with default of 0 - string
    Pagination offset default: 0
  • companyId in query - string
    The companyId filter
  • q in query - string
    The search parameters support search in payment method code & payment method title.

example

Response

OK

Body

object | application/json

  • code    number
    required

  • data    array[object]
    required

  • meta    object
    required

example-1

Get Company Credit

GET /companies/{companyId}/credit

Request

Get company credit configs, should enable store company credit feature first.

Authentication

  • authToken in header

Parameters

  • companyId in path - string
    required

example

Response

OK

Body

object | application/json

  • code    integer

  • meta    object

  • data    object

Example 1

Update Company Credit

PUT /companies/{companyId}/credit

Request

Update company credit config. All fields are optional, but please provide at least one. When company credit is not enabled, other fields cannot be updated.

Authentication

  • authToken in header

Parameters

  • companyId in path - string
    required

Body

object | application/json

  • creditEnabled    boolean

    Whether credit is enabled for the company.

  • creditCurrency    string

    Currency code of the company's credit account.

  • availableCredit    number

    The amount of credit available to the company.

  • limitPurchases    boolean

    Whether the customer is allowed to make purchases using purchase orders when total price exceeds available credit.

  • creditHold    boolean

    Prevents all company users from making purchases.

Example 1

Response

OK

Body

object | application/json

  • code    integer

  • meta    object

  • data    object

Example 1

Get Company Payment Terms

GET /companies/{companyId}/payment-terms

Request

Get the payment terms of the company.

Authentication

  • authToken in header

Parameters

  • companyId in path - integer
    required

example

Response

OK

Body

object | application/json

  • code    integer

    Default: 200

  • data    object

  • meta    object

Example 1

Update Company Payment Terms

PUT /companies/{companyId}/payment-terms

Request

Edit the company's payment terms.

Authentication

  • authToken in header

Parameters

  • companyId in path - integer
    required

Body

object | application/json

  • isEnabled    boolean
    required

  • paymentTerms    integer
    required

    Payment terms must be in [0, 5, 15, 30, 45, 60].

example

Response

OK

Body

object | application/json

  • code    integer

    Default: 200

  • data    object

  • meta    object

Example 1

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Get Order Extra Field ConfigsGet Payments of Store