Skip to content

Invoice Information

Method for retrieving invoice data by its GUID.

URL

Method: GET

  • Production: https://api.pay.kvell.group/v1/invoices/{invoice_guid}
  • Stage: https://api.pay.stage.kvell.group/v1/invoices/{invoice_guid}

Request parameters

Name Data type Required Description
invoice_guid string Yes Invoice GUID

Request headers

Name Data type Required Description
X-Api-Key string Yes Unique shop identifier

Response example

{
  "id": 49,
  "invoice_guid": "7553aba1-a9c6-42de-94c6-99622babdefa",
  "api_key": "3a8c82d6-d2c6-4165-9a6b-ab3f14d965ae",
  "status": "new",
  "amount": 10000,
  "created_at": "2022-10-04T07:47:48.788127+00:00",
  "expired_at": "2022-10-05T10:10:00+00:00",
  "invoice_number": "29eae412-1027-4720-b0d4-3413ce96257b",
  "delivery_type": "link",
  "delivery_value": {
    "email": "invoice@test.com",
    "phone": "123456789"
  },
  "fiscal_data": {},
  "extra_data": {},
  "description": "Invoice test 1",
  "url": "https://pay.kvell.group/checkout/invoice/7553aba1-a9c6-42de-94c6-99622babdefa",
  "split_data": [
    {
      "service_id": "343-23",
      "amount": 1000,  // In kopecks
      "description": "",
      "metadata": {}
    }
  ]
}

{
  "errors": [
    {
      "code": 20099,
      "message": {
        "message": "Invoice not found"
      }
    }
  ]
}

Response parameters

Name Data type Description
id string Payment ID in the system
invoice_guid string Invoice GUID
api_key string Unique shop identifier
status string Transaction status
amount integer Amount in kopecks
created_at string Invoice creation time
expired_at string Invoice expiration date
invoice_number string Unique invoice number
delivery_type string Invoice delivery method
delivery_value json Data for issuing the invoice
∟phone string Phone number for issuing the invoice
∟email string Email for issuing the invoice
fiscal_data string Fiscal data
split_data string Transaction split data
extra_data string Additional data
description string Invoice description
url string Invoice link