Payout

Postback notification about payout updates.

Every time the status of a payout is changed, your system will receive a notification from ours, so that you are informed of the change.

POST /
Host: your_payback_notification_url.com
Content-Type: application/json

{
  "partner_code": "0001",
  "status": "done",
  "reason": ""
}

If the payout cannot be processed because the customer does not have a PicPay account, you will receive a webhook like the example below:

POST /
Host: your_payback_notification_url.com
Content-Type: application/json

{
  "partner_code": "0001",
  "status": "error",
  "reason": "PicPay account not found for the customer."
}

We expect that your system returns to ours: status code 200. If not, we’ll retry 5 more times.

Params descriptions

Parameter	Description
partner_code	The ID from your system
status	The payout’s current status
reason	If we need to add a message about the status, default is null

Status meanings

Status	Meaning	Format
done	Money was successfully transferred to the customer.	String
error	Some error occurred during the processing step.	String