POST /getTerminalsUnderAccount

Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded).

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
companyAccount String Yes

Your company account. If you only specify this parameter, the response includes all terminals at all account levels.

merchantAccount String No

The merchant account. This is required if you are retrieving the terminals assigned to a store.If you don't specify a store the response includes the terminals assigned to the specified merchant account and the terminals assigned to the stores under this merchant account.

store String No

The store code of the store. With this parameter, the response only includes the terminals assigned to the specified store.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.