Webhooks

Warning!

QI Tech webhooks should not be mapped in a restrictive manner. Additional fields may be included in the payloads of the webhooks returned by our APIs.

Webhook for Pending Payments

Webhook intended to update the status of payments that were pending (status 202) when making a boleto payment.

Webhook Request Body

Request Body: Payment executed

{
  "webhook_type": "baas.bill_payment.payment",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "payment_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
    "barcode":"00193967000009910000000003615574000000002417",
    "digitable_line":"00190000090361557400500000024174396700000991000",
    "payment_status": "executed",
    "payment_type":"bank_slip"
  }
}

Request Body: Payment reverted

{
  "webhook_type": "baas.bill_payment.payment",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "payment_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
    "barcode":"00193967000009910000000003615574000000002417",
    "digitable_line":"00190000090361557400500000024174396700000991000",
    "payment_status": "reverted",
    "payment_type":"bank_slip"
  }
}

Webhook Body Params

Field	Type	Description
webhook_type	string	An enumerator that defines the type of event being reported.
webhook_datetime	string	Date and time the webhook was sent.
request_control_key	uuid4	Unique identification key for the client's request.
payment_key *	uuid4	Unique payment identification key.
barcode *	string	Barcode.
digitable_line *	string	Digitable line.
payment_type *	enum	Payment type.
payment_status *	enum	Payment status.

Enumerators payment_type

Enumerator	Type	Description
bank_slip	string	Boleto
collection_slip	string	Collection invoice

Enumerators payment_status

Enumerator	Type	Description
executed	string	Executed
reverted	string	Reverted