Retrieve a Refund

GEThttps://api.omise.co/charges/:charge_id/refunds/:refund_id

Retrieve detailed information about a specific refund including its status, amount, and associated transaction.

---

Request Parameters

Required - 2 fieldsRequired Parameters

▼

`charge_id`STRING(required)

Charge ID that was refunded (path parameter).

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

`refund_id`STRING(required)

Refund ID to retrieve (path parameter). Format: rfnd_test_ or rfnd_live_ followed by alphanumeric string.

Example:"rfnd_test_5xuy4w91xqz7d1w9u0t"

---

Responses

200

Successful retrieval

Returns the refund object with all details including status, amount, and timestamps.

Response 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)

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

Refund or charge not found.

Common causes:

• Incorrect refund ID
• Incorrect charge ID
• Refund belongs to different charge
• Refund or charge belongs to different account
• ID typo or formatting error

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/charges/chrg_test_5xuy4w91xqz7d1w9u0t/refunds/rfnd_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

refund = Omise::Refund.retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t', {
  charge: 'chrg_test_5xuy4w91xqz7d1w9u0t'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

refund = omise.Refund.retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t',
    charge='chrg_test_5xuy4w91xqz7d1w9u0t'
)

Node.js

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

const refund = await omise.refunds.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t', 'rfnd_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$refund = OmiseRefund::retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t', [
    'charge' => 'chrg_test_5xuy4w91xqz7d1w9u0t'
]);

Java

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

Refund refund = client.refunds().get("chrg_test_5xuy4w91xqz7d1w9u0t", "rfnd_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var refund = await client.Refunds.Get("chrg_test_5xuy4w91xqz7d1w9u0t", "rfnd_test_5xuy4w91xqz7d1w9u0t");

Go

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

refund, _ := client.GetRefund("chrg_test_5xuy4w91xqz7d1w9u0t", "rfnd_test_5xuy4w91xqz7d1w9u0t")

---

Error and result codes

Common Error Codes

Code	Description	Resolution
authentication_failure	Invalid API key	Verify your secret key is correct
not_found	Refund or charge not found	Check IDs are correct
invalid_refund_id	Refund ID format invalid	Use valid rfnd_ format

Refund Status Codes

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

---

🔑API Credentials

▼

Try it out

Required - 2 fields

▼

charge_id(Required)

refund_id(Required)

Your IP: ...Loading...