Search refunds

GEThttps://api.omise.co/search

Search and filter refunds to find transactions by metadata, amount, status, and more. The Search API provides powerful full-text search capabilities across all refunds.

---

Request Parameters

Required - 1 fieldRequired Parameters

▼

`scope`STRING(required)

Search scope. Must be set to "refund" to search refunds.

Example:"refund"

Values:refund

Default:"refund"

Recommended - 2 fieldsRecommended Parameters

▼

`query`STRING(optional)

Search query string. Searches across refund metadata, charge information, and transaction details. Supports multiple words (AND logic) and partial matches.

Example:"order refund"

`filters`OBJECT(optional)

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

Example:{"status":"successful","currency":"thb","voided":false}

Additional - 3 fieldsAdditional Parameters

▼

---

Responses

200

Successful search

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

Response includes:

• data - Array of refund 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 (chronological or reverse_chronological)

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Missing required scope parameter
• Invalid page number (below 1)
• Invalid per_page value (above 100 or below 1)
• Malformed filters object

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

The requested resource could not be found.

Common causes:

• Invalid API endpoint URL
• Incorrect URL path

422

Invalid scope

Invalid search scope provided.

Common causes:

• Scope parameter is not "refund"
• Invalid scope value

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/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "scope=refund" \
  -d "query=order refund" \
  -d "filters[status]=successful" \
  -d "filters[currency]=thb"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Search.execute({
  scope: 'refund',
  query: 'order refund',
  filters: {
    status: 'successful',
    currency: 'thb'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Search.execute(
    scope='refund',
    query='order refund',
    filters={
        'status': 'successful',
        'currency': 'thb'
    }
)

Node.js

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

const results = await omise.search.execute({
  scope: 'refund',
  query: 'order refund',
  filters: {
    status: 'successful',
    currency: 'thb'
  }
});

PHP

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

$results = OmiseSearch::execute([
    'scope' => 'refund',
    'query' => 'order refund',
    'filters' => [
        'status' => 'successful',
        'currency' => 'thb'
    ]
]);

Java

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

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

SearchResult<Refund> results = client.search()
    .scope("refund")
    .query("order refund")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Search.Execute(new SearchRequest
{
    Scope = "refund",
    Query = "order refund",
    Filters = new Dictionary<string, object>
    {
        { "status", "successful" },
        { "currency", "thb" }
    }
});

Go

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

results, _ := client.Search(&operations.SearchRefunds{
    Scope: "refund",
    Query: "order refund",
    Filters: map[string]interface{}{
        "status":   "successful",
        "currency": "thb",
    },
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Missing or invalid parameters	Check that scope is provided and parameters are valid
authentication_failure	Invalid API key	Verify your secret key is correct
invalid_scope	Invalid search scope	Ensure scope is set to "refund"

Search Filter Options

Filter	Type	Description
status	string	Refund status (pending, successful, failed)
currency	string	Currency code (thb, jpy, sgd, myr, usd, etc.)
amount	integer	Exact amount in smallest currency unit
voided	boolean	Whether refund was processed as a void (true/false)
created	object	Date range filter (e.g., {gte: '2025-01-01', lte: '2025-01-31'})

Refund Status Codes

Status	Description
pending	Refund being processed
successful	Refund completed successfully
failed	Refund failed (rare)

---

🔑API Credentials

▼

Try it out

Required - 1 fields

▼

scope(Required)

Recommended - 2 fields

▼

Additional - 3 fields

▼

Your IP: ...Loading...