Query payouts

Use this endpoint to query payout data using filters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The request body containg the payout filters used in the search

This object contains various options that can be used to filter payouts that must be returned.

number
-99999999.99 to 99999999.99

The minimum amount to filter on.

number
-99999999.99 to 99999999.99

The maximum amount to filter on.

int64

Unique value identifying the commercial unit.

date-time

Exclude payouts that occurred after and including this date time (ISO8601)

string

The name of the entity for the configured payout level.

int64
1 to 3000
Defaults to 1000

The number of items to return.

string
length ≤ 50

Reference containing payout level, merchant_reconciliation_reference, payout date and payout sequence number merchant_reconciliation_reference is a custom value set by the merchant on the level of the payout. This MerchantPayoutReference can be used as a reference for reconciliation by the merchant Format is: Mrr_[payout_level]: [merchant reconciliation reference] [Date]_[Payout sequence number]

string

The IBAN to where the amount was settled.

string
enum

The payout level.

Allowed:
string
length ≤ 50

The payout reference. For filters, partial matching is supported (e.g., by payout date like 20200410 or sequence number like _1).

int64

Unique value identifying the shop.

date-time

Exclude records that occurred before this date time (ISO8601)

string
length ≤ 60

This property contains a token and is used for pagination. For example, if you send a query and receive the first page of 1000 entries, the response will contain a next_page_token. This value can be set in the starting_after filter of the subsequent request to retrieve the next page of the result set.

string
length ≤ 16

Unique value identifying the terminal.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json