Mass Beneficiary Models

MassBeneficiary

This model is a representation of a mass beneficiary. Fields

string

required

Unique UUID of the mass beneficiary. (Always)

object

required

The generic error message for the mass beneficiary request, if any. (Always)

object

required

The MassBeneficiaryLinks. (Always)

object

required

The MassBeneficiarySummary. (Always)

string

required

The MassBeneficiaryStatus. (Always)

{
  "mass_beneficiary_id": "uuid",
  "error": {
    "code": "string",
    "message": "string",
    "details": "string"
  },
  "links": {
    "errors_href": "/mass-beneficiaries/$mass_beneficiary_id/errors",
    "created_href": "/mass-beneficiaries/$mass_beneficiary_id/beneficiaries",
  },
  "summary": {
    "received": "number",
    "errored": "number",
    "created": "number"
  },
  "status": "string"
}

MassBeneficiaryStatus

The possible values for the “status” of every mass beneficiary instruction. Values

Value	Description
`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.

MassBeneficiarySummary

This is an object containing categorized counters for the mass beneficiary. Fields

integer

required

Total count of received beneficiaries. (Always)

integer

required

Total count of created beneficiaries. (Always)

integer

required

Total count of errored beneficiaries. (Always)

MassBeneficiaryLinks

This is an object containing 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. Fields

string

required

The link to the errors endpoint /mass-beneficiaries/$mass_beneficiary_id/errors (Always)

string

required

The link to the result endpoint /mass-beneficiaries/$mass_beneficiary_id/beneficiaries (Always)

BeneficiaryCreationError

Creation errors of every beneficiary. Fields

string

required

A short code for the error. (Always)

string

required

Error details. (Always)

string

required

The error message. (Always)

integer

required

The original position of the beneficiary on the submission file. It starts at 0. (Always)

BeneficiaryCreated

Created beneficiaries. Fields

integer

required

The original position of the beneficiary on the submission file. It starts at 0. (Always)

string

required

The ID of the created beneficiary. (Always)

object

required

The BeneficiaryCreatedLinks. (Always)

BeneficiaryCreatedLinks

This is an object containing links for the created beneficiary. Fields

string

The link to the single beneficiary endpoint /beneficiaries/$beneficiary_id