List webhook deliveries
GETTag: api-baas-get-all-webhook-deliveriesDescription: List the webhook deliveries Zro owed the wallet owner, newest first, optionally narrowed to one event type.Creation window: at most 30 days; with no window given the last 30 days are returned.Pagination: by opaque/v1/webhooks/deliveries
cursor, not by page number, so there is no total. Pass the cursor of a response back to fetch the next page and stop when has_next_page is false.States: PENDING is the short window before the first attempt has a result; FAILED with is_retrying: true means it failed and will be tried again; is_retrying: null means the webhook has no retry policy configured.Request
Query Parameters
Possible values: [DEVOLUTION_RECEIVED, DEVOLUTION_RECEIVED_FAILED, DEVOLUTION_COMPLETED, DEVOLUTION_FAILED, DEPOSIT_RECEIVED, DEPOSIT_RECEIVED_FAILED, PAYMENT_COMPLETED, PAYMENT_FAILED, ONBOARDING_FINISHED, ONBOARDING_FAILED, ONBOARDING_REJECTED, ONBOARDING_LEGAL_REPRESENTATIVE_LIVENESS_RELEASED, ONBOARDING_LEGAL_REPRESENTATIVE_LIVENESS_UPDATED, ONBOARDING_NATURAL_PERSON_LIVENESS_RELEASED, ONBOARDING_NATURAL_PERSON_LIVENESS_UPDATED, USER_LIMIT_REQUEST_APPROVED, USER_LIMIT_REQUEST_REJECTED, ACQUIRING_TRANSACTION, ACQUIRING_TRANSACTION_FAILED_BRA, ACQUIRING_TRANSACTION_FAILED_PER, ACQUIRING_TRANSACTION_FAILED_ARG, ACQUIRING_TRANSACTION_FAILED_CHL, ACQUIRING_TRANSACTION_AUTHORIZED_BRA, ACQUIRING_TRANSACTION_AUTHORIZED_PER, ACQUIRING_TRANSACTION_AUTHORIZED_ARG, ACQUIRING_TRANSACTION_AUTHORIZED_CHL, ACQUIRING_TRANSACTION_DECLINED_BRA, ACQUIRING_TRANSACTION_DECLINED_PER, ACQUIRING_TRANSACTION_DECLINED_ARG, ACQUIRING_TRANSACTION_DECLINED_CHL, ACQUIRING_TRANSACTION_SETTLED_BRA, ACQUIRING_TRANSACTION_SETTLED_PER, ACQUIRING_TRANSACTION_SETTLED_ARG, ACQUIRING_TRANSACTION_SETTLED_CHL, ACQUIRING_TRANSACTION_CANCELLED_BRA, ACQUIRING_TRANSACTION_CANCELLED_PER, ACQUIRING_TRANSACTION_CANCELLED_ARG, ACQUIRING_TRANSACTION_CANCELLED_CHL, ACQUIRING_TRANSACTION_EXPIRED_BRA, ACQUIRING_TRANSACTION_EXPIRED_PER, ACQUIRING_TRANSACTION_EXPIRED_ARG, ACQUIRING_TRANSACTION_EXPIRED_CHL, ACQUIRING_TRANSACTION_WAITING_BRA, ACQUIRING_TRANSACTION_WAITING_PER, ACQUIRING_TRANSACTION_WAITING_ARG, ACQUIRING_TRANSACTION_WAITING_CHL, ACQUIRING_TRANSACTION_WAITING_MEX, ACQUIRING_TRANSACTION_WAITING_CHECKOUT_BRA, ACQUIRING_TRANSACTION_WAITING_CHECKOUT_PER, ACQUIRING_TRANSACTION_WAITING_CHECKOUT_ARG, ACQUIRING_TRANSACTION_WAITING_CHECKOUT_CHL, ACQUIRING_TRANSACTION_WAITING_CHECKOUT_MEX, ACQUIRING_TRANSACTION_REFUND, ACQUIRING_TRANSACTION_REFUND_ACCEPTED_BRA, ACQUIRING_TRANSACTION_REFUND_DECLINED_BRA, ACQUIRING_TRANSACTION_REFUND_FAILED_BRA, ACQUIRING_TRANSACTION_REFUND_WAITING_BRA, THREE_DS_AUTHENTICATION_ACCEPTED, THREE_DS_AUTHENTICATION_REJECTED, THREE_DS_AUTHENTICATION_FAILED, CASH_DEPOSIT, CASH_DEPOSIT_AUTHORIZED_CHL, CASH_DEPOSIT_WAITING_CHL, CASH_DEPOSIT_EXPIRED_CHL, CASH_DEPOSIT_SETTLED_CHL, CASH_DEPOSIT_DENIED_CHL, CASH_DEPOSIT_FAILED_CHL, CASH_DEPOSIT_AUTHORIZED_ARG, CASH_DEPOSIT_WAITING_ARG, CASH_DEPOSIT_EXPIRED_ARG, CASH_DEPOSIT_SETTLED_ARG, CASH_DEPOSIT_DENIED_ARG, CASH_DEPOSIT_FAILED_ARG, CASH_DEPOSIT_AUTHORIZED_PER, CASH_DEPOSIT_WAITING_PER, CASH_DEPOSIT_EXPIRED_PER, CASH_DEPOSIT_SETTLED_PER, CASH_DEPOSIT_DENIED_PER, CASH_DEPOSIT_FAILED_PER, BANK_TRANSFER_DEPOSIT, BANK_TRANSFER_DEPOSIT_AUTHORIZED_CHL, BANK_TRANSFER_DEPOSIT_WAITING_CHL, BANK_TRANSFER_DEPOSIT_EXPIRED_CHL, BANK_TRANSFER_DEPOSIT_SETTLED_CHL, BANK_TRANSFER_DEPOSIT_DENIED_CHL, BANK_TRANSFER_DEPOSIT_FAILED_CHL, BANK_TRANSFER_DEPOSIT_AUTHORIZED_ARG, BANK_TRANSFER_DEPOSIT_WAITING_ARG, BANK_TRANSFER_DEPOSIT_SETTLED_ARG, BANK_TRANSFER_DEPOSIT_EXPIRED_ARG, BANK_TRANSFER_DEPOSIT_DENIED_ARG, BANK_TRANSFER_DEPOSIT_AUTHORIZED_PER, BANK_TRANSFER_DEPOSIT_WAITING_PER, BANK_TRANSFER_DEPOSIT_EXPIRED_PER, BANK_TRANSFER_DEPOSIT_SETTLED_PER, BANK_TRANSFER_DEPOSIT_DENIED_PER, BANK_TRANSFER_DEPOSIT_FAILED_PER, BANK_TRANSFER_DEPOSIT_WAITING_CHECKOUT_CHL, BANK_TRANSFER_DEPOSIT_WAITING_CHECKOUT_ARG, BANK_TRANSFER_DEPOSIT_WAITING_CHECKOUT_PER, SPEI_BANK_TRANSFER_DEPOSIT, SPEI_BANK_TRANSFER_DEPOSIT_WAITING_MEX, SPEI_BANK_TRANSFER_DEPOSIT_AUTHORIZED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_DENIED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_SETTLED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_EXPIRED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_REFUNDED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_FAILED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_REFUND, SPEI_BANK_TRANSFER_DEPOSIT_REFUND_WAITING_MEX, SPEI_BANK_TRANSFER_DEPOSIT_REFUND_ACCEPTED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_REFUND_DECLINED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_REFUND_FAILED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_REFUND_EXPIRED_MEX, SPEI_BANK_TRANSFER_PAYMENT, SPEI_BANK_TRANSFER_PAYMENT_WAITING_MEX, SPEI_BANK_TRANSFER_PAYMENT_PROCESSED_MEX, SPEI_BANK_TRANSFER_PAYMENT_REJECTED_MEX, SPEI_BANK_TRANSFER_PAYMENT_REVERSED_MEX, SPEI_BANK_TRANSFER_PAYMENT_FAILED_MEX, BANK_TRANSFER_PAYMENT, BANK_TRANSFER_PAYMENT_PROCESSED_CHL, BANK_TRANSFER_PAYMENT_WAITING_CHL, BANK_TRANSFER_PAYMENT_REJECTED_CHL, BANK_TRANSFER_PAYMENT_FAILED_CHL, BANK_TRANSFER_PAYMENT_PROCESSED_ARG, BANK_TRANSFER_PAYMENT_WAITING_ARG, BANK_TRANSFER_PAYMENT_REJECTED_ARG, BANK_TRANSFER_PAYMENT_FAILED_ARG, BANK_TRANSFER_PAYMENT_PROCESSED_PER, BANK_TRANSFER_PAYMENT_WAITING_PER, BANK_TRANSFER_PAYMENT_REJECTED_PER, BANK_TRANSFER_PAYMENT_FAILED_PER, WALLET_ACCOUNT_BALANCE_UPDATED, YAPE_WALLET_DEPOSIT, YAPE_WALLET_DEPOSIT_AUTHORIZED_PER, YAPE_WALLET_DEPOSIT_WAITING_PER, YAPE_WALLET_DEPOSIT_EXPIRED_PER, YAPE_WALLET_DEPOSIT_SETTLED_PER, YAPE_WALLET_DEPOSIT_DENIED_PER, YAPE_WALLET_DEPOSIT_FAILED_PER, YAPE_WALLET_PAYMENT, YAPE_WALLET_PAYMENT_AUTHORIZED_PER, YAPE_WALLET_PAYMENT_WAITING_PER, YAPE_WALLET_PAYMENT_REJECTED_PER, YAPE_WALLET_PAYMENT_FAILED_PER, YAPE_WALLET_PAYMENT_PROCESSED_PER, QR_DEPOSIT, QR_DEPOSIT_AUTHORIZED_PER, QR_DEPOSIT_AUTHORIZED_CHL, QR_DEPOSIT_AUTHORIZED_ARG, QR_DEPOSIT_DENIED_PER, QR_DEPOSIT_DENIED_CHL, QR_DEPOSIT_DENIED_ARG, QR_DEPOSIT_EXPIRED_PER, QR_DEPOSIT_EXPIRED_CHL, QR_DEPOSIT_EXPIRED_ARG, QR_DEPOSIT_SETTLED_PER, QR_DEPOSIT_SETTLED_CHL, QR_DEPOSIT_SETTLED_ARG, QR_DEPOSIT_FAILED_PER, QR_DEPOSIT_FAILED_CHL, QR_DEPOSIT_FAILED_ARG, QR_DEPOSIT_WAITING_PER, QR_DEPOSIT_WAITING_CHL, QR_DEPOSIT_WAITING_ARG, OPEN_FINANCE_PAYMENT_CONSENT, OPEN_FINANCE_PAYMENT_CONSENT_WAITING, OPEN_FINANCE_PAYMENT_CONSENT_WAITING_AUTHORIZATION, OPEN_FINANCE_PAYMENT_CONSENT_AUTHORIZED, OPEN_FINANCE_PAYMENT_CONSENT_REJECTED, OPEN_FINANCE_PAYMENT_CONSENT_CONSUMED, OPEN_FINANCE_PAYMENT_CONSENT_FAILED, OPEN_FINANCE_PAYMENT, OPEN_FINANCE_PAYMENT_WAITING, OPEN_FINANCE_PAYMENT_COMPLETED, OPEN_FINANCE_PAYMENT_REJECTED, OPEN_FINANCE_PAYMENT_FAILED, OPEN_FINANCE_PAYMENT_CANCELLED, OPEN_FINANCE_PAYMENT_SCHEDULED, COMPANY_REGISTRATION_ONBOARDING_STATUS_UPDATED, COMPANY_REGISTRATION_ONBOARDING_APPROVED, PIX_AUTOMATIC_RECURRENCE_CREATED, PIX_AUTOMATIC_RECURRENCE_FAILED, PIX_AUTOMATIC_RECURRENCE_APPROVED, PIX_AUTOMATIC_RECURRENCE_REJECTED, PIX_AUTOMATIC_RECURRENCE_CANCELED, PIX_AUTOMATIC_RECURRENCE_CANCELED_FAILED, PIX_AUTOMATIC_RECURRENCE_EXPIRED, PIX_AUTOMATIC_RECURRENCE_FINISHED, PIX_FUND_RECOVERY_REQUEST_CREATED, PIX_FUND_RECOVERY_REQUEST_ANALYSED, PIX_FUND_RECOVERY_REQUEST_COMPLETED_APPROVED, PIX_FUND_RECOVERY_REQUEST_COMPLETED_REJECTED, PIX_FUND_RECOVERY_REQUEST_CANCELED, PIX_FUND_RECOVERY_REQUEST_FAILED, PIX_REFUND_OPEN, PIX_REFUND_PENDING, PIX_REFUND_WAITING, PIX_REFUND_CLOSED, PIX_REFUND_CANCELED, PIX_REFUND_FAILED, PIX_AUTOMATIC_CHARGE_CREATED, PIX_AUTOMATIC_CHARGE_CREATED_FAILED, PIX_AUTOMATIC_CHARGE_PAID, PIX_AUTOMATIC_CHARGE_NOT_PAID, PIX_AUTOMATIC_CHARGE_CANCELED, PIX_AUTOMATIC_CHARGE_CANCELED_FAILED, PIX_AUTOMATIC_AUTHORIZATION_PENDING, PIX_AUTOMATIC_AUTHORIZATION_APPROVED, PIX_AUTOMATIC_AUTHORIZATION_REJECTED, PIX_AUTOMATIC_AUTHORIZATION_CANCELED, PIX_AUTOMATIC_AUTHORIZATION_FINISHED, PIX_AUTOMATIC_AUTHORIZATION_APPROVED_FAILED, PIX_AUTOMATIC_AUTHORIZATION_REJECTED_FAILED, PIX_AUTOMATIC_AUTHORIZATION_CANCELED_FAILED, PIX_AUTOMATIC_AUTHORIZATION_UPDATED_CONFIRMED, PIX_AUTOMATIC_AUTHORIZATION_UPDATED_FAILED, PIX_AUTOMATIC_PAYMENT_CREATED, PIX_AUTOMATIC_PAYMENT_CANCELLATION_FAILED, PIX_AUTOMATIC_PAYMENT_CANCELED, BANKING_BILLET_PIX_DEPOSIT_CREATED_CONFIRMED, BANKING_BILLET_PIX_DEPOSIT_CREATED_FAILED, BANKING_BILLET_PIX_DEPOSIT_RECEIVED, BANKING_BILLET_PIX_DEPOSIT_BATCH_REJECTED, BANKING_BILLET_PIX_DEPOSIT_BATCH_GENERATED, BANKING_BILLET_PIX_DEPOSIT_BATCH_FAILED, JUDICIAL_BLOCK_ACCOUNT, JUDICIAL_UNBLOCK_ACCOUNT, JUDICIAL_BLOCK_ACCOUNT_BALANCE, JUDICIAL_UNBLOCK_ACCOUNT_BALANCE, BANKING_TED_RECEIVED, BANKING_TED_SENT, PIX_PAYMENT_FRAUD_ANALYSIS, PIX_DEPOSIT_FRAUD_ANALYSIS, PIX_PAYMENT_FRAUD_DECLINED, PIX_DEPOSIT_FRAUD_DECLINED]
Filter by webhook event type. Only deliveries of a type the wallet owner has a webhook registered for can be returned.
Start of the creation window, inclusive. Defaults to 30 days before created_at_end. The window may span at most 30 days.
End of the creation window, inclusive. Defaults to today. The window may span at most 30 days.
Opaque cursor returned as cursor by the previous page. Absent on the first page.
How many deliveries to return. A value above the platform ceiling is silently capped to it.
Header Parameters
Sender Wallet UUID (if empty, your default Wallet UUID will be settled)
The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.
UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.
UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.
Possible values: [pt-BR, en-US]
Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.
Responses
- 200
- 400
- 401
- 403
- 422
Deliveries listed successfully.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
PENDING: the short window before the first attempt has a result.CONFIRMED: the endpoint accepted it.FAILED: the last attempt failed.- MOD1
- MOD2
- ]
data object[]required
Deliveries page, newest first.
Delivery id.
Possible values: [DEVOLUTION_RECEIVED, DEVOLUTION_RECEIVED_FAILED, DEVOLUTION_COMPLETED, DEVOLUTION_FAILED, DEPOSIT_RECEIVED, DEPOSIT_RECEIVED_FAILED, PAYMENT_COMPLETED, PAYMENT_FAILED, ONBOARDING_FINISHED, ONBOARDING_FAILED, ONBOARDING_REJECTED, ONBOARDING_LEGAL_REPRESENTATIVE_LIVENESS_RELEASED, ONBOARDING_LEGAL_REPRESENTATIVE_LIVENESS_UPDATED, ONBOARDING_NATURAL_PERSON_LIVENESS_RELEASED, ONBOARDING_NATURAL_PERSON_LIVENESS_UPDATED, USER_LIMIT_REQUEST_APPROVED, USER_LIMIT_REQUEST_REJECTED, ACQUIRING_TRANSACTION, ACQUIRING_TRANSACTION_FAILED_BRA, ACQUIRING_TRANSACTION_FAILED_PER, ACQUIRING_TRANSACTION_FAILED_ARG, ACQUIRING_TRANSACTION_FAILED_CHL, ACQUIRING_TRANSACTION_AUTHORIZED_BRA, ACQUIRING_TRANSACTION_AUTHORIZED_PER, ACQUIRING_TRANSACTION_AUTHORIZED_ARG, ACQUIRING_TRANSACTION_AUTHORIZED_CHL, ACQUIRING_TRANSACTION_DECLINED_BRA, ACQUIRING_TRANSACTION_DECLINED_PER, ACQUIRING_TRANSACTION_DECLINED_ARG, ACQUIRING_TRANSACTION_DECLINED_CHL, ACQUIRING_TRANSACTION_SETTLED_BRA, ACQUIRING_TRANSACTION_SETTLED_PER, ACQUIRING_TRANSACTION_SETTLED_ARG, ACQUIRING_TRANSACTION_SETTLED_CHL, ACQUIRING_TRANSACTION_CANCELLED_BRA, ACQUIRING_TRANSACTION_CANCELLED_PER, ACQUIRING_TRANSACTION_CANCELLED_ARG, ACQUIRING_TRANSACTION_CANCELLED_CHL, ACQUIRING_TRANSACTION_EXPIRED_BRA, ACQUIRING_TRANSACTION_EXPIRED_PER, ACQUIRING_TRANSACTION_EXPIRED_ARG, ACQUIRING_TRANSACTION_EXPIRED_CHL, ACQUIRING_TRANSACTION_WAITING_BRA, ACQUIRING_TRANSACTION_WAITING_PER, ACQUIRING_TRANSACTION_WAITING_ARG, ACQUIRING_TRANSACTION_WAITING_CHL, ACQUIRING_TRANSACTION_WAITING_MEX, ACQUIRING_TRANSACTION_WAITING_CHECKOUT_BRA, ACQUIRING_TRANSACTION_WAITING_CHECKOUT_PER, ACQUIRING_TRANSACTION_WAITING_CHECKOUT_ARG, ACQUIRING_TRANSACTION_WAITING_CHECKOUT_CHL, ACQUIRING_TRANSACTION_WAITING_CHECKOUT_MEX, ACQUIRING_TRANSACTION_REFUND, ACQUIRING_TRANSACTION_REFUND_ACCEPTED_BRA, ACQUIRING_TRANSACTION_REFUND_DECLINED_BRA, ACQUIRING_TRANSACTION_REFUND_FAILED_BRA, ACQUIRING_TRANSACTION_REFUND_WAITING_BRA, THREE_DS_AUTHENTICATION_ACCEPTED, THREE_DS_AUTHENTICATION_REJECTED, THREE_DS_AUTHENTICATION_FAILED, CASH_DEPOSIT, CASH_DEPOSIT_AUTHORIZED_CHL, CASH_DEPOSIT_WAITING_CHL, CASH_DEPOSIT_EXPIRED_CHL, CASH_DEPOSIT_SETTLED_CHL, CASH_DEPOSIT_DENIED_CHL, CASH_DEPOSIT_FAILED_CHL, CASH_DEPOSIT_AUTHORIZED_ARG, CASH_DEPOSIT_WAITING_ARG, CASH_DEPOSIT_EXPIRED_ARG, CASH_DEPOSIT_SETTLED_ARG, CASH_DEPOSIT_DENIED_ARG, CASH_DEPOSIT_FAILED_ARG, CASH_DEPOSIT_AUTHORIZED_PER, CASH_DEPOSIT_WAITING_PER, CASH_DEPOSIT_EXPIRED_PER, CASH_DEPOSIT_SETTLED_PER, CASH_DEPOSIT_DENIED_PER, CASH_DEPOSIT_FAILED_PER, BANK_TRANSFER_DEPOSIT, BANK_TRANSFER_DEPOSIT_AUTHORIZED_CHL, BANK_TRANSFER_DEPOSIT_WAITING_CHL, BANK_TRANSFER_DEPOSIT_EXPIRED_CHL, BANK_TRANSFER_DEPOSIT_SETTLED_CHL, BANK_TRANSFER_DEPOSIT_DENIED_CHL, BANK_TRANSFER_DEPOSIT_FAILED_CHL, BANK_TRANSFER_DEPOSIT_AUTHORIZED_ARG, BANK_TRANSFER_DEPOSIT_WAITING_ARG, BANK_TRANSFER_DEPOSIT_SETTLED_ARG, BANK_TRANSFER_DEPOSIT_EXPIRED_ARG, BANK_TRANSFER_DEPOSIT_DENIED_ARG, BANK_TRANSFER_DEPOSIT_AUTHORIZED_PER, BANK_TRANSFER_DEPOSIT_WAITING_PER, BANK_TRANSFER_DEPOSIT_EXPIRED_PER, BANK_TRANSFER_DEPOSIT_SETTLED_PER, BANK_TRANSFER_DEPOSIT_DENIED_PER, BANK_TRANSFER_DEPOSIT_FAILED_PER, BANK_TRANSFER_DEPOSIT_WAITING_CHECKOUT_CHL, BANK_TRANSFER_DEPOSIT_WAITING_CHECKOUT_ARG, BANK_TRANSFER_DEPOSIT_WAITING_CHECKOUT_PER, SPEI_BANK_TRANSFER_DEPOSIT, SPEI_BANK_TRANSFER_DEPOSIT_WAITING_MEX, SPEI_BANK_TRANSFER_DEPOSIT_AUTHORIZED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_DENIED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_SETTLED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_EXPIRED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_REFUNDED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_FAILED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_REFUND, SPEI_BANK_TRANSFER_DEPOSIT_REFUND_WAITING_MEX, SPEI_BANK_TRANSFER_DEPOSIT_REFUND_ACCEPTED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_REFUND_DECLINED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_REFUND_FAILED_MEX, SPEI_BANK_TRANSFER_DEPOSIT_REFUND_EXPIRED_MEX, SPEI_BANK_TRANSFER_PAYMENT, SPEI_BANK_TRANSFER_PAYMENT_WAITING_MEX, SPEI_BANK_TRANSFER_PAYMENT_PROCESSED_MEX, SPEI_BANK_TRANSFER_PAYMENT_REJECTED_MEX, SPEI_BANK_TRANSFER_PAYMENT_REVERSED_MEX, SPEI_BANK_TRANSFER_PAYMENT_FAILED_MEX, BANK_TRANSFER_PAYMENT, BANK_TRANSFER_PAYMENT_PROCESSED_CHL, BANK_TRANSFER_PAYMENT_WAITING_CHL, BANK_TRANSFER_PAYMENT_REJECTED_CHL, BANK_TRANSFER_PAYMENT_FAILED_CHL, BANK_TRANSFER_PAYMENT_PROCESSED_ARG, BANK_TRANSFER_PAYMENT_WAITING_ARG, BANK_TRANSFER_PAYMENT_REJECTED_ARG, BANK_TRANSFER_PAYMENT_FAILED_ARG, BANK_TRANSFER_PAYMENT_PROCESSED_PER, BANK_TRANSFER_PAYMENT_WAITING_PER, BANK_TRANSFER_PAYMENT_REJECTED_PER, BANK_TRANSFER_PAYMENT_FAILED_PER, WALLET_ACCOUNT_BALANCE_UPDATED, YAPE_WALLET_DEPOSIT, YAPE_WALLET_DEPOSIT_AUTHORIZED_PER, YAPE_WALLET_DEPOSIT_WAITING_PER, YAPE_WALLET_DEPOSIT_EXPIRED_PER, YAPE_WALLET_DEPOSIT_SETTLED_PER, YAPE_WALLET_DEPOSIT_DENIED_PER, YAPE_WALLET_DEPOSIT_FAILED_PER, YAPE_WALLET_PAYMENT, YAPE_WALLET_PAYMENT_AUTHORIZED_PER, YAPE_WALLET_PAYMENT_WAITING_PER, YAPE_WALLET_PAYMENT_REJECTED_PER, YAPE_WALLET_PAYMENT_FAILED_PER, YAPE_WALLET_PAYMENT_PROCESSED_PER, QR_DEPOSIT, QR_DEPOSIT_AUTHORIZED_PER, QR_DEPOSIT_AUTHORIZED_CHL, QR_DEPOSIT_AUTHORIZED_ARG, QR_DEPOSIT_DENIED_PER, QR_DEPOSIT_DENIED_CHL, QR_DEPOSIT_DENIED_ARG, QR_DEPOSIT_EXPIRED_PER, QR_DEPOSIT_EXPIRED_CHL, QR_DEPOSIT_EXPIRED_ARG, QR_DEPOSIT_SETTLED_PER, QR_DEPOSIT_SETTLED_CHL, QR_DEPOSIT_SETTLED_ARG, QR_DEPOSIT_FAILED_PER, QR_DEPOSIT_FAILED_CHL, QR_DEPOSIT_FAILED_ARG, QR_DEPOSIT_WAITING_PER, QR_DEPOSIT_WAITING_CHL, QR_DEPOSIT_WAITING_ARG, OPEN_FINANCE_PAYMENT_CONSENT, OPEN_FINANCE_PAYMENT_CONSENT_WAITING, OPEN_FINANCE_PAYMENT_CONSENT_WAITING_AUTHORIZATION, OPEN_FINANCE_PAYMENT_CONSENT_AUTHORIZED, OPEN_FINANCE_PAYMENT_CONSENT_REJECTED, OPEN_FINANCE_PAYMENT_CONSENT_CONSUMED, OPEN_FINANCE_PAYMENT_CONSENT_FAILED, OPEN_FINANCE_PAYMENT, OPEN_FINANCE_PAYMENT_WAITING, OPEN_FINANCE_PAYMENT_COMPLETED, OPEN_FINANCE_PAYMENT_REJECTED, OPEN_FINANCE_PAYMENT_FAILED, OPEN_FINANCE_PAYMENT_CANCELLED, OPEN_FINANCE_PAYMENT_SCHEDULED, COMPANY_REGISTRATION_ONBOARDING_STATUS_UPDATED, COMPANY_REGISTRATION_ONBOARDING_APPROVED, PIX_AUTOMATIC_RECURRENCE_CREATED, PIX_AUTOMATIC_RECURRENCE_FAILED, PIX_AUTOMATIC_RECURRENCE_APPROVED, PIX_AUTOMATIC_RECURRENCE_REJECTED, PIX_AUTOMATIC_RECURRENCE_CANCELED, PIX_AUTOMATIC_RECURRENCE_CANCELED_FAILED, PIX_AUTOMATIC_RECURRENCE_EXPIRED, PIX_AUTOMATIC_RECURRENCE_FINISHED, PIX_FUND_RECOVERY_REQUEST_CREATED, PIX_FUND_RECOVERY_REQUEST_ANALYSED, PIX_FUND_RECOVERY_REQUEST_COMPLETED_APPROVED, PIX_FUND_RECOVERY_REQUEST_COMPLETED_REJECTED, PIX_FUND_RECOVERY_REQUEST_CANCELED, PIX_FUND_RECOVERY_REQUEST_FAILED, PIX_REFUND_OPEN, PIX_REFUND_PENDING, PIX_REFUND_WAITING, PIX_REFUND_CLOSED, PIX_REFUND_CANCELED, PIX_REFUND_FAILED, PIX_AUTOMATIC_CHARGE_CREATED, PIX_AUTOMATIC_CHARGE_CREATED_FAILED, PIX_AUTOMATIC_CHARGE_PAID, PIX_AUTOMATIC_CHARGE_NOT_PAID, PIX_AUTOMATIC_CHARGE_CANCELED, PIX_AUTOMATIC_CHARGE_CANCELED_FAILED, PIX_AUTOMATIC_AUTHORIZATION_PENDING, PIX_AUTOMATIC_AUTHORIZATION_APPROVED, PIX_AUTOMATIC_AUTHORIZATION_REJECTED, PIX_AUTOMATIC_AUTHORIZATION_CANCELED, PIX_AUTOMATIC_AUTHORIZATION_FINISHED, PIX_AUTOMATIC_AUTHORIZATION_APPROVED_FAILED, PIX_AUTOMATIC_AUTHORIZATION_REJECTED_FAILED, PIX_AUTOMATIC_AUTHORIZATION_CANCELED_FAILED, PIX_AUTOMATIC_AUTHORIZATION_UPDATED_CONFIRMED, PIX_AUTOMATIC_AUTHORIZATION_UPDATED_FAILED, PIX_AUTOMATIC_PAYMENT_CREATED, PIX_AUTOMATIC_PAYMENT_CANCELLATION_FAILED, PIX_AUTOMATIC_PAYMENT_CANCELED, BANKING_BILLET_PIX_DEPOSIT_CREATED_CONFIRMED, BANKING_BILLET_PIX_DEPOSIT_CREATED_FAILED, BANKING_BILLET_PIX_DEPOSIT_RECEIVED, BANKING_BILLET_PIX_DEPOSIT_BATCH_REJECTED, BANKING_BILLET_PIX_DEPOSIT_BATCH_GENERATED, BANKING_BILLET_PIX_DEPOSIT_BATCH_FAILED, JUDICIAL_BLOCK_ACCOUNT, JUDICIAL_UNBLOCK_ACCOUNT, JUDICIAL_BLOCK_ACCOUNT_BALANCE, JUDICIAL_UNBLOCK_ACCOUNT_BALANCE, BANKING_TED_RECEIVED, BANKING_TED_SENT, PIX_PAYMENT_FRAUD_ANALYSIS, PIX_DEPOSIT_FRAUD_ANALYSIS, PIX_PAYMENT_FRAUD_DECLINED, PIX_DEPOSIT_FRAUD_DECLINED]
Webhook event type this delivery notifies.
Possible values: [PENDING, CONFIRMED, FAILED]
Delivery outcome.
URL the delivery was sent to. Credentials, path segments and query string values are masked.
reference_id object required
Id of the business object the delivery is about, for correlating it with your own records. Usually a UUID string; numeric for a small number of legacy event types.
string
number
Number of the last attempt made. Attempts start at zero.
HTTP status returned by the last attempt.
When the last attempt was made.
Whether the delivery failed and will be tried again. null means the webhook has no retry policy configured, so no further attempt is scheduled.
When the delivery was created.
When the delivery was last updated.
Opaque cursor to pass back as cursor to fetch the next page. Absent on the last page.
Whether another page exists.
{
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"type": "PAYMENT_COMPLETED",
"state": "CONFIRMED",
"target_url": "https://acme.com/webhooks/pix",
"reference_id": "string",
"total_tried": 3,
"last_response_code": 503,
"last_tried_at": "2026-11-05T12:35:09.575Z",
"is_retrying": true,
"created_at": "2026-11-05T12:35:09.575Z",
"updated_at": "2026-11-05T12:35:09.575Z"
}
],
"cursor": "MjAyNi0wOS0xMFQxMjowMDowMC4wMDBa",
"has_next_page": true
}
If the nonce header is sent and is not a valid UUID.
User authentication failed.
Webhook delivery listing is disabled.
If any param has an invalid format or type, or the creation window spans more than 30 days.