Sign in
payment
payout

List all payouts

get/payment/{connection_id}/payout

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring
updated_atstring
total_amountnumber
currencystring
notesstring
status'SUCCEEDED' | 'PENDING' | 'FAILED' | 'CANCELED'
arrival_atstring date-time
fee_amountnumber
net_amountnumber
account_idstring
rawobject

Changes

Changed in 1 of the 34 revisions of this API.10

  • 669f9277e17310See the full diff
    • ○

      added the enum value account_id to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the enum value arrival_at to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the enum value fee_amount to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the enum value lineitems to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the enum value net_amount to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added