Skip to main content
POST
Create a schedule
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