PAYMENT moves money from the payer; REFUND moves it back.
Available options:
PAYMENT,
REFUND
Example:
"PAYMENT"
status
enum<string>
required
PENDING from initiation until the bank confirms the outcome.
Available options:
PENDING,
COMPLETED,
FAILED,
CANCELLED
Example:
"COMPLETED"
amount
object
required
A money value: a decimal amount as a string plus an ISO-4217 currency code.
Show child attributes
checkoutType
enum<string> | null
required
Whether the money was taken by a SHOPPING or a TOP_UP checkout session. A REFUND takes the type of the payment it refunds. null when the record has no checkout session.
Available options:
SHOPPING,
TOP_UP
Example:
"SHOPPING"
checkoutSessionId
string<uuid> | null
required
The ID of a checkout session: one payment journey.
Maximum string length: 36
Example:
"0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93"
refundedPaymentId
string<uuid> | null
required
The payment a REFUND returns money from. Always null for a PAYMENT.
Maximum string length: 36
Example:
"9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34"
refundId
string<uuid> | null
required
The ID of the refund a REFUND record belongs to, for GET /v2/roqqett/refunds/{refundId}. Always null for a PAYMENT.
Maximum string length: 36
Example:
"4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45"
orderId
string<uuid> | null
required
The ID of an order: the record of a completed shopping checkout session.
Maximum string length: 36
Example:
"7e2b9d4a-6c1f-4a5e-8b3d-2f9c0a1e6b78"
merchantReference
string | null
required
The merchant's own reference for this checkout session, such as its order or basket ID. Shown to the merchant, never to the payer's bank.
Required string length: 1 - 128
Example:
"ORDER-10421"
payer
object
required
Show child attributes
isRefundable
boolean
required
Whether a refund can still be created for this payment.
initiatedAt
string<date-time>
required
When the payer authorised the payment.
Example:
"2026-10-02T12:00:00Z"
completedAt
string<date-time> | null
required
When the payment reached a terminal status.
Example:
"2026-10-02T12:00:05Z"
createdAt
string<date-time>
required
The date the Resource was initially created. ISO 8601 format without milliseconds.
Was this page helpful?
⌘I
cURL
curl --request GET \ --url 'https://api.equalsmoney.com/v2/roqqett/payments/{paymentId}?accountId={{accountId}}' \ --header 'Authorization: <api-key>'