Five read endpoints cover the account side. They answer two questions: who is in my portfolio, and is each one wired up correctly.
| Endpoint | Answers |
|---|---|
GET /v1/clients | Which clients do I own |
GET /v1/clients/{clientId} | What does this one look like |
GET /v1/integrations | Which integrations exist |
GET /v1/integrations/{id} | What is this integration's full configuration |
GET /v1/integrations/summary/{id} | Is this client wired up, briefly |
A reseller sees its own subtree. A merchant sees only itself.
The query parameters here are PascalCase. This endpoint is the exception in an otherwise snake_case API, and it has not been reconciled:
| Parameter | Does |
|---|---|
Take | Page size |
Skip | Records to skip |
SortColumn | Column to sort on |
SortOrder | ASC or DESC |
SearchText | Free-text search |
Term | Additional filter term |
Sending take or skip in lower case does not work. Compare the transaction endpoints, which use limit and offset, and GET /v1/batches, which uses skip and take in lower case. Three endpoints, three conventions.
Returns the client's DBA, type, addresses, contact details, and metadata.
It does not return the API key. Nothing does, after the create response. If a merchant has lost its key, the key has to be reissued rather than looked up.
The summary endpoint is the quick one — it answers "is this client able to process, and on which rails".
Each entry carries id, processor, and is_active and nothing else. That is usually all a portfolio view needs, and it avoids pulling 40 fields of TSYS host configuration per merchant.
For the full configuration, read one integration directly:
Reading before updating is worth doing here. An integration update requires the complete integration_details, so this response is where you get the object to modify. See Connect a processor.
Account reports cover accounts. For payment activity, use the transaction endpoints, either with client_id as a filter to see one merchant inside your portfolio, or with X-Acting-As-Client-Id to read as that merchant.
Find and report on transactions covers the filters, and Act on behalf of a client covers the header.