Skip to content

Batch reports

The Batch reports operations includes APIs for generating reports on batches.

Operations

List Batches

Request

Return a list of batches. Use the query parameters to filter and sort the results.

Security
ApiKeyAuth
Query
skipstring
takestring
sort_columnstring
sort_orderstring(SortOrder)

The sort order for list results.

Enum ValueDescription
ASC

Ascending order (oldest first).

DESC

Descending order (newest first).

search_textstring
termstring
Headers
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/batches \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Client-Id: CLIENT-01KFDKXMQ637EKEAY410MSQSXB'

Responses

Batch 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
countinteger, (int64)required

Total number of batch records matching the query.

resultsArray of objects(BatchElasticModel)required

List of batch records.

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
{
  "count": 3,
  "results": [
    { … }
  ],
  "correlation_id": "01KFDKXMQ637EKEAY410MSQSXB"
}