curl --request POST \
--url https://app.sideshift.app/api/oauth/v1/quick-pay/schedules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"recipients": [
{
"email": "jsmith@example.com",
"lineItems": [
{
"quantity": 123,
"unitPrice": 123,
"description": "<string>"
}
],
"notes": "<string>"
}
],
"dayOfWeek": 3,
"dayOfMonth": 14,
"requiresApproval": true
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/quick-pay/schedules"
payload = {
"name": "<string>",
"recipients": [
{
"email": "jsmith@example.com",
"lineItems": [
{
"quantity": 123,
"unitPrice": 123,
"description": "<string>"
}
],
"notes": "<string>"
}
],
"dayOfWeek": 3,
"dayOfMonth": 14,
"requiresApproval": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
recipients: [
{
email: 'jsmith@example.com',
lineItems: [{quantity: 123, unitPrice: 123, description: '<string>'}],
notes: '<string>'
}
],
dayOfWeek: 3,
dayOfMonth: 14,
requiresApproval: true
})
};
fetch('https://app.sideshift.app/api/oauth/v1/quick-pay/schedules', 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://app.sideshift.app/api/oauth/v1/quick-pay/schedules",
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([
'name' => '<string>',
'recipients' => [
[
'email' => 'jsmith@example.com',
'lineItems' => [
[
'quantity' => 123,
'unitPrice' => 123,
'description' => '<string>'
]
],
'notes' => '<string>'
]
],
'dayOfWeek' => 3,
'dayOfMonth' => 14,
'requiresApproval' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.sideshift.app/api/oauth/v1/quick-pay/schedules"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"recipients\": [\n {\n \"email\": \"jsmith@example.com\",\n \"lineItems\": [\n {\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"notes\": \"<string>\"\n }\n ],\n \"dayOfWeek\": 3,\n \"dayOfMonth\": 14,\n \"requiresApproval\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.sideshift.app/api/oauth/v1/quick-pay/schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"recipients\": [\n {\n \"email\": \"jsmith@example.com\",\n \"lineItems\": [\n {\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"notes\": \"<string>\"\n }\n ],\n \"dayOfWeek\": 3,\n \"dayOfMonth\": 14,\n \"requiresApproval\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/quick-pay/schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"recipients\": [\n {\n \"email\": \"jsmith@example.com\",\n \"lineItems\": [\n {\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"notes\": \"<string>\"\n }\n ],\n \"dayOfWeek\": 3,\n \"dayOfMonth\": 14,\n \"requiresApproval\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"schedule": {
"id": "<string>",
"companyId": "<string>",
"name": "<string>",
"createdBy": "<string>",
"createdAt": 123,
"updatedAt": 123,
"dayOfWeek": 123,
"dayOfMonth": 123,
"nextRunAt": 123,
"lastRunAt": 123,
"recipients": [
{
"email": "jsmith@example.com",
"lineItems": [
{
"quantity": 123,
"unitPrice": 123,
"description": "<string>"
}
],
"notes": "<string>"
}
],
"totalAmount": 123,
"requiresApproval": true
}
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}List active+paused recurring schedules
list active+paused recurring schedules. Requires the quick-pay:write scope.
curl --request POST \
--url https://app.sideshift.app/api/oauth/v1/quick-pay/schedules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"recipients": [
{
"email": "jsmith@example.com",
"lineItems": [
{
"quantity": 123,
"unitPrice": 123,
"description": "<string>"
}
],
"notes": "<string>"
}
],
"dayOfWeek": 3,
"dayOfMonth": 14,
"requiresApproval": true
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/quick-pay/schedules"
payload = {
"name": "<string>",
"recipients": [
{
"email": "jsmith@example.com",
"lineItems": [
{
"quantity": 123,
"unitPrice": 123,
"description": "<string>"
}
],
"notes": "<string>"
}
],
"dayOfWeek": 3,
"dayOfMonth": 14,
"requiresApproval": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
recipients: [
{
email: 'jsmith@example.com',
lineItems: [{quantity: 123, unitPrice: 123, description: '<string>'}],
notes: '<string>'
}
],
dayOfWeek: 3,
dayOfMonth: 14,
requiresApproval: true
})
};
fetch('https://app.sideshift.app/api/oauth/v1/quick-pay/schedules', 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://app.sideshift.app/api/oauth/v1/quick-pay/schedules",
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([
'name' => '<string>',
'recipients' => [
[
'email' => 'jsmith@example.com',
'lineItems' => [
[
'quantity' => 123,
'unitPrice' => 123,
'description' => '<string>'
]
],
'notes' => '<string>'
]
],
'dayOfWeek' => 3,
'dayOfMonth' => 14,
'requiresApproval' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.sideshift.app/api/oauth/v1/quick-pay/schedules"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"recipients\": [\n {\n \"email\": \"jsmith@example.com\",\n \"lineItems\": [\n {\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"notes\": \"<string>\"\n }\n ],\n \"dayOfWeek\": 3,\n \"dayOfMonth\": 14,\n \"requiresApproval\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.sideshift.app/api/oauth/v1/quick-pay/schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"recipients\": [\n {\n \"email\": \"jsmith@example.com\",\n \"lineItems\": [\n {\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"notes\": \"<string>\"\n }\n ],\n \"dayOfWeek\": 3,\n \"dayOfMonth\": 14,\n \"requiresApproval\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/quick-pay/schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"recipients\": [\n {\n \"email\": \"jsmith@example.com\",\n \"lineItems\": [\n {\n \"quantity\": 123,\n \"unitPrice\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"notes\": \"<string>\"\n }\n ],\n \"dayOfWeek\": 3,\n \"dayOfMonth\": 14,\n \"requiresApproval\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"schedule": {
"id": "<string>",
"companyId": "<string>",
"name": "<string>",
"createdBy": "<string>",
"createdAt": 123,
"updatedAt": 123,
"dayOfWeek": 123,
"dayOfMonth": 123,
"nextRunAt": 123,
"lastRunAt": 123,
"recipients": [
{
"email": "jsmith@example.com",
"lineItems": [
{
"quantity": 123,
"unitPrice": 123,
"description": "<string>"
}
],
"notes": "<string>"
}
],
"totalAmount": 123,
"requiresApproval": true
}
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Authorizations
OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.
Headers
Client-chosen key; replaying the same key + body returns the original response, a different body returns 409.
Body
Create a recurring payment schedule. companyId is the token's tenant, never the body.
Schedule name (1-100 chars).
How often the schedule runs.
weekly, biweekly, monthly 1Show child attributes
Show child attributes
0 (Sunday) through 6 (Saturday); used for weekly/biweekly. Defaults to 5 (Friday) when omitted.
0 <= x <= 61 through 28; used for monthly. Defaults to 1 when omitted.
1 <= x <= 28Require an approval before each run. Coerced: only the literal boolean true enables it.
Response
The created recurring schedule.
Show child attributes
Show child attributes