POST
/
v1
/
pay
/
run

Create a pay run to make pay available to your members.

Include a list of Member IDs, and the amount you would like to make available in the form of a Money object (please see Money Object).

We will either respond with a list of issues, or with a created PayRun object.

The PayRun will, by default, be executed after a 10 minute grace period. This can be seen in the scheduledFor field of the PayRun object.

Avoiding Duplicates

We strongly reccomend using an x-idempotency-key to avoid duplicate pay run uploads, and therefore duplicate money being made available to your members.

Authorizations

X-API-KEY
string
headerrequired

Headers

x-idempotency-key
string

Unique key to ensure idempotency of the request

Body

application/json
payDetails
object[]
required

Response

201 - application/json
id
string
required
payCycleId
string
required
status
enum<string>
required
Available options:
Draft,
Reverted,
Available
Complete Withdrawal