Get invoice by id

JSON API v3

GET /api/v3/projects/{projectId}/invoices/{invoiceId}

Returns detailed invoice information including payment transactions.

v4 signature payload: {invoice_id}

Request parameters

Field	Type	Required	Description
`projectId`	integer (int32)	yes
`invoiceId`	string (uuid)	yes

Response example


{
  "data": {
    "price": {
      "amount": "100.00",
      "currency": "RUB",
      "vat_included": true
    },
    "status": "Created",
    "customer": {
      "type": "mobile_phone",
      "msisdn": "7960***0000"
    },
    "created_at": "2026-09-21T12:00:00Z",
    "invoice_id": "0d0f3c58-9b1e-4a77-9a0c-000000000001",
    "authorization": {
      "type": "SMS_PIN",
      "is_authorized": false
    },
    "payment_status": "NOT_PAID",
    "merchant_order_id": "ORDER-000000001",
    "billing_channel": "MC",
    "expires_at": "2026-09-21T12:00:00Z"
  },
  "success": true
}

Response codes

Code	Description
`200`	Invoice found
`400`	Validation or business request error
`401`	Authentication failed (missing/invalid signature or timestamp)
`403`	Project access denied or IP not whitelisted
`404`	Invoice not found
`500`	Unexpected platform error
`503`	Service temporarily unavailable

XML API v2.9

POST /API/XML/InvoiceManagementService.ashx

Returns detailed invoice information including payment transactions. XML request type: <GetInvoiceRequest>.

This method is used by Merchant to get status about a previously created invoice. It is possible to get status by using either InvoiceID or MerchantOrderID parameter in the request.

Customer. The customer is an element named after its type — MobilePhoneCustomer, BankCardCustomer or UndefinedBankCardCustomer. BillingDetails is serialized with an xsi:type attribute (namespace http://www.w3.org/2001/XMLSchema-instance): MobileBilling or CardBilling. The prefix is not stable: real responses carry an auto-generated alias (d3p1, d6p1 and so on), so rely on the namespace and the attribute value.

Sandbox simplification. The payment is a single part with no commission: PartnerProfit equals CustomerPrice, CustomerPriceTotalToPay is zero once paid. For phone-balance payments BillingDetails is omitted — the sandbox has no service number; card and SBP payments carry CardBilling with the payment method (cards or qrsbp).

HTTP Headers:

Callisto-Protocol-Version: 2
SignatureVersion: 3

Request parameters

Field	Type	Required	Description
`Callisto-Protocol-Version`	`2`	yes	Protocol version
`SignatureVersion`	integer (int32, default `1`)	—	Signature version number

Request body

Field	Type	Required	Description
`GetInvoiceRequest`	object	yes
`GetInvoiceRequest.ProjectID`	integer (int32)	yes	Project ID in the Platform system. Assigned during project setup.
`GetInvoiceRequest.InvoiceInfo`	object	—	Invoice reference by InvoiceID or MerchantOrderID. At least one must be provided.
`GetInvoiceRequest.InvoiceInfo.InvoiceID`	string (uuid)	—	Unique Invoice ID assigned by the Platform
`GetInvoiceRequest.InvoiceInfo.MerchantOrderID`	string	—	Order ID in Merchant’s system
`Header`	object	yes	Request header with authentication. Included in every API request.
`Header.Authentication`	object	yes	Request authentication data. All three fields are mandatory for every request.
`Header.Authentication.Login`	string	yes	Merchant Login assigned by the Platform
`Header.Authentication.NowUtc`	string	yes	Current UTC time in yyyyMMddHHmmss format. Must not differ from platform system time by more than 20 minutes.
`Header.Authentication.Signature`	string	yes	HMAC request signature. Calculated as: LOWERCASE(HMACSHA256(Password, Login + LOWERCASE(HMACSHA256(Password, NowUtc))))
`Header.RequestAttempt`	integer (int32)	—	Ordinal invoice request number (for idempotency). Starting from 0.
`Header.Gateway`	object	—	Platform service block in the request header. The sandbox does not read it: the block is ignored and affects neither the signature nor processing.
`Header.Gateway.Signature`	string	—
`Header.Gateway.ContractInfo`	object	—
`Header.Gateway.ContractInfo.DesiredExpirationTimeUtc`	string (date-time)	—

Request example


<?xml version="1.0" encoding="utf-8"?>
<Request>
  <Header>
    <Authentication>
      <Login>demo_login</Login>
      <NowUtc>20260921120000</NowUtc>
      <Signature>0000000000000000000000000000000000000000000000000000000000000000</Signature>
      <SignatureVersion>3</SignatureVersion>
    </Authentication>
  </Header>
  <GetInvoiceRequest>
          <ProjectID>1001</ProjectID>
          <ClientIP>127.0.0.1</ClientIP>
          <InvoiceInfo>
            <InvoiceID>0d0f3c58-9b1e-4a77-9a0c-000000000001</InvoiceID>
          </InvoiceInfo>
        </GetInvoiceRequest>
</Request>

Response example


<?xml version="1.0" encoding="utf-8"?>
<Response>
  <GetInvoiceResponse>
    <InvoiceInfo>
      <CustomerPrice amount="100.00" currency="RUB" includingVAT="true" />
      <CreatedTimeUtc>21.09.2026 12:00:00</CreatedTimeUtc>
      <ExpirationTimeUtc>2026-09-21T12:00:00Z</ExpirationTimeUtc>
      <InvoiceStatus>Processed</InvoiceStatus>
      <PaymentStatus>PAID</PaymentStatus>
      <AuthorizationType>SMS_PIN</AuthorizationType>
      <IsAuthorized>true</IsAuthorized>
      <InvoiceID>0d0f3c58-9b1e-4a77-9a0c-000000000001</InvoiceID>
      <MerchantOrderID>ORDER-000000001</MerchantOrderID>
    </InvoiceInfo>
    <ProjectID>1001</ProjectID>
    <MobilePhoneCustomer>
      <MSISDN>79600000000</MSISDN>
      <Country>ru</Country>
      <NetworkID>7</NetworkID>
      <OperatorID>22</OperatorID>
    </MobilePhoneCustomer>
    <PaymentTransactionsInfo>
      <PaymentTransaction>
        <TransactionID>0d0f3c58-9b1e-4a77-9a0c-000000000006</TransactionID>
        <PaymentPartNumber>1</PaymentPartNumber>
        <PaymentSequenceNumber>1</PaymentSequenceNumber>
        <PaymentStatus>SUCCESS</PaymentStatus>
        <PaymentResultCode>0</PaymentResultCode>
        <PaymentResultDescription>OK</PaymentResultDescription>
        <PaymentTimeUtc>21.09.2026 12:00:00</PaymentTimeUtc>
        <CustomerPrice amount="100.00" currency="RUB" includingVAT="true" />
        <PartnerProfit amount="100.00" currency="RUB" includingVAT="true" />
        <CustomerPriceTotalPaid amount="100.00" currency="RUB" includingVAT="true" />
        <CustomerPriceTotalToPay amount="0.00" currency="RUB" includingVAT="true" />
        <BillingInfo>
          <BillingChannel>MC</BillingChannel>
        </BillingInfo>
      </PaymentTransaction>
    </PaymentTransactionsInfo>
    <IsContentRequired>false</IsContentRequired>
  </GetInvoiceResponse>
  <ResultCode>0</ResultCode>
  <ResultDescription>OK</ResultDescription>
</Response>