Charge

After you generate a QR Code with our endpoint, kamiPay will keep you updated on the progress of this charge using our webhooks so you don't need to manually check status endpoints from your backend.

Handling Webhook Responses

The following are all the possible notification status you will receive:

Processing status means transaction approved; we received BRL Transfer from the payor and will soon transfer the USDT over the blockchain. There will be No transaction_id as the money was not transferred to your wallet yet, but you will be able to inform your customer that transaction was completed on their part.

{
  "pix_id": "1703685644883",
  "status": "processing",
  "tx_id": null,
  "type": "charge",
  "timestamp": "2024-02-04 17:13:51.387022-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": null,
    "address_out": "0xca4xxxxxxxxxxxxxxx1f2fc",
    "name": "Satoshi Nakamoto"
  }
}

Done

Done status means transaction was sent to your wallet, so you will also receive the transaction ID for that payment.

{
  "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"
  }
}

Failed

Failed means that transaction failed and money will return to your client's bank.

{
  "pix_id": "1703685644883",
  "status": "failed",
  "tx_id": null,
  "type": "charge",
  "timestamp": "2024-02-04 17:13:51.419027-03:00"
}

The pix_id is the same identifier that was returned when you created the QR code charge. You can use this ID to track the payment throughout its lifecycle.

Always validate the webhook signature using the method described in the Introduction before processing any webhook events.

Charge

Handling Webhook Responses

Processing

Done

Failed

On this page