Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Path Parameters

refundId
string<uuid>
required

The ID of a refund.

Maximum string length: 36
Example:

"4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45"

Query Parameters

accountId
string
required

The ID of the account to work with.

Example:

"F50091"

Response

OK

id
string<uuid>
required

The ID of a refund.

Maximum string length: 36
Example:

"4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45"

paymentId
string<uuid>
required

The payment being refunded.

Maximum string length: 36
Example:

"9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34"

status
enum<string>
required

AWAITING_AUTHORISATION until the merchant authorises the refund at their bank via authorisationUrl.

Available options:
AWAITING_AUTHORISATION,
PENDING,
COMPLETED,
FAILED,
CANCELLED
Example:

"AWAITING_AUTHORISATION"

amount
object
required

A money value: a decimal amount as a string plus an ISO-4217 currency code.

reason
string | null
required

Why the refund was made.

Maximum string length: 140
Example:

"Item returned"

authorisationUrl
string<uri> | null
required

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.

Maximum string length: 2048
Example:

"https://pay.roqqett.com/ob/refund?sessionId=4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45&paymentToken=example-token&organisationId=0b6f3c1e-8a2d-4f5b-9e7c-3d1a2b4c5e6f"

createdAt
string<date-time>
required

The date the Resource was initially created. ISO 8601 format without milliseconds.

completedAt
string<date-time> | null
required

When the refund reached a terminal status.

Example:

"2026-10-02T12:10:00Z"