List payee batches
GET
/beneficiaries/batch Returns the logged-in identity's payee batches, filtered by state, operation, or tag. Payees were previously called beneficiaries, which is why the paths and field names still say beneficiary.
Request
Available on
SandboxProduction
Query parameters
Responses
200OK
Success
Headers
Body
application/json
objectobject · 3 fields
Response example
{ "batches": [ { "operationBatchId": { "batchId": "123456789", "operation": "CREATE" }, "tag": "customer-123", "state": "INITIALISED" } ], "count": 0, "responseCount": 0}