CollectPaymentsManage Payments

Retrieve a Refund

Retrieves the current state of a refund. Use this to poll for completion after creating a refund, or to look up a refund’s status at any later time. Alternatively, subscribe to the refund.succeeded and refund.failed webhook events to be notified of state transitions.

Path parameters

transactionIdstringRequiredformat: "uuid"
Identifier of the refund. UUID v7.

Response

Refund retrieved successfully.
statusenum

Current status of the refund. Newly created refunds always start in PENDING and transition to a terminal state asynchronously. Retrieve the refund or listen for the refund.succeeded / refund.failed webhook events to observe the transition.

Allowed values:
transactionIdstringformat: "uuid"
Unique identifier of the refund. UUID v7.
messagestring

Human-readable status message.

sessionIdstringformat: "uuid"
Identifier of the checkout session the refund was issued against. UUID v7.
originalTransactionIdstringformat: "uuid"

Identifier of the original transaction that was refunded. Returned even when the request omitted originalTransactionId, so the caller knows which transaction on the session was selected. UUID v7.

refundValueobject

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error