Payout webhooks

Sent to the webhook URI you registered in Console when a payout succeeds or fails.

Payload
string
enum
required
Allowed:
integer
enum
required

The version of the event schema.

Allowed:
string
required

Unique ID of the event.

string
required

Unique ID for the Payout

string
required

Date and time the payout was executed

beneficiary
required
string
required

The unique identifier for the scheme.

trigger

Optional field that shows what triggered the payout.

metadata
object

Optional field for adding custom key-value data to a resource. This object can contain a maximum of 10 key-value pairs, each with a key with a maximum length of 40 characters and a non-null value with a maximum length of 500 characters.

Headers
string
required

A JWS with detached content, verifiable with our public key.
See Webhook Request Signing

Response
200

Webhook Handled

LoadingLoading…