Skip to main content

Webhooks

Your account can be configured so that when certain events occur on your account, a HTTP POST request containing JSON data pertaining to that event is sent to one or more URLs of your choosing. These URLs can be configured inside your settings making a request to our team. Notifications of all events listed below are sent to all the configured URLs.


Types of webhooks​

TypeDescription
PAYMENTWhen you send a pix payment.
PAYMENT FAILEDWhen you send a pix payment and it fails.
DEVOLUTIONWhen you send a pix devolution.
DEVOLUTION FAILEDWhen you send a pix devolution and it fails.
DEVOLUTION RECEIVEDWhen receive a pix devolution.
DEPOSITWhen receive a pix deposit.
ONBOARDINGWhen you create a new user onboarding
ONBOARDING FAILEDWhen you create a new user onboarding and it fails.
MERCHANT ONBOARDING KYC STATUSWhen merchant onboarding KYC status is updated.
WALLET ACCOUNT BALANCE UPDATEDWhen the balance is updated.
JUDICIAL BLOCK ACCOUNTWhen a court order blocks the user's account entirely.
JUDICIAL BLOCK ACCOUNT BALANCEWhen a court order blocks a specific amount from the user's account balance.
JUDICIAL UNBLOCK ACCOUNTWhen a court order unblocks the user's account.
JUDICIAL UNBLOCK ACCOUNT BALANCEWhen a court order releases a previously blocked balance amount.


Credentials (Not required)​

TypeDescription
Authorization Basicbase64<username:password>
Authorization BearerAPI key or token.
Signature VerificationShared secret key.
Custom headerHeader name is not previous defined , using with api key or token.
mTLSTLS certificate.


Payloads (Version 1)​

{
  "id": "4b344f93-68fb-4ddc-83b4-6288eb7c63ce",
  "type": "PAYMENT",
  "end_to_end_id": "E26264220202404171729SrlHOwU3HqB",
  "txid": null,
  "operation_id": "0f0aca83-8ea1-5ecb-9fe9-d31782ef06fb",
  "amount": "270",
  "owner_name": "Zro Bolsao",
  "owner_person_type": "CNPJ",
  "owner_document": "00000000000000",
  "beneficiary_name": "Name",
  "beneficiary_person_type": "CPF",
  "beneficiary_document": "***000000**",
  "beneficiary_bank_name": "ZRO IP S/A",
  "beneficiary_bank_ispb": "26264220",
  "created_at": "2024-04-17T17:30:00.020Z"
}

Payloads (Version 2)​

{
  "id": "10b66e97-c747-4dcb-92ad-da1420a0a6b9",
  "type": "DEVOLUTION_RECEIVED",
  "end_to_end_id": "D26264220202404171733p6FuxQmuCKp",
  "txid": null,
  "operation_id": "fbfe1a0f-011f-5edb-a01d-19e669a6d853",
  "original_id": "4b344f93-68fb-4ddc-83b4-6288eb7c63ce",
  "original_end_to_end_id": "E26264220202404171729SrlHOwU3HqB",
  "amount": "270",
  "owner_name": "Name",
  "owner_document": "***000000**",
  "owner_bank_name": "ZRO IP S/A",
  "owner_bank_ispb": "26264220",
  "beneficiary_name": "Name",
  "beneficiary_account_number": "000000",
  "beneficiary_branch_number": "0000",
  "beneficiary_document": "***000000**",
  "beneficiary_bank_name": "ZRO IP S/A",
  "beneficiary_bank_ispb": "26264220",
  "created_at": "2024-04-17T17:33:05.712Z"
}

Payloads (Version 3)​

{
  "id": "a839f358-0e39-409e-b9a5-5a56b18ba3f2",
  "type": "DEPOSIT",
  "end_to_end_id": "E26264220202404171333Hq7F9SWyvUE",
  "txid": null,
  "operation_id": "7da84c17-d40c-5bc1-9b69-867d1460736b",
  "amount": "63",
  "owner_name": "Zro Bolsao",
  "owner_document": "00000000000",
  "owner_bank_name": "ZRO IP S/A",
  "owner_bank_ispb": "26264220",
  "owner_branch_number": "0000",
  "owner_account_number": "000000",
  "beneficiary_name": "Name",
  "beneficiary_account_number": "000000",
  "beneficiary_branch_number": "0000",
  "beneficiary_document": "***000000**",
  "beneficiary_bank_name": "ZRO IP S/A",
  "beneficiary_bank_ispb": "26264220",
  "created_at": "2024-04-17T13:33:41.071Z"
}

Payloads (Version 4)​

{
  "id": "a839f358-0e39-409e-b9a5-5a56b18ba3f2",
  "type": "DEPOSIT",
  "end_to_end_id": "E26264220202404171333Hq7F9SWyvUE",
  "txid": null,
  "operation_id": "7da84c17-d40c-5bc1-9b69-867d1460736b",
  "amount": "63",
  "owner_name": "Zro Bolsao",
  "owner_document": "00000000000",
  "owner_bank_name": "ZRO IP S/A",
  "owner_bank_ispb": "26264220",
  "owner_branch_number": "0000",
  "owner_account_number": "000000",
  "owner_account_type": "CACC",
  "beneficiary_name": "Name",
  "beneficiary_account_number": "000000",
  "beneficiary_branch_number": "0000",
  "beneficiary_document": "***000000**",
  "beneficiary_bank_name": "ZRO IP S/A",
  "beneficiary_bank_ispb": "26264220",
  "created_at": "2024-04-17T13:33:41.071Z"
}

Judicial Webhooks​

Judicial webhooks are triggered by court-ordered operations on user accounts. You can register multiple URLs for the same event type — all registered URLs will receive the notification independently. This is useful if you operate multiple products (e.g., PaaS and Gateway) and need each one to receive the event.

Payloads (Version 1)​

Triggered when a court order blocks the user's account entirely.

{
  "idJudicialBlockAccount": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "userId": "9d77c248-c5b5-4f6d-9d12-d1463dc49bd9",
  "accountNumber": "000001",
  "branchNumber": "0001",
  "processNumber": "0001234-56.2026.8.26.0100",
  "courtName": "1ª Vara Cível de São Paulo",
  "createdAt": "2024-04-17T17:30:00.020Z"
}

processNumber and courtName are optional — they are only present when provided in the court order.