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",
  "speed": "asap",
  "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>"
  }
}
'

{
  "schedule": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "schedule_reference_id": "<string>",
    "status": "active",
    "amount": 2,
    "currency": "USD",
    "speed": "asap",
    "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>"
    }
  }
}

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",
  "speed": "asap",
  "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>"
  }
}
'

{
  "schedule": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "schedule_reference_id": "<string>",
    "status": "active",
    "amount": 2,
    "currency": "USD",
    "speed": "asap",
    "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>"
    }
  }
}

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

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

Show child attributes

source.customer_reference_id

string

required

Unique reference ID for the customer (person or business) associated with the external account being debited.

Minimum string length: 1

source.account_reference_id

string

required

Unique reference ID for the external account being debited.

Minimum string length: 1

source.statement_display_name

string | null

The name that will appear on the bank account statement of the account being debited. The field supports 16 alphanumeric characters for ACH, and 140 for RTP.

destination

TransferDestination · object

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

Show child attributes

destination.customer_reference_id

string

required

Unique reference ID for the customer (person or business) associated with the external account being credited.

Minimum string length: 1

destination.account_reference_id

string

required

Unique reference ID for the account being credited.

Minimum string length: 1

destination.statement_display_name

string | null

The name that will appear on the bank account statement of the account being credited. The field supports 16 alphanumeric characters for ACH, and 140 for RTP.

Response

200 response.

schedule

object

required

Show child attributes

schedule.id

string<uuid>

required

Orum generated unique id for the resource.

schedule.schedule_reference_id

string

required

Unique reference id for the Schedule. Generated by you.

Minimum string length: 1

schedule.status

enum<string>

required

Describes the current status of the schedule.

Available options:

active,

inactive

schedule.amount

integer

required

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

Required range: x >= 1

schedule.currency

enum<string>

required

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

Available options:

USD

schedule.speed

enum<string>

required

Speed of transfer.

Available options:

asap,

standard,

same_day,

wire

schedule.start_date

string<date>

required

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

Example:

"2025-01-01"

schedule.recurrence

string

required

Recurrence of the schedule in iCalendar RRULE format

Example:

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

schedule.next_payment_date

string<date>

required

The date when the schedule will execute

Example:

"2025-01-01"

schedule.created_at

string<date-time>

required

Timestamp when the resource was created.

schedule.updated_at

string<date-time>

required

Timestamp when the resource was last updated.

schedule.rrule_readable

string

required

The human-readable cadence of the schedule.

Example:

"Weekly on Monday, Wednesday, and Friday"

schedule.source

Source · object

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

Show child attributes

schedule.source.customer_reference_id

string

required

Unique reference ID for the customer (person or business) associated with the external account being debited.

Minimum string length: 1

schedule.source.account_reference_id

string

required

Unique reference ID for the external account being debited.

Minimum string length: 1

schedule.source.statement_display_name

string | null

The name that will appear on the bank account statement of the account being debited. The field supports 16 alphanumeric characters for ACH, and 140 for RTP.

schedule.destination

TransferDestination · object

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

Show child attributes

schedule.destination.customer_reference_id

string

required

Unique reference ID for the customer (person or business) associated with the external account being credited.

Minimum string length: 1

schedule.destination.account_reference_id

string

required

Unique reference ID for the account being credited.

Minimum string length: 1

schedule.destination.statement_display_name

string | null

The name that will appear on the bank account statement of the account being credited. The field supports 16 alphanumeric characters for ACH, and 140 for RTP.

Get Transfer History by ID Validate and parse RRULE string

⌘I

Auth API

Deliver API

Verify API

Webhooks API

Create a schedule

Authorizations

Headers

Body

Response