Class Payouts

API resource for the Payouts endpoints.

The Payouts model will allow you to track funds you’ve received from SumUp.

You can receive a detailed payouts list with information like dates, fees, references and statuses, using the List payouts endpoint.

Hierarchy

APIResource
- Payouts

Index

Constructors

Properties

Methods

list listDeprecated

Constructors

constructor

new Payouts(client: SumUp): Payouts
Parameters
- client: SumUp
Returns Payouts
Inherited from APIResource.constructor
- Defined in src/core.ts:8

Properties

`Protected`_client

_client: SumUp

Methods

list

list(
    merchantCode: string,
    query: ListPayoutsV1QueryParams,
    options?: RequestOptions,
): APIPromise<FinancialPayouts, Problem | ErrorExtended[]>
Lists ordered payouts for the merchant account.
Parameters
- merchantCode: string
- query: ListPayoutsV1QueryParams
- Optionaloptions: RequestOptions
Returns APIPromise<FinancialPayouts, Problem | ErrorExtended[]>
- Defined in src/resources/payouts/index.ts:36

listDeprecated

listDeprecated(
query: ListPayoutsQueryParams,
options?: RequestOptions,
): APIPromise<FinancialPayouts, Problem | ErrorExtended[]>
Lists ordered payouts for the merchant account.
Parameters
- query: ListPayoutsQueryParams
- Optionaloptions: RequestOptions
Returns APIPromise<FinancialPayouts, Problem | ErrorExtended[]>
- Defined in src/resources/payouts/index.ts:51