Skip to content

Transaction Registry

This method is used to generate a bank statement in PDF format and send it by email.

The following request headers must be passed in all requests:

Name Type Required Description
X-Api-Key string Yes Unique shop identifier
X-Signature string Yes Request signature

Generating the signature uses secret_key — the secret key found in the merchant's shop settings.

Request to generate a statement and send it by email

Method: POST

  • Production: https://api.baas.kvell.group/v1/registries/transactions/pdf
  • Stage: https://api.baas.stage.kvell.group/v1/registries/transactions/pdf

Request parameters (JSON)

Name
 Data type Required Description
email string Yes Email address to send the statement to
transactions array[string] Conditional List of merchant transactions
orders array[string] Conditional List of transaction IDs in the Kvell system

One of the transactions or orders parameters must be passed.

{
  "email": "example@kvell.ru",
  "transactions": [
    "96bc28ed-37f2-4c5b-95a4-93209b4b2764",
    "ad12a3e3-7e7b-45d9-8045-f4429ac1ed92",
    "e71a9a4c-6d5b-46fa-8b68-3be6121b24c0"
  ]
}

Generating the signature

The X-Signature signature is generated by concatenating X-Api-Key, json <request body>, and secret_key. It is computed as sha256 of the resulting string:

sha256({x-api-key}{json <request body>}{secret_key})

Response

    Success, no content.

{
  "errors": [
    {
        "message": "Заказы не найдены",
        "code": 4
    }
  ]
}