Skip to main content

GetPayoutsResponse

nextPage object

A base64 hash to get a next page of payouts

oneOf
null
payouts object[]required

List of payouts

Possible values: <= 30

  • Array [
    • completedAt object
    oneOf
    null
    createdAtstring<Instant>required

    The date and time when the payout was created. Format: ISO 8601. Example: 2021-12-31T23:59:59.111Z

    Possible values: <= 2147483647 characters

    description object

    The description of the payout. Example: 'Monthly payroll'

    oneOf
    null
    idstring<uuid>required

    The unique identifier of the payout. Format: UUID. Example: 123e4567-e89b-12d3-a456-426614174000

    Possible values: >= 36 characters and <= 36 characters

    name object

    The name of the payout. Example: 'Payroll'

    oneOf
    null
    paidAmount object
    oneOf
    null
    paidTransfersnumber<int32>required

    The number of transfers that were paid. Example: 100

    Possible values: >= -2147483648 and <= 2147483647

    startedAt object
    oneOf
    null
    statePubApiPayoutPayoutState (string)required

    The state of the payout. Possible values: CREATED, STARTED, COMPLETED

    Possible values: [CREATED, STARTED, COMPLETED, CANCELED, PAUSED]

    totalAmount object
    oneOf
    null
    totalTransfersnumber<int32>required

    The total number of transfers in the payout. Example: 100

    Possible values: >= -2147483648 and <= 2147483647

  • ]
    • GetPayoutsResponse
    {
      "nextPage": "null",
      "payouts": [
        {
          "completedAt": "null",
          "createdAt": "string",
          "description": "null",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "null",
          "paidAmount": "null",
          "paidTransfers": 0,
          "startedAt": "null",
          "state": "CREATED",
          "totalAmount": "null",
          "totalTransfers": 0
        }
      ]
    }