Create Pay Run

POST

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"
      }
    }
  ]
}
'

import requests

url = "https://api.onsi.com/v1/pay/run"

payload = { "payDetails": [
        {
            "memberId": "mem_<id>",
            "money": {
                "amount": 1050,
                "currency": "GBP"
            }
        }
    ] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({payDetails: [{memberId: 'mem_<id>', money: {amount: 1050, currency: 'GBP'}}]})
};

fetch('https://api.onsi.com/v1/pay/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onsi.com/v1/pay/run",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payDetails' => [
        [
                'memberId' => 'mem_<id>',
                'money' => [
                                'amount' => 1050,
                                'currency' => 'GBP'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onsi.com/v1/pay/run"

	payload := strings.NewReader("{\n  \"payDetails\": [\n    {\n      \"memberId\": \"mem_<id>\",\n      \"money\": {\n        \"amount\": 1050,\n        \"currency\": \"GBP\"\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.onsi.com/v1/pay/run")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payDetails\": [\n    {\n      \"memberId\": \"mem_<id>\",\n      \"money\": {\n        \"amount\": 1050,\n        \"currency\": \"GBP\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onsi.com/v1/pay/run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payDetails\": [\n    {\n      \"memberId\": \"mem_<id>\",\n      \"money\": {\n        \"amount\": 1050,\n        \"currency\": \"GBP\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "pr_<id>",
  "payCycleId": "pc_<id>",
  "status": "Scheduled"
}

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

Show child attributes

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 that is in draft status

string

required

payCycleId

string

required

The unique identifier for a PayCycle, prefixed with pc_

Example:

"pc_<id>"

status

enum<string>

required

Available options:

Draft

Get CyclesSearch pay cycles, returns the latest pay cycle first

⌘I

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"
      }
    }
  ]
}
'

import requests

url = "https://api.onsi.com/v1/pay/run"

payload = { "payDetails": [
        {
            "memberId": "mem_<id>",
            "money": {
                "amount": 1050,
                "currency": "GBP"
            }
        }
    ] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({payDetails: [{memberId: 'mem_<id>', money: {amount: 1050, currency: 'GBP'}}]})
};

fetch('https://api.onsi.com/v1/pay/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onsi.com/v1/pay/run",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payDetails' => [
        [
                'memberId' => 'mem_<id>',
                'money' => [
                                'amount' => 1050,
                                'currency' => 'GBP'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onsi.com/v1/pay/run"

	payload := strings.NewReader("{\n  \"payDetails\": [\n    {\n      \"memberId\": \"mem_<id>\",\n      \"money\": {\n        \"amount\": 1050,\n        \"currency\": \"GBP\"\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.onsi.com/v1/pay/run")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payDetails\": [\n    {\n      \"memberId\": \"mem_<id>\",\n      \"money\": {\n        \"amount\": 1050,\n        \"currency\": \"GBP\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onsi.com/v1/pay/run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payDetails\": [\n    {\n      \"memberId\": \"mem_<id>\",\n      \"money\": {\n        \"amount\": 1050,\n        \"currency\": \"GBP\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "pr_<id>",
  "payCycleId": "pc_<id>",
  "status": "Scheduled"
}

Members

Tiering

On Demand Pay

Avoiding Duplicates

Authorizations

Headers

Body

Response