Payment Instrument Entry Webhooks
Warning!
QI Tech webhooks should not be mapped restrictively. Additional fields may be included in the webhook payloads returned by our APIs.
Webhook Resending
You can query and resend webhooks by following the detailed instructions in the documentation: Webhook Resending.
Introduction
After creating a payment instrument entry (payment_instrument_entry) within our system, webhooks will be sent with the following statuses:
| Enumerator | Translation | Description |
|---|---|---|
| processing_conclusion | processing completion | Payment instrument entry in completion processing |
| processing_cancellation | processing cancellation | Payment instrument entry in cancellation processing |
| concluded | concluded | Payment instrument entry concluded |
| canceled | canceled | Payment instrument entry was canceled |
Information
The timeout for our webhook responses is 10 seconds.
Examples
Creation confirmation
Webhook Body
{
"webhook_type": "baas.invoice.payment_instrument_entry",
"webhook_datetime": "2024-08-13T21:35:55.679Z",
"data": {
"payment_instrument_key": "ecf87b4b-fa6e-49c0-a7f0-f2cad6b42d79",
"payment_instrument_entry_key": "fd86d9b1-2a5e-4e03-9a59-a043c7632c97",
"payment_instrument_entry_amount": 150.00,
"payment_instrument_entry_type": "purchase",
"payment_instrument_entry_status": "concluded"
}
}
Cancellation confirmation
Webhook Body
{
"webhook_type": "baas.invoice.payment_instrument_entry",
"webhook_datetime": "2024-08-13T21:35:55.679Z",
"data": {
"payment_instrument_key": "ecf87b4b-fa6e-49c0-a7f0-f2cad6b42d79",
"payment_instrument_entry_key": "fd86d9b1-2a5e-4e03-9a59-a043c7632c97",
"payment_instrument_entry_amount": 150.00,
"payment_instrument_entry_type": "purchase",
"payment_instrument_entry_status": "canceled"
}
}
Processing activation
Webhook Body
{
"webhook_type": "baas.invoice.payment_instrument_entry",
"webhook_datetime": "2024-08-13T21:35:55.679Z",
"data": {
"payment_instrument_key": "ecf87b4b-fa6e-49c0-a7f0-f2cad6b42d79",
"payment_instrument_entry_key": "fd86d9b1-2a5e-4e03-9a59-a043c7632c97",
"payment_instrument_entry_amount": 150.00,
"payment_instrument_entry_type": "purchase",
"payment_instrument_entry_status": "processing_conclusion"
}
}
Processing cancellation
Webhook Body
{
"webhook_type": "baas.invoice.payment_instrument_entry",
"webhook_datetime": "2024-08-13T21:35:55.679Z",
"data": {
"payment_instrument_key": "ecf87b4b-fa6e-49c0-a7f0-f2cad6b42d79",
"payment_instrument_entry_key": "fd86d9b1-2a5e-4e03-9a59-a043c7632c97",
"payment_instrument_entry_amount": 150.00,
"payment_instrument_entry_type": "purchase",
"payment_instrument_entry_status": "processing_cancellation"
}
}
Webhook Fields
| Field | Type | Description | Characters |
|---|---|---|---|
| payment_instrument_key | string | Unique identification key for the payment instrument in uuid v4 format | 36 |
| payment_instrument_entry_key | string | Unique identification key for the payment instrument entry in uuid v4 format | 36 |
| payment_instrument_entry_amount | number | Payment instrument entry amount | - |
| payment_instrument_entry_type | string | Payment instrument entry type | payment_instrument_entry_type Enumerators |
| payment_instrument_entry_status | string | Payment instrument entry status | payment_instrument_entry_status Enumerators |
payment_instrument_entry_type Enumerators
| Enumerator | Description |
|---|---|
| purchase | Purchase |
| withdrawal | Withdrawal |
| postpaid_card_issuance | Postpaid card issuance |
payment_instrument_entry_status Enumerators
| Enumerator | Description |
|---|---|
| processing_conclusion | Payment instrument entry in completion processing |
| processing_cancellation | Payment instrument entry in cancellation processing |
| concluded | Payment instrument entry concluded |
| canceled | Payment instrument entry was canceled |
Note
The payment instrument entry can transition directly from processing_conclusion to processing_cancellation and canceled. In this case, no invoice item is created.