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.
Unique key to ensure idempotency of the request
The unique identifier for a Member, prefixed with mem_
A monetary value with currency. See Money
Price in lowest denomination of currency (e.g. cents)
payDetails.money.currency
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BOV,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLF,
CLP,
CNY,
COP,
COU,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MXV,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
SSP,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
USN,
UYI,
UYU,
UYW,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XAG,
XAU,
XBA,
XBB,
XBC,
XBD,
XCD,
XDR,
XOF,
XPD,
XPF,
XPT,
XSU,
XTS,
XUA,
XXX,
YER,
ZAR,
ZMW,
ZWL
Available options:
Draft,
Reverted,
Available
