Get all payee batches

Request

Payees (previously "beneficiaries"). Retrieves all payee batches matching the query parameters and that belong to the logged-in identity.

Security

auth_token and api-key

Query

offsetinteger, (int32), >= 0

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limitinteger, (int32), [ 1 .. 100 ]

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

stateArray of strings, unique(BeneficiaryBatchState)

Items Enum:"INITIALISED""FAILED""PENDING_CHALLENGE""CHALLENGE_FAILED""CHALLENGE_COMPLETED""COMPLETED"

operationArray of strings, unique(BeneficiaryBatchOperation)

Items Enum:"CREATE""REMOVE"

tagArray of strings, unique

Filter by the payee batch tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries.

curl -i -X GET \
  'https://sandbox.weavr.io/multi/beneficiaries/batch?offset=0&limit=1&state=INITIALISED&operation=CREATE&tag=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers

request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json

batchesArray of objects(BeneficiaryBatch)

countinteger, (int32)

The total number of records (excluding the paging limit).

responseCountinteger, (int32)

The total number of records returned in this response (always capped at 100).

Response

{
  "batches": [
    { … }
  ],
  "count": 0,
  "responseCount": 0
}