Skip to main content

​
When this fires

When the provider reports that a payout could not be completed — at either leg of the lifecycle, most commonly when the bank rejects the deposit (closed account, invalid details). The funds return to your available balance. failureCode and failureMessage carry the provider’s reason when available. Use it to alert your finance contact and to fix the bank account before requesting the payout again.

Body

application/json
​
id
string
required
​
event
string
required
Allowed value: "payout.failed"
​
timestamp
string
required
​
organizationId
string
required
​
mode
enum<string>
required
Available options:
live,
sandbox
​
apiVersion
string
required
​
data
object
required

Response

200

Return any 2xx status code to acknowledge receipt of the event.