Client reports

The Client Reports operations includes APIs for managing client accounts.

Operations

List all Clients

Request

Return a list of all client accounts.

Security

ApiKeyAuth

Query

Takestring

Skipstring

SortColumnstring

SortOrderstring(SortOrder)

The sort order for list results.

Enum Value	Description
ASC	Ascending order (oldest first).
DESC	Descending order (newest first).

SearchTextstring

Termstring

Client-Idstring, (ulid)required

X-Acting-As-Client-Idstring, (ulid)

The child client this request acts on behalf of. A reseller still authenticates as itself — Api-Key and Client-Id stay the reseller's — and names the child here.

This works only from a parent to its own children. Merchants have no children, so a merchant calling as itself omits the header. Sending your own client ULID here is not the same as omitting it, and is rejected on some operations.

curl -i -X GET \
  https://developer.reefpay.net/_mock/apis/openapi/v1/clients \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Client-Id: CLIENT-01KFDKXMQ637EKEAY410MSQSXB'

Responses

Client list returned successfully

Headers

x-request-idstring, (uuid)^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...required

Unique identifier assigned to the request by the API server. Returned on every response, including errors. Log this value and supply it when contacting support so that a specific request can be traced.

Bodyapplication/json

all_clientsArray of objects(ClientDTO)required

List of client account summaries.

correlation_idstring(CorrelationId)

Identifier the gateway assigns to the request and carries across the services that handled it. Quote it when reporting a problem.

Response