refundStatus

Synopsis The status of any refund payment due to the employer.
Where used

/accounts/.../opt-outs response

The possible values for this property are:

No Refund – We have confirmed the employee is not entitled to a refund.
Processing – We are awaiting settlement of allocated contributions before the refund can be made to the employer’s online account.
Processed – The contributions have been refunded back to the employer’s online account.

Data type

String

Constraints/format

One of the values "No Refund", "Processing", or "Processed"

Example

...
"refundStatus": "No Refund",
...

See also

employeeRefund

employerRefund

entitledToRefund

optOuts