Skip to main content
POST
/
deliver
/
schedules
Create a schedule
curl --request POST \
  --url https://api-sandbox.orum.io/deliver/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '
{
  "schedule_reference_id": "<string>",
  "amount": 2,
  "currency": "USD",
  "start_date": "2025-01-01",
  "recurrence": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR",
  "source": {
    "customer_reference_id": "<string>",
    "account_reference_id": "<string>",
    "statement_display_name": "<string>"
  },
  "destination": {
    "customer_reference_id": "<string>",
    "account_reference_id": "<string>",
    "statement_display_name": "<string>"
  }
}
'
import requests

url = "https://api-sandbox.orum.io/deliver/schedules"

payload = {
    "schedule_reference_id": "<string>",
    "amount": 2,
    "currency": "USD",
    "start_date": "2025-01-01",
    "recurrence": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR",
    "source": {
        "customer_reference_id": "<string>",
        "account_reference_id": "<string>",
        "statement_display_name": "<string>"
    },
    "destination": {
        "customer_reference_id": "<string>",
        "account_reference_id": "<string>",
        "statement_display_name": "<string>"
    }
}
headers = {
    "Orum-Version": "<orum-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'Orum-Version': '<orum-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    schedule_reference_id: '<string>',
    amount: 2,
    currency: 'USD',
    start_date: '2025-01-01',
    recurrence: 'RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR',
    source: {
      customer_reference_id: '<string>',
      account_reference_id: '<string>',
      statement_display_name: '<string>'
    },
    destination: {
      customer_reference_id: '<string>',
      account_reference_id: '<string>',
      statement_display_name: '<string>'
    }
  })
};

fetch('https://api-sandbox.orum.io/deliver/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://api-sandbox.orum.io/deliver/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([
    'schedule_reference_id' => '<string>',
    'amount' => 2,
    'currency' => 'USD',
    'start_date' => '2025-01-01',
    'recurrence' => 'RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR',
    'source' => [
        'customer_reference_id' => '<string>',
        'account_reference_id' => '<string>',
        'statement_display_name' => '<string>'
    ],
    'destination' => [
        'customer_reference_id' => '<string>',
        'account_reference_id' => '<string>',
        'statement_display_name' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Orum-Version: <orum-version>"
  ],
]);

$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-sandbox.orum.io/deliver/schedules"

	payload := strings.NewReader("{\n  \"schedule_reference_id\": \"<string>\",\n  \"amount\": 2,\n  \"currency\": \"USD\",\n  \"start_date\": \"2025-01-01\",\n  \"recurrence\": \"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR\",\n  \"source\": {\n    \"customer_reference_id\": \"<string>\",\n    \"account_reference_id\": \"<string>\",\n    \"statement_display_name\": \"<string>\"\n  },\n  \"destination\": {\n    \"customer_reference_id\": \"<string>\",\n    \"account_reference_id\": \"<string>\",\n    \"statement_display_name\": \"<string>\"\n  }\n}")

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

	req.Header.Add("Orum-Version", "<orum-version>")
	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://api-sandbox.orum.io/deliver/schedules")
  .header("Orum-Version", "<orum-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"schedule_reference_id\": \"<string>\",\n  \"amount\": 2,\n  \"currency\": \"USD\",\n  \"start_date\": \"2025-01-01\",\n  \"recurrence\": \"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR\",\n  \"source\": {\n    \"customer_reference_id\": \"<string>\",\n    \"account_reference_id\": \"<string>\",\n    \"statement_display_name\": \"<string>\"\n  },\n  \"destination\": {\n    \"customer_reference_id\": \"<string>\",\n    \"account_reference_id\": \"<string>\",\n    \"statement_display_name\": \"<string>\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.orum.io/deliver/schedules")

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

request = Net::HTTP::Post.new(url)
request["Orum-Version"] = '<orum-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"schedule_reference_id\": \"<string>\",\n  \"amount\": 2,\n  \"currency\": \"USD\",\n  \"start_date\": \"2025-01-01\",\n  \"recurrence\": \"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR\",\n  \"source\": {\n    \"customer_reference_id\": \"<string>\",\n    \"account_reference_id\": \"<string>\",\n    \"statement_display_name\": \"<string>\"\n  },\n  \"destination\": {\n    \"customer_reference_id\": \"<string>\",\n    \"account_reference_id\": \"<string>\",\n    \"statement_display_name\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "schedule": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "schedule_reference_id": "<string>",
    "amount": 2,
    "currency": "USD",
    "start_date": "2025-01-01",
    "recurrence": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR",
    "next_payment_date": "2025-01-01",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "rrule_readable": "Weekly on Monday, Wednesday, and Friday",
    "source": {
      "customer_reference_id": "<string>",
      "account_reference_id": "<string>",
      "statement_display_name": "<string>"
    },
    "destination": {
      "customer_reference_id": "<string>",
      "account_reference_id": "<string>",
      "statement_display_name": "<string>"
    }
  }
}
{
  "error_code": "<string>",
  "message": "<string>",
  "details": {}
}
{
  "error_code": "<string>",
  "message": "<string>",
  "details": {}
}
Either a source, destination, or both are required in the request body.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Orum-Version
enum<string>
required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Body

application/json
​
schedule_reference_id
string
required

Unique reference id for the Schedule. Generated by you.

Minimum string length: 1
​
amount
integer
required

Transfer amount in integral cents (example: 100 = $1). Must be greater than zero.

Required range: x >= 1
​
currency
enum<string>
required

Currency code in ISO 4217 format. Only USD is supported.

Available options:
USD
​
speed
enum<string>
required

Speed of transfer.

Available options:
asap,
standard,
same_day,
wire
​
start_date
string<date>
required

The date when the schedule starts, in YYYY-MM-DD format.

Example:

"2025-01-01"

​
recurrence
string
required

Recurrence of the schedule in iCalendar RRULE format

Example:

"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR"

​
source
Source · object | null

For use cases that require a Source, information about the transfer funding source, which will be debited.

​
destination
TransferDestination · object | null

Information about the transfer funds destination, which will be credited.

Response

200 response.

​
schedule
object
required