Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Account - company level

Get a company account

Returns the company account specified in the path. Your API credential must have access to the company account.

To make this request, your API credential must have the following roles:

  • Management API—Account read
get/companies/{companyId}

Path parameters

companyIdstring required

The unique identifier of the company account.

Response

OK - the request has succeeded.

descriptionstring

Your description for the company account, maximum 300 characters

idstring

The unique identifier of the company account.

namestring

The legal or trading name of the company.

referencestring

Your reference to the account

statusstring

The status of the company account.

Possible values:

  • Active: Users can log in. Processing and payout capabilities depend on the status of the merchant account.
  • Inactive: Users can log in. Payment processing and payouts are disabled.
  • Closed: The company account is closed and this cannot be reversed. Users cannot log in. Payment processing and payouts are disabled.