{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"type": "transaction.status-changed",
"version": 1,
"timestamp": "2025-01-15T10:30:00.000Z",
"source": "transaction-service",
"company_id": "comp_123456789",
"correlation_id": "corr_987654321"
}Events
Transaction status changed
Triggered when a transaction status changes throughout its lifecycle.
This event is sent when:
- Payment is processed by provider (PROCESSING → APPROVED/REFUSED)
- Provider HTTP call fails (PROCESSING → FAILED)
- Transaction is refunded (APPROVED → REFUNDED/PARTIALLY_REFUNDED)
- Transaction expires (WAITING_PAYMENT → EXPIRED)
- A PIX or BOLEPIX is paid after the charge expired (EXPIRED → APPROVED): the payment was made in time and its confirmation arrived after the expiry.
EXPIREDis otherwise final; fulfil the order or refund it. - Transaction cancellation is requested (WAITING_PAYMENT → PENDING_CANCELLATION)
- Transaction is cancelled (PENDING_CANCELLATION → CANCELLED)
- Transaction requires 3DS authentication (PROCESSING → AWAITING_3DS)
- Transaction is authenticated via 3DS (AWAITING_3DS → PROCESSING → APPROVED/REFUSED)
- Other status transitions occur
WEBHOOK
transaction.status-changed
{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"type": "transaction.status-changed",
"version": 1,
"timestamp": "2025-01-15T10:30:00.000Z",
"source": "transaction-service",
"company_id": "comp_123456789",
"correlation_id": "corr_987654321"
}Body
application/json
Base structure for all webhook events
Unique event identifier
Example:
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Event type identifier
Available options:
transaction.status-changed Example:
"transaction.status-changed"
Event schema version
Example:
1
Event timestamp in ISO 8601 format
Example:
"2025-01-15T10:30:00.000Z"
Service that generated the event
Example:
"transaction-service"
Company ID associated with the event
Example:
"comp_123456789"
Shared by every event that one request, inbound webhook or job item caused, so related events can be grouped. Not unique per event: use id to identify and deduplicate an event.
Example:
"corr_987654321"
Transaction status change details
Show child attributes
Show child attributes
Response
Webhook received successfully