Invoice retrieval API

Retrieves the invoice details.

get

Retrieves the invoice details.

This endpoint retrieves the invoice details for the specified invoice ID or order ID for specific merchant.

Returns the invoice details.

Invoice fields

• id (string): Unique invoice identifier.

• amount (number): The amount to deposit.

• baseCurrency (string): The base currency of the deposit.

• paymentCurrency (string | null): The payment currency of the deposit.

• customerId (string): The customer ID in your system.

• orderId (string | null): The associated order ID in your system.

• status (string): The current status of the invoice. Possible values: created, active, processing, canceled.

• createdAt (string): The date and time when the invoice was created, in ISO 8601 format.

• paymentUrl (string): The URL to which the customer will be redirected after completing checkout.

• type (string): The type of the invoice. Possible values: deposit.

• accountId (string): The merchant's account ID.

• strategy (string): The invoice strategy. Possible values: floating, fixed.

• transactions (array): List of transactions associated with this invoice, ordered by creation date (newest first). Each transaction contains: id, createdAt, type, status.

Authorizations

api_key

x-api-keystringRequired

Path parameters

invoiceIdstringRequired

• The invoice identifier or order ID.

Responses

200

OK

application/json

The AppSuccessResponse object contains general information about the success execution.

successbooleanRequiredDefault: true

400

Bad request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal server error

application/json

get

/invoices/{invoiceId}

HTTPcURLJavaScriptPython

GET /api/v2/invoices/{invoiceId} HTTP/1.1
Host: api.xgateway.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "data": {
    "amount": "100.00",
    "baseCurrency": "EUR",
    "createdAt": "2026-01-28T14:35:00.000Z",
    "customerId": "3f0a9b6d-8c2b-4f21-9f6b-7a8e2d5c4b1f",
    "id": "5d7c2f4a-1b6e-4e3a-8c9f-2a3b4d5e6f7a",
    "paymentUrl": "https://checkout.xgateway.tech/5d7c2f4a-1b6e-4e3a-8c9f-2a3b4d5e6f7a",
    "status": "created",
    "strategy": "floating",
    "type": "deposit",
    "accountId": "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
    "orderId": "f1e2d3c4-b5a6-7f8e-9d0c-1b2a3e4f5d6c",
    "paymentCurrency": "EUR",
    "transactions": [
      {
        "id": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
        "createdAt": "2026-01-28T14:40:00.000Z",
        "type": "deposit",
        "status": "confirmed"
      }
    ]
  },
  "success": true
}