Withdrawal

Withdrawals can be retrieved via the Get Withdrawals endpoint, if you are using Embedded Pay you can create a withdrawal on behalf of a member via the Create Withdrawal Intent endpoint.

A withdrawal is a completed On Demand Pay withdrawal from the member to their bank account

Pay run

{
  "id": "w_<id>",
  "netAmount": {
    "amount": 1050,
    "currency": "GBP"
  },
  "fee": {
    "amount": 1050,
    "currency": "GBP"
  },
  "payCycleId": "pc_<id>",
  "memberId": "mem_<id>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Get Started

Member Management

On Demand Pay

Schemas