Skip to main content
POST
/
v1
/
pay
/
run
Upload pay details to make pay available to your members
curl --request POST \
  --url https://api.onsi.com/v1/pay/run \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "payDetails": [
    {
      "memberId": "mem_<id>",
      "money": {
        "amount": 1050,
        "currency": "GBP"
      }
    }
  ]
}
'
{
  "id": "pr_<id>",
  "payCycleId": "pc_<id>",
  "status": "Scheduled",
  "scheduledFor": "2024-01-01T00:00:00Z"
}
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
header
required

Headers

​
x-idempotency-key
string

Unique key to ensure idempotency of the request

Body

application/json

Body

​
payDetails
object[]
required

Response

201 - application/json

A pay run is a list of members and the amount of money they are able to withdraw

  • PayRunDraft
  • PayRunReverted
  • PayRunAvailable
  • PayRunScheduled

A pay run is a list of members and the amount of money they are able to withdraw

​
id
string
required
​
payCycleId
string
required
​
status
enum<string>
required
Available options:
Draft