Search transfers

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

Search transfers by various criteria to find payouts by recipient, amount, status, metadata, and more. The Search API provides powerful full-text search capabilities across all transfers in your account.

---

Request Parameters

Recommended - 2 fieldsRecommended Parameters

▼

`query`STRING(optional)

Search query string. Searches across transfer metadata, recipient name, bank account details, and other transfer information. Supports multiple words (AND logic) and partial matches.

Example:"payout merchant"

`filters`OBJECT(optional)

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

Example:{"sent":true,"paid":true}

Optional - 3 fieldsPagination Parameters

▼

---

Responses

200

Successful search

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

Response includes:

• object - Always "search"
• data - Array of transfer 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/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=payout merchant" \
  -d "filters[sent]=true" \
  -d "filters[paid]=true"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Transfer.search({
  query: 'payout merchant',
  filters: {
    sent: true,
    paid: true
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Transfer.search(
    query='payout merchant',
    filters={
        'sent': True,
        'paid': True
    }
)

Node.js

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

const results = await omise.transfers.search({
  query: 'payout merchant',
  filters: {
    sent: true,
    paid: true
  }
});

PHP

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

$results = OmiseTransfer::search([
    'query' => 'payout merchant',
    'filters' => [
        'sent' => true,
        'paid' => true
    ]
]);

Java

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

Map<String, Object> filters = new HashMap<>();
filters.put("sent", true);
filters.put("paid", true);

SearchResult<Transfer> results = client.transfers().search()
    .query("payout merchant")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Transfers.Search(new SearchRequest
{
    Query = "payout merchant",
    Filters = new Dictionary<string, object>
    {
        { "sent", true },
        { "paid", true }
    }
});

Go

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

results, _ := client.Transfers().Search(&operations.SearchTransfers{
    Query: "payout merchant",
    Filters: map[string]interface{}{
        "sent": true,
        "paid": true,
    },
})

---

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
amount	integer	Transfer amount in smallest currency unit
currency	string	Currency code (thb, jpy, sgd, myr, usd, etc.)
recipient	string	Recipient ID to filter by
sent	boolean	Whether transfer has been sent (true/false)
paid	boolean	Whether transfer has been paid (true/false)
created	object	Date range filter (e.g., {gte: '2025-01-01', lte: '2025-01-31'})
failure_code	string	Filter by specific failure code

---

🔑API Credentials

▼

Try it out

Recommended - 2 fields

▼

Additional - 3 fields

▼

Your IP: ...Loading...