Mass Beneficiaries
Retrieve a mass beneficiary submission
GET
Retrieve a mass beneficiary submission
Retrieve a single mass beneficiary submission by its ID
The
status field will provide the latest status of the submission.Headers
The access token.
Path Parameters
The ID of the mass beneficiary.
Query Parameters
The identifier of a client.
Response
The mass beneficiary
This model is a representation of a mass beneficiary.
Unique UUID of the mass beneficiary.
The generic error message for the mass beneficiary request, if any.
Links to the resources related to the errored and successfully created beneficiaries of a mass beneficiary. The mass_beneficiary_id does not need to be stored, as these resources may be accessed with the provided links.
Categorized counters for the mass beneficiary.
The status of a mass beneficiary instruction:
pending: The mass beneficiary is pending to be processed.creating: The mass beneficiary is being processed.created: The mass beneficiary has been successfully processed.failed: The mass beneficiary has failed during processing.unknown: The mass beneficiary has an unknown status.
Available options:
pending, creating, created, failed, unknown