Skip to main content
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

​
id
string
required

The unique identifier for a PayWithdrawal, prefixed with w_

Example:

"w_<id>"

​
netAmount
WithdrawalNetAmount · object
required

The amount of money the member received after fees

​
fee
WithdrawalFee · object
required

The fee charged for the withdrawal

​
payCycleId
string
required

The unique identifier for a PayCycle, prefixed with pc_

Example:

"pc_<id>"

​
memberId
string
required

The unique identifier for a Member, prefixed with mem_

Example:

"mem_<id>"

​
createdAt
string<date-time>
required
Pattern: ^((\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-((0[13578]|1[02])-(0[1-9]|[12]\d|3[01])|(0[469]|11)-(0[1-9]|[12]\d|30)|(02)-(0[1-9]|1\d|2[0-8])))T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.\d+)?(Z)$