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
Get schedule by id
Retrieve a single schedule
curl --request GET \
--url https://api-sandbox.orum.io/deliver/schedules/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Orum-Version: <orum-version>'{
"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"
}
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Version of Deliver API. Use v2022-09-21.
v2022-09-21 Path Parameters
Orum generated unique id for the schedule you are fetching.
Response
Orum generated unique id for the resource.
Unique reference id for the Schedule. Generated by you.
1Describes the current status of the schedule.
active, inactive Transfer amount in integral cents (example: 100 = $1). Must be greater than zero.
x >= 1Currency code in ISO 4217 format. Only USD is supported.
USD Speed of transfer.
asap, standard, same_day, wire The date when the schedule starts, in YYYY-MM-DD format.
"2025-01-01"
Recurrence of the schedule in iCalendar RRULE format
"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR"
The date when the schedule will execute
"2025-01-01"
Timestamp when the resource was created.
Timestamp when the resource was last updated.
The human-readable cadence of the schedule.
"Weekly on Monday, Wednesday, and Friday"
For use cases that require a Source, information about the transfer funding source, which will be debited.
Unique reference ID for the customer (person or business) associated with the external account being debited.
1Unique reference ID for the external account being debited.
1The 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.
Information about the transfer funds destination, which will be credited.
Unique reference ID for the customer (person or business) associated with the external account being credited.
1Unique reference ID for the account being credited.
1The 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.
Was this page helpful?
curl --request GET \
--url https://api-sandbox.orum.io/deliver/schedules/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Orum-Version: <orum-version>'{
"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"
}
}