Search transfer schedules

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

Search transfer schedules to find automated payout schedules by status, recipient, amount, and other criteria. The Search API provides powerful filtering capabilities to locate specific transfer schedules.

---

Request Parameters

Recommended - 2 fieldsRecommended Parameters

▼

`query`STRING(optional)

Search query string. Searches across schedule metadata and recipient information.

Example:"monthly payout"

`filters`OBJECT(optional)

Filter criteria to narrow search results. Common filters include status, amount, recipient, and created date ranges.

Example:{"status":"active"}

Optional - 3 fieldsPagination Parameters

▼

---

Responses

200

Successful search

Search completed successfully. Returns a search result object with matching transfer schedules in the data array.

Response includes:

• object - Always "search"
• data - Array of transfer schedule objects matching the search criteria
• total - Total number of results matching the search
• total_pages - Number of pages available
• page - Current page number
• per_page - Number of results per page
• order - Sort order applied

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid page number (below 1)
• Invalid per_page value (above 100 or below 1)
• Malformed filters object
• Invalid filter field names

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

404

Not found

Search endpoint not found or search feature not enabled.

Common causes:

• Search feature not enabled for your account
• Invalid endpoint URL

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/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=monthly payout" \
  -d "filters[status]=active"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Transfer.search_schedules({
  query: 'monthly payout',
  filters: {
    status: 'active'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Transfer.search_schedules(
    query='monthly payout',
    filters={
        'status': 'active'
    }
)

Node.js

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

const results = await omise.transfers.searchSchedules({
  query: 'monthly payout',
  filters: {
    status: 'active'
  }
});

PHP

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

$results = OmiseTransfer::searchSchedules([
    'query' => 'monthly payout',
    'filters' => [
        'status' => 'active'
    ]
]);

Java

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

Map<String, Object> filters = new HashMap<>();
filters.put("status", "active");

SearchResult<Schedule> results = client.transfers().searchSchedules()
    .query("monthly payout")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Transfers.SearchSchedules(new SearchRequest
{
    Query = "monthly payout",
    Filters = new Dictionary<string, object>
    {
        { "status", "active" }
    }
});

Go

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

results, _ := client.Transfers().SearchSchedules(&operations.SearchTransferSchedules{
    Query: "monthly payout",
    Filters: map[string]interface{}{
        "status": "active",
    },
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Missing or invalid parameters	Check that parameters are valid
authentication_failure	Invalid API key	Verify your secret key is correct

Search Filter Options

Filter	Type	Description
status	string	Schedule status (active, expired, suspended, deleted, paused)
recipient	string	Recipient ID to filter by
amount	integer	Transfer amount in smallest currency unit
period	string	Schedule period (day, week, month)
created	object	Date range filter (e.g., {gte: '2025-01-01', lte: '2025-01-31'})

---

🔑API Credentials

▼

Try it out

Recommended - 2 fields

▼

Additional - 3 fields

▼

Your IP: ...Loading...