Payout

Payout snapshot for payout.created, payout.updated, payout.paid, payout.failed, and payout.canceled events.

  • id
    Type: string
    required

    Payout ID.

  • created
    Type: stringFormat: date-time

    Time the Payout was created.

  • updated
    Type: stringFormat: date-time

    Time the Payout was last updated.

  • object
    enum
    const:  
    payout
    required

    Identifies the resource carried by this event.

  • amount
    Type: integerFormat: int64

    Payout amount. Expressed in the smallest currency unit.

  • currency
    Type: string

    Three-letter currency code.

  • currency_scale
    Type: integer

    Number of decimal places used for amounts in this currency.

  • status
    Type: string

    Payout status at the time of the event.

  • account_id
    Type: string

    Account associated with the Payout.

  • livemode
    Type: boolean

    Whether the resource belongs to live mode or test mode.

  • balance_transaction
    Type: string

    Related Balance Transaction ID, or an empty string when none is available.

  • reconciliation_status
    Type: string

    Status of linking Balance Transactions to this Payout. An empty string means no reconciliation status is available.

  • metadata

    Metadata attached to the resource.

    Metadata attached to the resource.

    • propertyName
      additionalPropertyType: string