Webhook event notification request.
This request is sent to registered webhook event handlers after |
---|
A payout completes successfully |
The Request body described below is the message
property in the event notification request data. For more information about event notification requests, visit Webhooks.
failure_code | string If the payout failed, a code representing the failure. Visit Invoice Failure Codes for more information. | ||||||||||||||||||||||||||
failure_reason | string If the payout failed, a human-readable reason for the failure. Visit Invoice Failure Codes for more information. | ||||||||||||||||||||||||||
payout_flow | string The flow that the payout will go through. One of the following values:
| ||||||||||||||||||||||||||
payout_status | string The current status of the payout request. One of the following values:
| ||||||||||||||||||||||||||
payout_status_id | string <= 36 characters An ID for the payout. |
Return a 2XX status to indicate that the data was received successfully
{- "failure_code": "generic_error",
- "failure_reason": "an error ocurred",
- "payout_flow": "STANDARD",
- "payout_status": "FAILED",
- "payout_status_id": "string"
}