Get a batch of payees

Request

Payees (previously "beneficiaries"). Retrieves the details of a payee batch identified by the batchId path parameter.

Security

auth_token and api-key

Path

idstring^[0-9]+$required

The unique identifier of a payee batch.

curl -i -X GET \
  'https://sandbox.weavr.io/multi/beneficiaries/batch/{id}' \
  -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

operationBatchIdobject(BeneficiaryOperationBatchId)required

tagstring, <= 50 characters(Tag)^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

statestring(BeneficiaryBatchState)required

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

Response

{
  "operationBatchId": {
    "batchId": "string",
    "operation": "CREATE"
  },
  "tag": "string",
  "state": "INITIALISED"
}