Retrieve Refund

Retrieve the details of an existing refund.

GEThttps://api.uprails.com/refunds/:refund_id

Retrieves a refund by its ID. Returns the refund object with current status and all associated details.

Path Parameters

Parameter	Type	Description
`refund_id`	string	Required. The ID of the refund to retrieve.

Request Example

curl https://api.uprails.com/refunds/ref_1234567890abcdef \
  -H "api-key: snd_YOUR_API_KEY"

Response

200OK

{
  "refund_id": "ref_1234567890abcdef",
  "payment_id": "pay_abcdef1234567890",
  "merchant_id": "mer_xyz789",
  "status": "succeeded",
  "amount": 500,
  "currency": "USD",
  "reason": "requested_by_customer",
  "metadata": {
    "order_id": "12345"
  },
  "created": "2024-01-15T14:30:00Z",
  "updated": "2024-01-15T14:30:05Z"
}

Response Fields

Field	Type	Description
`refund_id`	string	Unique identifier for the refund
`payment_id`	string	ID of the payment that was refunded
`status`	string	Current status of the refund
`amount`	integer	Amount refunded in smallest currency unit
`currency`	string	Three-letter ISO currency code
`reason`	string	Reason for the refund
`created`	string	Timestamp when the refund was created
`updated`	string	Timestamp when the refund was last updated