List transfer schedules

GEThttps://api.omise.co/transfers/schedules

List all transfer schedules belonging to your account. Transfer schedules automate recurring transfers to recipients on a defined frequency. Use this endpoint to view, monitor, and manage your automated payout schedules.

---

Request Parameters

Optional - 3 fieldsPagination Parameters

▼

`limit`INTEGER(optional)

Number of schedules to return per page.

Example:20

Constraints:Minimum: 1, Maximum: 100, Default: 20

Default:20

`offset`INTEGER(optional)

Number of schedules to skip for pagination. Use with limit to paginate through large result sets.

Example:0

Default:0

`order`STRING(optional)

Sort order of results.

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

Optional - 2 fieldsFilter Parameters

▼

---

Responses

200

Successful retrieval

Returns a paginated list of transfer schedule objects. Each schedule contains frequency, status, and transfer operation details.

Response includes:

• object - Always "list"
• data - Array of transfer schedule objects
• limit - Number of results per page
• offset - Number of skipped results
• total - Total number of transfer schedules
• order - Sort order applied

Schedule object fields:

• status - active, expired, suspended, deleted, paused
• period - day, week, or month
• every - Frequency multiplier for the period
• next_occurrences_on - Array of upcoming occurrence dates
• transfer - Transfer operation parameters (amount, recipient)

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid date format (must be ISO 8601)
• Limit exceeds maximum (100)
• Invalid order parameter
• Negative offset value

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/transfers/schedules \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d limit=20 \
  -d offset=0

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedules = Omise::Transfer.schedules({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedules = omise.Transfer.schedules(
    limit=20,
    offset=0
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const schedules = await omise.transfers.schedules({
  limit: 20,
  offset: 0
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$schedules = OmiseTransfer::schedules(array(
    'limit' => 20,
    'offset' => 0
));

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

ScopedList<Schedule> schedules = client.transfers().schedules()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var schedules = await client.Transfers.ListSchedules(new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

schedules, _ := client.Transfers().Schedules(&operations.ListTransferSchedules{
    List: operations.List{
        Limit:  20,
        Offset: 0,
    },
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
authentication_failure	Invalid API key	Verify your secret key is correct
bad_request	Invalid parameters	Check date format and parameter values
invalid_date_format	Date not in ISO 8601	Use format: YYYY-MM-DDTHH:MM:SSZ

Schedule Status Values

Status	Description
active	Schedule is running normally
expired	Schedule has passed end date
suspended	Schedule is paused (failures, recipient issues)
deleted	Schedule has been cancelled
paused	Schedule manually paused

---

🔑API Credentials

▼

Try it out

Your IP: ...Loading...