logo
Merchant Invoices APIGet a single merchant invoice by order_id or external_id

Get a single merchant invoice by order_id or external_id

Returns a single invoice (and the linked deal, if any) belonging to the authenticated merchant.

invoice_ref accepts either:

  • our internal order_id (UUID assigned by the platform), or
  • the merchant's own external_id (whatever the merchant supplied at invoice creation).

Lookup is scoped to the authenticated merchant, so an external_id from another merchant cannot be retrieved. order_id is tried first; if no match is found, external_id is tried next.

Returns 404 if neither lookup matches.

curl -X GET "https://api.example.com/v1/api/v1/invoices/example_string" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "successful": true,
  "data": {
    "invoice_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "external_id": "order-2026-0001",
    "customer_id": "user_12345",
    "purpose": "example_string",
    "amount": "1500.00",
    "currency": "UAH",
    "status": "example_string",
    "callback_url": "example_string",
    "success_url": "example_string",
    "fail_url": "example_string",
    "payment_link": "example_string",
    "created_at": "example_string",
    "expires_at": "example_string",
    "finished_at": "example_string",
    "method_selected": true,
    "deal": {
      "deal_id": "8f1b2c3d-4e5f-6789-90ab-cdef12345678",
      "status": "example_string",
      "sub_status": "example_string",
      "payment_method_code": "monobank",
      "payment_method_name": "Monobank UA",
      "amount_fiat": "example_string",
      "conversion_rate": "example_string",
      "merchant_usdt": "example_string",
      "expires_at": "example_string",
      "finished_at": "example_string",
      "mark_paid_at": "example_string"
    }
  }
}
GET
/api/v1/invoices/{invoice_ref}
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Merchant API Key.

Merchant API Key.
path
invoice_refstring
Required

Invoice identifier — either our order_id (UUID) or the merchant's external_id

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Merchant API Key.

Path Parameters

invoice_refstring
Required

Invoice identifier — either our order_id (UUID) or the merchant's external_id

Responses

successfulboolean

Whether the request was successful

dataobject
Required

Full invoice info as exposed via merchant external API.