GET /payments/refund/{refundId}

Get details of a single refund by refundId

Request

  • Base URL
    https://api.xpaycheckout.com
  • URL
    https://api.xpaycheckout.com/payments/refund/{refundId}
  • Auth
    HTTP basic

Path parameters

refundIdstring required

Unique identifier of the refund

Response

Successful response with refund details

refundIdstring required

Unique identifier of the refund

intentIdstring required

Unique identifier of the payment intent

amountinteger required

The amount in lowest count unit. e.g.: For USD 1, amount is 100 representing 100 cents (The minimum amount should be greater than 1 USD)

currencystring required

Three letter abbreviation of the currency. Refer supported currencies

refundedAtinteger required

Epoch timestamp in milliseconds of when the refund was processed

refundReferenceIdstring

Your identifier for the refund

Example response

{
  "refundId": "rf_fooBOwYsaK50AEaJ",
  "intentId": "in_fooBOwYsaK50AEfK",
  "amount": 2000,
  "currency": "USD",
  "refundedAt": 1727340330123,
  "refundReferenceId": "re123"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.