Auth API
- How to authenticate
Deliver API
- Persons
- Businesses
- External Accounts
- Cards
- Transfers
- Schedules
- Eligibility
- Transfer Groups
- Balance
- Reports
Verify API
Webhooks API
- Overview And Set Up
- Event Types and Payloads
- Configure webhooks
- Trigger webhooks
- Secure webhooks
Schedules
Create a schedule
Schedule recurring transfers.
POST
/
deliver
/
schedules
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",
"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>"
},
"start_date": "2025-01-01",
"recurrence": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR"
}'
{
"schedule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"schedule_reference_id": "<string>",
"status": "active",
"amount": 2,
"currency": "USD",
"speed": "asap",
"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>"
},
"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"
}
}
Either a source, destination, or both are required in the request body.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Version of Deliver API. Use v2022-09-21.
Available options:
v2022-09-21
Body
application/json
Response
200
application/json
200 response.
The response is of type object
.
Was this page helpful?
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",
"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>"
},
"start_date": "2025-01-01",
"recurrence": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR"
}'
{
"schedule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"schedule_reference_id": "<string>",
"status": "active",
"amount": 2,
"currency": "USD",
"speed": "asap",
"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>"
},
"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"
}
}