Refunds

Retrieve a refund

Retrieves the details of a refund that has previously been created.

get/payment-intents/refunds/{refundId}

Request

Path parameters

refundIdstring nullable required

A unique identifier for the refund. It will be used to reference this refund in all operations. It is recommended to use a UUID.

Headers

versionstring date required

The API version with format yyyy-mm-dd. The current version is 2026-02-27.

Response

OK

paymentIntentIdstring nullable

The unique identifier of the payment intent.

refundIdstring nullable

A unique identifier for the refund. It will be used to reference this refund in all operations. It is recommended to use a UUID.

refundReasonstring nullable

The reason for the refund.

notesstring nullable

A description for the refund, if applicable.

Example response

{
  "paymentIntentId": "pi_sandbox_RBMHTJ4fIkmSppDILZVCGw",
  "refundId": "rfnd_127usj",
  "refundReason": "Demo refund",
  "notes": null
}

Changes

No recorded changes to this operation across all 1 revision of this API.