On Demand Pay
Get Cycle Deductions
GET
This endpoint returns a list of all members who have withdrawn during this pay cycle. Members who have not withdrawn will not be included in the response.
For each member we provide a total of the deductions made during this pay cycle.
For example:
- Bob makes 2 £100 withdrawals during the pay cycle.
- Jane made no withdrawals during the pay cycle.
We have written a guide for end of cycle processing for your pay cycle, which will walk through the recommended sequencing of calls to this endpoint.
Ensure that you have checked the pay cycle is Closed
before processing any payroll deductions using this endpoint -
Otherwise withdrawals may still be made.
Authorizations
Path Parameters
The unique identifier for a PayCycle, prefixed with pc_
Example:
"pc_<id>"
Response
200 - application/json
200
The response is of type object
.