Summarize Settlements

Totals the settlements that match a search, grouped by settlementStatus and currency.

Use it for the totals above a settlement list: how many settlements, and the credit, debit, fee, chargeback, adjustment
and refund amounts per currency. Only settlements whose processingStatus is SUCCESS are counted. Takes the same
filter as Search Settlements; send its conditions in an all group, because they are always combined with AND.

Permission: Merchant Read.

Errors

  • 400 VALIDATION_ERROR or 400 INVALID_REQUEST: the filter is invalid, as in Search Settlements.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A summary request: the same filter as the matching search. Every matching record is counted.

SearchAllConditions<SettlementSearchField> | SearchAnyConditions<SettlementSearchField>

Conditions a record must match. Omit to count every record. Send the conditions in an all group.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json