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

PayRunDraft

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

PayRunReverted

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

PayRunAvailable

A pay run is a list of members and the amount of money they are able to withdraw
A pay run that is scheduled to run at a future date

PayRunScheduled

The Onsi API is a RESTful API that allows you to manage your Onsi platform

Onsi API

Introduction

Error Handling

Learn how to make idempotent requests to the Onsi API.

Idempotency

Learn about what rate limits are and how to handle them.

Rate Limits

Changelog

Everything you need to know about managing your members via the Onsi Member API. Below you'll find documentation on how to create and update your members without the need for manual administration via the Onsi Platform.

Get Started

Everything you need to know about how to seamlessly manage your Pay programme with the Onsi On-demand Pay API. Below you'll find documentation on how to integrate Pay into your application.

Embedded Pay

Learn how to efficiently process end of cycle deductions and integrate them with your payroll system using the Onsi API.

End of Cycle Processing

Search Members

Get Job

Get Tiers

Get Member Balance

Get Withdrawals

Create Withdrawal Intent

Complete Withdrawal

Create Pay Run

Search pay cycles, returns the latest pay cycle first

Get Cycles

Get Cycle

Get Cycle Deductions

Member Management API

On-demand Pay API

An explanation of the `Money` object commonly returned from our APIs

Get Started

Member Management

On Demand Pay

Schemas

Pay run