List all refunds

GEThttps://api.omise.co/refunds

Retrieve a paginated list of all refunds across all charges. Returns refunds sorted by creation date with filtering capabilities.

---

Request Parameters

Recommended - 3 fieldsRecommended Parameters

▼

`limit`INTEGER(optional)

Number of refunds to return per page.

Example:20

Constraints:Minimum: 1, Maximum: 100

Default:20

`offset`INTEGER(optional)

Number of refunds to skip for pagination. Use with limit to navigate through pages.

Example:0

Default:0

`order`STRING(optional)

Sort order by creation date.

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

Additional - 2 fieldsAdditional Parameters

▼

---

Responses

200

Successful list retrieval

Returns a list object containing refund data array and pagination metadata.

List response includes:

• object - The value "list"
• data - Array of refund objects
• total - Total number of refunds matching filters
• limit - Number of items per page
• offset - Current pagination offset
• order - Sort order applied
• from / to - Date range applied

Each refund object includes:

• object - The value "refund"
• id - Refund identifier (rfnd_*)
• livemode - Live or test mode
• location - API path to the refund object
• acquirer_reference_number - Reference number sent to card networks
• amount - Refund amount in smallest currency unit
• approval_code - Reference number for approved transactions
• capture - Capture reference
• charge - Associated charge ID (expandable)
• currency - Three-letter ISO 4217 currency code
• funding_amount - Amount in settlement currency
• funding_currency - Settlement currency code
• merchant_name - Sub-merchant name (Payfac only)
• merchant_uid - Sub-merchant ID (Payfac only)
• metadata - Custom metadata attached to refund
• status - Current refund status (pending, successful, failed)
• terminal - Original point of sale location
• transaction - Associated transaction ID (expandable)
• voided - Whether refund was processed as a void
• created_at - Refund creation timestamp (ISO 8601)

400

Bad request

Invalid parameters provided.

Common causes:

• Invalid date format (must be ISO 8601)
• Limit out of range (must be 1-100)
• Invalid 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

404

Not found

The requested resource could not be found.

Common causes:

• Invalid API endpoint URL
• Incorrect URL path

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/refunds?limit=20&offset=0" \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

refunds = Omise::Refund.list(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

refunds = omise.Refund.list(limit=20, offset=0)

Node.js

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

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

PHP

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

$refunds = OmiseRefund::retrieve(array(
    'limit' => 20,
    'offset' => 0
));

Java

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

ScopedList<Refund> refunds = client.refunds().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var refunds = await client.Refunds.GetList(new ListOptions {
    Limit = 20,
    Offset = 0
});

Go

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

refunds, _ := client.ListRefunds(&operations.ListRefunds{
    List: operations.List{
        Limit:  20,
        Offset: 0,
    },
})

---

Error and result codes

Common Usage Patterns

Pattern	Description	Example
Basic pagination	Fetch pages sequentially	limit=20&offset=0, then offset=20, etc.
Date range filter	Filter by creation date	from=2025-01-01T00:00:00Z&to=2025-01-31T23:59:59Z
Recent first	Newest refunds first	order=reverse_chronological

Pagination Calculation

Field	Calculation	Use
Next page	offset + limit	Get next set of results
Previous page	offset - limit (min 0)	Go back to previous page
Has more	offset + limit < total	Check if more pages exist
Page number	(offset / limit) + 1	Current page number

Refund Status Codes

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

---

🔑API Credentials

▼

Try it out

Recommended - 3 fields

▼

Additional - 2 fields

▼

Your IP: ...Loading...