For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
    • Archive
        • V2 API
              • GETGet Company Payments Methods
              • PUTUpdate Company Payments Methods
              • GETGet Store's All Payments
    • Closed Beta Programs
Dev Portal
LogoLogo
ArchiveB2B EditionV2 APIPayment

Update Company Payments Methods

Deprecated
PUT
https://api-b2b.bigcommerce.com/api/v2/io/companies/:companyId/payments
PUT
/api/v2/io/companies/:companyId/payments
$curl -X PUT https://api-b2b.bigcommerce.com/api/v2/io/companies/companyId/payments \
>     -H "authToken: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "code": 200,
3  "data": {
4    "customerId": 2
5  },
6  "message": "Success"
7}
Update Company payments methods' status, change them active or not
Was this page helpful?
Previous

Get Company Payments Methods

Next

Get Store's All Payments

Built with

Authentication

authTokenstring
API Key authentication via header

Path parameters

companyIdstringRequired

Headers

authTokenstringRequired
Auth token in header.

Request

Request body
paymentslist of objectsOptional

Response

Response Success
codedouble
Response status code
dataobject
Response data
messagestring
Response message

Errors

400
Bad Request Error
404
Not Found Error