Skip to main content
GET
Retrieve a refund

Authorizations

Authorization
string
header
required

Secret key, kc_sk_test_... or kc_sk_live_.... Server-side only.

Path Parameters

id
string
required

Response

The refund.

id
string
required
Example:

"re_01JABCDEF"

object
string
required
Allowed value: "refund"
payment
string
required
amount
integer<int64>
required

Amount in the currency's minor unit.

Required range: x >= 0
currency
string
required

ISO 4217 currency code, uppercase.

Pattern: ^[A-Z]{3}$
Example:

"EUR"

status
enum<string>
required
Available options:
pending,
succeeded,
failed
reason
enum<string>
required
Available options:
requested_by_customer,
duplicate,
fraudulent,
amount_mismatch,
other
metadata
object
required

Up to 50 keys. Keys up to 40 characters, values up to 500 characters. Echoed back unchanged.

created_at
string<date-time>
required
failure_reason
string | null
updated_at
string<date-time>