Payout lifecycle event delivered into the BC webhook system.

Payout lifecycle event delivered into the BC webhook system.

Payload

Payout lifecycle event.

string
required
length between 1 and 128
^[A-Za-z0-9_-]+$

Opaque event identifier.

enum
required

Closed enum of event types emitted by this API into the BC webhook system.
Payin and internal-movement events will be added when those flows ship.

string
required
length between 1 and 32
^\d+\.\d+\.\d+(-[0-9A-Za-z.-]+)?(\+[0-9A-Za-z.-]+)?$

API semver that produced this event.

date-time
required

Event timestamp.

data
object
required

Full payout resource representation. Mirrors the TSP Payout which
spreads TransactionCore; those fields are inlined here.

Response
200

Webhook acknowledged.

LoadingLoading…