kamiPay LogokamiPay Docs

Webhook Simulator

Test your webhook integration without real payments

This is a simulator for our webhook service that allows our users in the development environment to emulate all different conditions any pix can take, both from Charge or Pay Service.

This is specifically useful also to adjust the authentication process as all these webhooks will come authenticated using the generic key that will be provided to you together with the credentials.

How it works?

Pick any webhook example from the documentation, you can edit the fields and post it to this endpoint. You will receive it in the specified URL authenticated by kamiPay.

For instance, if you are testing CHARGE service, you will generate a QR Code and then you can self-send the different status updates, like processing, done, failed without needing to make a real payment to that QR code.

This endpoint allows you to test all webhook handling flows without waiting for actual payment processing or making real transactions.

Test webhook

const url = `${baseURL}/v1/emulator/push_webhook`;
 
// Use any webhook JSON example from the documentation
const body = {
  "pix_id": "1703685644883",
  "status": "done",
  "tx_id": "0x0ce2792b5deff9440b6xxxxxxxxxxxxxxxf0c25b47739cbc3a35b16",
  "type": "charge",
  "timestamp": "2024-02-04 17:13:51.419027-03:00",
  "data": {
    "bank_txid": "e00074993202405689113sAlccnfrnyP",
    "bank_account_nr": "00360305-2218-8041045888",
    "internal_pix_id": "PAgrMjVkMkLr1705961998127",
    "amount_brl": "51.31",
    "amount_usdt": "9.961790",
    "tx_id": "0x0ce2792b5deff9440b6xxxxxxxxxxxxxxxf0c25b47739cbc3a35b16",
    "address_out": "0xca4xxxxxxxxxxxxxxx1f2fc",
    "name": "Satoshi Nakamoto"
  }
};
 
const response = await fetch(url, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${access_token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(body),
});

Response

{
  "response": 200,
  "payload": {
    "pix_id": "1703685644883",
    "status": "done",
    "tx_id": "0x0ce2792b5deff9440b6xxxxxxxxxxxxxxxf0c25b47739cbc3a35b16",
    "type": "charge",
    "timestamp": "2024-02-04 17:13:51.419027-03:00",
    "data": {
      "bank_txid": "e00074993202405689113sAlccnfrnyP",
      "bank_account_nr": "00360305-2218-8041045888",
      "internal_pix_id": "PAgrMjVkMkLr1705961998127",
      "amount_brl": "51.31",
      "amount_usdt": "9.961790",
      "tx_id": "0x0ce2792b5deff9440b6xxxxxxxxxxxxxxxf0c25b47739cbc3a35b16",
      "address_out": "0xca4xxxxxxxxxxxxxxx1f2fc",
      "name": "Satoshi Nakamoto"
    }
  }
}

The webhook simulator is only available in the development environment and should be used for testing purposes only.

You can use the webhook example payloads from the Charge and Pay webhook documentation sections to test different scenarios.

Pay

Receive notifications about outgoing Pix payments

On this page