Notifications

Learn about how the notifications for deposits works

QuickPay notifications about the change of status of a deposit use the same structure than a normal deposits as shown on Deposit Status Endpoint

Deposit Notification example

{
    "deposit_id": 123456789
}

Use the Deposit Status Endpoint to check the status of the transaction.

Also, before approving the transaction we send you an extra notification (if you have configured the callback URL for QuickPay) with the following details

QuickPay Deposit Notification example

{
  "depositId": 123456789,
  "document": "84932568207",
  "fullName": "John Doe",
  "cadastralSituation": "REGULAR",
  "dateOfBirth": "19871027",
  "pep": true,
  "address": "Rua 13, Sao Paulo, 12345-678 ",
  "email": "[email protected]",
  "success": true
}

You must respond with an HTTP 2XX code for the deposit to be approved. If you respond with anything different, a refund will be initiated.

This also triggers a notification similar to the previous one, but with the addition of the ‘refunded = true’ field.

{
  "depositId": 123456789,
  "document": "84932568207",
  "fullName": "John Doe",
  "cadastralSituation": "REGULAR",
  "dateOfBirth": "19871027",
  "pep": true,
  "address": "Rua 13, Sao Paulo, 12345-678 ",
  "email": "[email protected]",
  "success": true,
  "refunded":true
}