{
"payments": [
{
"id": "<string>",
"amount_total": 123,
"currency": "<string>",
"payment_status": "<string>",
"created": 123,
"expires_at": 123,
"url": "<string>",
"line_items": [
{}
],
"tax_amount": 123,
"shipping_amount": 123,
"exchange_rate": "<string>",
"target_currency": "<string>",
"target_amount_total": 123,
"rate_locked_at": 123,
"subscription_id": "<string>",
"invoice_id": "<string>"
}
],
"total": 123,
"page": 123,
"page_size": 123
}QR Pay API
List QR Pay payments
Return a paginated list of all payments for a QR Pay session.
GET
/
api
/
v1
/
customer-deposits
/
{deposit_session_id}
/
payments
{
"payments": [
{
"id": "<string>",
"amount_total": 123,
"currency": "<string>",
"payment_status": "<string>",
"created": 123,
"expires_at": 123,
"url": "<string>",
"line_items": [
{}
],
"tax_amount": 123,
"shipping_amount": 123,
"exchange_rate": "<string>",
"target_currency": "<string>",
"target_amount_total": 123,
"rate_locked_at": 123,
"subscription_id": "<string>",
"invoice_id": "<string>"
}
],
"total": 123,
"page": 123,
"page_size": 123
}Returns all payments for the specified QR Pay session in descending creation-time order. The list includes every payment status, and historical payments remain available after the QR Pay session is closed or expired.
Each item in
payments uses the same fields as the Retrieve payment API. Empty optional fields are omitted, and id is the payment session ID.
Authentication and headers
Use a Bearer API Key and the three signing headers below. Sign{timestamp}.{nonce}.{requestBody} with HMAC-SHA256 and encode the result as lowercase hex. For GET requests, requestBody is an empty string.
string
required
Bearer API Key, for example
Bearer sk_live_xxx.string
required
Unix timestamp in seconds, within 5 minutes of server time.
string
required
Random replay-protection string, 16–64 characters. Use a new nonce for each request.
string
required
Lowercase hexadecimal HMAC-SHA256 signature calculated with the merchant API Secret.
Path parameter
string
required
QR Pay session ID.
Query parameters
integer
default:1
Page number starting at 1. Empty, non-integer, repeated, or out-of-range values return 400.
integer
default:20
Records per page, from 1 to 100. Empty, non-integer, repeated, or out-of-range values return 400.
Success response
HTTP200 returns the requested page and total record count. An empty page returns payments: [] while total retains the actual count.
object[]
required
Payments on the current page.
Show Payment fields
Show Payment fields
string
required
Payment session ID.
integer
required
Original order total in the smallest unit of the original order currency.
string
required
Lowercase original-order currency code.
string
required
Allowed values:
pending, processing, paid, failed, expired, canceled, frozen.integer
required
Creation time as Unix seconds.
integer
required
Expiration time as Unix seconds.
string
Payment page URL.
object[]
Line items, returned only when present.
integer
Tax amount in the smallest unit of the original order currency.
integer
Shipping amount in the smallest unit of the original order currency.
string
Exchange-rate value, returned only when conversion applies.
string
Target payment currency.
integer
Target payment amount in the smallest unit of the target currency.
integer
Exchange-rate lock time as Unix seconds.
string
Related subscription ID, returned only when present.
string
Related invoice ID, returned only when present.
integer
required
Total number of payments for this QR Pay session, independent of the requested page.
integer
required
Current page number.
integer
required
Requested number of records per page.
{
"payments": [
{
"id": "20261113110100101082920000542002",
"amount_total": 1,
"currency": "usdc",
"payment_status": "paid",
"created": 1794544360,
"expires_at": 1794544420,
"url": "https://checkout.example/#/pay/20261113110100101082920000542002/example-token",
"target_currency": "USDC",
"target_amount_total": 1
}
],
"total": 1,
"page": 1,
"page_size": 20
}
Error responses
400: Invalid pagination parameters.401: Authentication failed.404 resource_not_found: The QR Pay session does not exist or belongs to another merchant.500: Internal service error.
Last modified on November 13, 2026
Was this page helpful?