Retrieve a charge refund

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

Retrieve a specific refund for a charge. Returns complete information about the refund including its status, amount, and transaction details.

---

Request Parameters

Required - 2 fieldsRequired Parameters

▼

`id`STRING(required)

The charge ID that the refund belongs to. Must be a valid charge ID from your account.

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must start with chrg_, Test charges: chrg_test_, Live charges: chrg_live_

`refund_id`STRING(required)

The refund ID to retrieve. Must be a valid refund ID associated with the specified charge.

Example:"rfnd_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must start with rfnd_, Test refunds: rfnd_test_, Live refunds: rfnd_live_

---

Responses

200

Successful retrieval

Returns complete refund object with all fields.

Response includes:

• id - Refund ID
• status - pending, closed, or failed
• amount - Refund amount in smallest currency unit
• currency - Currency code
• charge - Associated charge ID
• transaction - Associated transaction ID
• created_at - Refund creation timestamp
• metadata - Custom metadata (if set)

400

Bad request

Invalid parameters provided.

Common causes:

• Invalid charge ID format
• Invalid refund ID format

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

Charge or refund ID does not exist.

Common causes:

• Incorrect charge ID
• Incorrect refund ID
• Refund does not belong to the specified charge
• Resource from different account
• Using test key for live resource (or vice versa)

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'

charge = Omise::Charge.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t')
refund = charge.refunds.retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = omise.Charge.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t')
refund = charge.refunds.retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const refund = await omise.charges.retrieveRefund(
  'chrg_test_5xuy4w91xqz7d1w9u0t',
  'rfnd_test_5xuy4w91xqz7d1w9u0t'
);

PHP

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

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');
$refund = $charge->refunds()->retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t');

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var refund = await client.Charges.GetRefund(
    "chrg_test_5xuy4w91xqz7d1w9u0t",
    "rfnd_test_5xuy4w91xqz7d1w9u0t"
);

Go

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

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

---

Error and result codes

Refund Status Values

Status	Description	Next Steps
pending	Refund is being processed	Wait for completion
closed	Refund completed successfully	Funds returned to customer
failed	Refund failed	Check failure reason

Refund Object Fields

Field	Type	Description
id	string	Unique refund identifier
object	string	Always "refund"
livemode	boolean	Whether this is a live mode refund
location	string	API path to this refund
amount	integer	Refund amount in smallest currency unit
currency	string	Three-letter ISO currency code
charge	string	ID of the charge that was refunded
transaction	string	ID of the associated transaction
status	string	Current refund status
created_at	string	ISO 8601 timestamp of creation
metadata	object	Custom key-value pairs

---

🔑API Credentials

▼

Try it out

Required - 2 fields

▼

id(Required)

refund_id(Required)

Your IP: ...Loading...