Skip to main content

​
When this fires

This is an organization-level event about YOUR money as the merchant, not about a customer. Payment funds start as pending while the provider holds them; a periodic check marks them available once the provider releases them, and this event fires when new funds become available. availableAmount is your full available payout balance in cents at that moment — not just the newly released funds. Use it to know when requesting a payout is worthwhile, or to drive your own treasury automation.

Body

application/json
​
id
string
required
​
event
string
required
Allowed value: "payout.available"
​
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.