Skip to content

Payout Certificate

Methods for obtaining a certificate of a successful transaction. Only available when working with Alfa-Bank and T-Bank. A transaction certificate from the bank can only be obtained on the following day.

Sending to email

Method for sending a PDF file with information about the completed transaction to a specified email address.

URL

Method: POST

  • Production: https://api.pay.kvell.group/v1/orders/{transaction}/operation-certificate
  • Stage: https://api.pay.stage.kvell.group/v1/orders/{transaction}/operation-certificate

Request parameters

Name Data type Required Description
transaction string Yes Unique transaction number on the merchant's side

Request body parameters

Name Data type Required Description
email string Yes Email address the report will be sent to.

Request example

{
  "email": "user@user.com"
}

Request headers

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

The X-Signature signature is generated by concatenating X-Api-Key, transaction, email, and secret_key. sha256 is computed from the resulting string:

sha256({x-api-key}{transaction}{email}{secret_key})

where secret_key is the secret key found in the merchant's shop settings;

Response

    Success, no content.

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Method for creating a task to obtain a PDF file with information about the completed transaction via a link.

URL

Method: POST

  • Production: https://api.pay.kvell.group/v1/orders/{transaction}/operation-certificate/view
  • Stage: https://api.pay.stage.kvell.group/v1/orders/{transaction}/operation-certificate/view

Request parameters

Name Data type Required Description
transaction string Yes Unique transaction number on the merchant's side

Request headers

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

The X-Signature signature is generated by concatenating X-Api-Key, transaction, and secret_key. sha256 is computed from the resulting string:

sha256({x-api-key}{transaction}{secret_key})

Response

{
  "task_id": "9d711e68-3b94-4a40-9b20-b7a659ef252d"
}

Getting the task status and result

It's recommended to poll once every 5 minutes.

URL

Method: GET

  • Production: https://api.pay.kvell.group/v1/orders/{transaction}/operation-certificate/view
  • Stage: https://api.pay.stage.kvell.group/v1/orders/{transaction}/operation-certificate/view

Request headers

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

The X-Signature signature is generated by concatenating X-Api-Key, transaction, and secret_key. sha256 is computed from the resulting string:

sha256({x-api-key}{transaction}{task_id}{secret_key})

Query string parameters

Name Data type Required Description
task_id string Yes Task ID from the response to the task creation request

Response

Name Data type Description
status string Task status. Possible statuses: in_progress, done, error
order_id string Order ID
url string Link to the certificate. null if the link isn't ready yet
error_message string Error message, if the status is error 
{
  "status": "in_progress",
  "order_id": "string",
  "url": "string",
  "error_message": "string"
}