Payouts

Get all payouts

Changed on

Returns payouts for reconciling bank deposits against Mews. Constituent transactions are retrieved separately via Get all payout transactions. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/payouts/getAll

Request

  • Base URL: https://api.mews.com
  • URL: https://api.mews.com/api/connector/v1/payouts/getAll
  • Auth: none declared

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdsstring[] nullable

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

PayoutIdsstring[] nullable

Unique identifiers of the requested payouts.

PaymentProvidersPaymentProviderEnum[] nullable

Payment service providers to filter payouts by.

Response

OK

Cursorstring uuid nullable

Unique identifier of the last returned payout, used as the starting point of the next data page. Null when there are no more data.

Changes

  • 51a1610a8999Revision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

  • 49ab012a9b22Revision changes
    • info

      endpoint added