This webhook is sent when a customer requests a redemption and it is completed — either successfully or with an error.
Information included
| Field | What it means |
|---|---|
document | Customer’s CPF. |
pixKeyId | The ID of the saved Pix key, if it was requested during the redemption. |
redemptionId | The unique ID of the redemption processed in Sorte Online. |
withdrawValue | The redemption amount. |
success | Indicates if the redemption was successful (true or false). |
error | Object with error details (only filled if success = false). |
error.type | The type of error. |
error.description | A description of the error. |
Example payload
{
"document": "12345678900",
"pixKeyId": 1,
"redemptionId": 123,
"withdrawValue": 150000,
"success": true,
"error": {
"type": "GenericFail|KeyDoesNotBelongToTheClient|InvalidPixData|PixKeyAndDocumentDoNotMatch|InvalidPixKey|InvalidPrizeBalance|InternalServerError|PrizesNotFound|DocumentNotFound",
"description": ""
}
}