How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Onsi pay API

The pay API from Onsi — 9 operation(s) for pay.

Onsi pay API is one of 2 APIs that Onsi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pay. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 9 paths, and defines 18 schemas. It is described by OpenAPI 3.0.2, at version v1.

Requests are made against 2 base URLs: https://api.onsi.com, https://api.onsi.dev.

9 operations 9 paths 18 schemas 6 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
v1
Base URL
https://api.onsi.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Onsi pay API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (apiKey). By default, every request must be authenticated.

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 6 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

pay 9
GET
/v1/pay/members/{memberId}/balance
Show available balance for the member
getMemberBalance 1 param → 200
POST
/v1/pay/withdrawals/intent
Create a withdrawal intent
createWithdrawalIntent 1 param body → 201
POST
/v1/pay/withdrawals/complete
Finalize a withdrawal
completeWithdrawal 1 param body → 201
GET
/v1/pay/members/{memberId}/withdrawalsdeprecated
Show withdrawals for the member
getMemberWithdrawals 3 params → 200
POST
/v1/pay/run
Upload pay details to make pay available to your members
uploadPayRun 1 param body → 201
GET
/v1/pay/cycles
Search pay cycles
getPayCycles 3 params → 200
GET
/v1/pay/cycles/{id}
Show pay cycle
getPayCycle 1 param → 200
GET
/v1/pay/cycles/{id}/deductions
Show pay cycle summary
getPayCycleDeductions 3 params → 200
GET
/v1/pay/withdrawals
Show withdrawals for the pay cycle
getWithdrawals 6 params → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Withdrawal (6 properties), PayRunScheduled (4 properties), PayCycle (4 properties), PayRunDraft (3 properties). Each schema is shown below with its type and property counts.

WithdrawalNetAmount
object
The amount of money the member received after fees
2 properties 2 required
PayRunAvailable
object
A pay run that is available for withdrawal
3 properties 3 required
PayCycle
object
A pay cycle is a period of time pay is made available for members to withdraw
4 properties 4 required
BankAccountUK
object
A UK bank account
3 properties 3 required
Total
object
The amount deducted for the member, inclusive of fees
2 properties 2 required
Fee
object
A monetary value with currency.
2 properties 2 required
LowerLimit
object
The lower limit, the member cannot withdraw below this amount
2 properties 2 required
BankAccountEU
object
A EU bank account
2 properties 2 required
Withdrawal
object
A withdrawal is a completed On Demand Pay withdrawal from the member to their bank account
6 properties 6 required
AvailableBalance
object
The balance for the member
2 properties 2 required
PayRunReverted
object
A pay run that has been reverted
3 properties 3 required
PayRun
A pay run is a list of members and the amount of money they are able to withdraw
WithdrawalFee
object
The fee charged for the withdrawal
2 properties 2 required
PayRunScheduled
object
A pay run that is scheduled to run at a future date
4 properties 4 required
PayRunDraft
object
A pay run that is in draft status
3 properties 3 required
Money
object
A monetary value with currency.
2 properties 2 required
UpperLimit
object
The upper limit, the member cannot have more than this amount
2 properties 2 required
NetAmount
object
A monetary value with currency.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onsi-pay-api-openapi.yml Raw ↑

Other APIs Onsi publishes across the network.

Onsi members API
Where this information came from

This is an independent, third-party profile of Onsi pay API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.