Webhook for Pending Transactions
Webhook to notify about the completion of transactions that were originally responded to as pending (returned with http status 202).
Webhook Request Body
Request Body: Transaction sent
{
"webhook_type": "baas.pix_transfer.outgoing_pix",
"webhook_datetime": "2021-10-22T20:30:23.459Z",
"data": {
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"pix_transfer_status": "sent",
"created_at": "2021-10-22T20:30:23.459Z"
}
}
Request Body: Transaction rejected
{
"webhook_type": "baas.pix_transfer.outgoing_pix",
"webhook_datetime": "2021-10-22T20:30:23.459Z",
"data": {
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"pix_transfer_status": "rejected",
"created_at": "2021-10-22T20:30:23.459Z",
"error_code": "PXT000132",
"error_description": "Target account number is invalid.",
"error_translation": "Número da conta de destino é inexistente ou inválido.",
"error_short_description": null
}
}
Webhook Body Param
Field | Type | Description | Max. Characters |
---|---|---|---|
webhook_type | string | An enumerator that defines the type of event being reported | 23 |
webhook_datetime | string | Date and time the webhook was sent | 20 |
request_control_key | string | UUID4 for querying about the made request | 36 |
pix_transfer_key | string | Identification key of the Pix transfer in the QI system | 36 |
pix_transfer_status | string | Transaction status | 200 |
created_at | string | Date and time of the transaction's creation | 20 |