Refund a payment
Starts a refund of a completed payment. The merchant authorises it at their bank: open authorisationUrl in a new window, then poll the refund. authorisationUrl is returned only in this response. Returns 409 if the payment is not refundable or the amount exceeds what remains, and 404 if the payment is not on the account.
Authorizations
Path Parameters
The ID of a Roqqett payment or refund record.
36"9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34"
Query Parameters
The ID of the account to work with.
"F50091"
Body
Body
Response
Created
The ID of a refund.
36"4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45"
The payment being refunded.
36"9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34"
AWAITING_AUTHORISATION until the merchant authorises the refund at their bank via authorisationUrl.
AWAITING_AUTHORISATION, PENDING, COMPLETED, FAILED, CANCELLED "AWAITING_AUTHORISATION"
A money value: a decimal amount as a string plus an ISO-4217 currency code.
Why the refund was made.
140"Item returned"
The page where the merchant authorises the refund at their bank: open it in a new window, then poll the refund. It carries a short-lived token, so it is returned only when the refund is created; retrieving a refund always returns null.
2048"https://pay.roqqett.com/ob/refund?sessionId=4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45&paymentToken=example-token&organisationId=0b6f3c1e-8a2d-4f5b-9e7c-3d1a2b4c5e6f"
The date the Resource was initially created. ISO 8601 format without milliseconds.
When the refund reached a terminal status.
"2026-10-02T12:10:00Z"