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

_transformQueryParams list listWithResponse

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

`Protected`_transformQueryParams

_transformQueryParams(
query: QueryParams | undefined,
names: Record<string, string>,
): QueryParams | undefined
Parameters
- query: QueryParams | undefined
- names: Record<string, string>
Returns QueryParams | undefined
Inherited from APIResource._transformQueryParams
- Defined in src/core.ts:12

list

list(
    merchantCode: string,
    query: ListPayoutsV1QueryParams,
    options?: RequestOptions,
): Promise<FinancialPayouts>
Lists payout and payout-deduction records for the specified merchant account within the requested date range.

The response can include:
- regular payouts (type = PAYOUT)
- deduction records for refunds, chargebacks, direct debit returns, or balance adjustments
Results are sorted by payout date in the requested order.
Parameters
- merchantCode: string
- query: ListPayoutsV1QueryParams
- Optionaloptions: RequestOptions
Returns Promise<FinancialPayouts>
- Defined in src/resources/payouts/index.ts:36

listWithResponse

listWithResponse(
    merchantCode: string,
    query: ListPayoutsV1QueryParams,
    options?: RequestOptions,
): Promise<WithResponse<FinancialPayouts>>
Parameters
- merchantCode: string
- query: ListPayoutsV1QueryParams
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<FinancialPayouts>>
- Defined in src/resources/payouts/index.ts:48