Executing Mass Beneficiaries
Retrieve a single Mass Beneficiary submission
GET
Retrieve a single Mass Beneficiary submission
Retrieve a mass beneficiary resource for a given mass_beneficiary_id. The status field will provide the latest status.
Authorizations
An API Key.
Headers
The access token
Path Parameters
The unique ID of the mass beneficiary
Query Parameters
The ID of the client
Response
The Mass Beneficiary resource
A representation of a mass beneficiary.
Unique UUID of the mass beneficiary
An error message.
Links for the mass beneficiary related information. Each link helps the user agent to fetch resources related to errored beneficiaries, and also those created successfully. The mass_beneficiary_id does not need to be stored as the said resources may be accessed with the provided links.
Categorized counters for the mass beneficiary.
This is an enumeration of the status of every mass beneficiary instruction
Available options:
pending, creating, created, failed, unknown