Skip to main content

Get invoice info by ID

GET /api/merchant/invoices/{id}

URL params​

NameTypeDescription
idstringID invoice

Request-example​

curl --request GET \
--url https://{{domain}}/api/merchant/invoices/{{id}} \
--header 'X-Identity: {{api_key}}' \
--header 'X-Signature: {{sign}}' \

Response Structure​

The response is returned as an array of InvoiceDTO objects.

Response example​

{
 "id": "bafb24c9-9d8d-4d9d-b516-684d7ffd99db",
 "internalId": "00002",
 "userId": "test",
 "type": "in",
 "status": "new",
 "paymentMethod": null,
 "paymentOption": "TO_CARD",
 "paymentRequisites": null,
 "sum": {
   "amount": "1337.00",
   "currency": "RUB",
   "subunit": 2
 },
 "storeId": 1,
 "storeName": "Demo Test",
 "receivedSumFromTaker": null,
 "receivedSumFromMaker": null,
 "serviceFeeSum": null,
 "payoutSum": null,
 "createdAt": "2024-11-21T15:44:28+00:00",
 "expireAt": "2024-11-21T16:44:28+00:00",
 "updatedAt": "2024-11-21T15:44:28+00:00",
 "invoiceUrl": "http://pay.domain.com/invoice?id=bafb24c9-9d8d-4d9d-b516-684d7ffd99db",
 "deals": [
   {
     "id": "bafb24c9-9d8d-4d9d-b516-684d7ffd99db",
     "type": "in",
     "status": "transfer_waiting",
     "paymentMethod": "sberbank",
     "paymentOption": "TO_CARD",
     "requisites": {
       "requisites": "4444 4444 4444 4444",
       "holder": "test"
     },
     "canceledAt": "2024-11-21T15:59:30+00:00",
     "disputeAttachment": null,
     "disputeReason": null,
     "disputeReasonData": [],
     "payment": null,
     "rate": "101.42",
     "isActive": true,
     "qrCodeLink": "https://www.sberbank.com/sms/pbpn?requisiteNumber=4444444444444444",
     "disputeResult": null,
     "attachments": []
   }
 ]
}