Payouts

Get the events for a single payout

Every time a payout transitions to a new status, an event is created. This endpoint allows you to retrieve the events for a single payout.

get/payouts/{id}/events

Request

Path parameters

idstring required

The payout id

Response

Ok

updatedAtstring date-time required

Date when the event was last updated.

createdAtstring date-time required

Date when the event was created.

availableBalancenumber double nullable

Available balance for the enterprise.

fboBalancenumber double nullable

Total balance available in the FBO account.

pendingBalancenumber double nullable

Balance that is committed in pending payouts.

eventTypestring required

Type of the event.

operationTypestring required

Type of the operation associated with the event.

It could be either 'PAYOUT' or 'PAYIN'.

operationIdstring uuid required

Unique identifier for the operation associated with the event.

userIdstring uuid required

Unique identifier for the user associated with the event.

idstring uuid required

Unique identifier for the event.

Example response

[
  {
    "availableBalance": 12345.67,
    "fboBalance": 12345.67,
    "pendingBalance": 123.45
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.