logo
Merchant Invoices APIList merchant invoices (paginated)

List merchant invoices (paginated)

Returns a paginated list of invoices belonging to the authenticated merchant, optionally filtered by status / currency. Each item also includes deal-level info if the customer has already picked a payment method.

curl -X GET "https://api.example.com/v1/api/v1/invoices?page=25&per_page=25&status=pending&currency=example_string&order=desc" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "data": [
    {
      "amount": "1500.00",
      "callback_url": "https://yoursite.com/webhooks/payment",
      "created_at": "2026-04-26T12:00:00+00:00",
      "currency": "UAH",
      "customer_id": "user_12345",
      "deal": {
        "amount_fiat": "1537.50",
        "conversion_rate": "41.50",
        "deal_id": "8f1b2c3d-4e5f-6789-90ab-cdef12345678",
        "expires_at": "2026-04-26T12:30:00+00:00",
        "finished_at": "2026-04-26T12:08:31+00:00",
        "mark_paid_at": "2026-04-26T12:07:55+00:00",
        "merchant_usdt": "35.42",
        "payment_method_code": "monobank",
        "payment_method_name": "Monobank UA",
        "status": "completed"
      },
      "expires_at": "2026-04-26T12:20:00+00:00",
      "external_id": "order-2026-0001",
      "fail_url": "https://yoursite.com/payment/failed",
      "finished_at": "2026-04-26T12:08:31+00:00",
      "invoice_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "method_selected": true,
      "payment_link": "https://pay.app.com/a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "purpose": "Payment for Premium subscription",
      "status": "success",
      "success_url": "https://yoursite.com/payment/success"
    }
  ],
  "page": 1,
  "per_page": 20,
  "successful": true,
  "total": 42,
  "total_pages": 3
}
GET
/api/v1/invoices
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Merchant API Key.

Merchant API Key.
query
pageinteger

Page number (1-based)

Min: 1
query
per_pageinteger

Items per page (max 500)

Min: 1 • Max: 500
query
statusstring

Filter by invoice status: pending / success / fail / expired / canceled

query
currencystring

Filter by currency code (case-insensitive ISO 4217)

query
orderstring

Sort order by created_at

Options: desc, asc
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Merchant API Key.

Query Parameters

pageinteger

Page number (1-based)

per_pageinteger

Items per page (max 500)

statusstring

Filter by invoice status: pending / success / fail / expired / canceled

currencystring

Filter by currency code (case-insensitive ISO 4217)

orderstring

Sort order by created_at

Allowed values:descasc

Responses

successfulboolean

Whether the request was successful

pageinteger
Required

Current page number

per_pageinteger
Required

Items per page

totalinteger
Required

Total invoices matching the filter

total_pagesinteger
Required

Total pages

dataarray
Required