Get Settlements by period

View all payments reconcilied by bank filtered by dates

Path Params
uuid
required

Id of an existing vendor.

Query Params
date-time
required

Filters the records whose settlement time (settled_at) is greater than or equal to the start date. Complies with RFC 3339.

Timezone: UTC

date-time
required

Filters the records whose settlement time (settled_at) is less than or equal to the end date. Complies with RFC 3339.

Timezone: UTC

string

Filters the records from the merchant corresponding to the UUID code entered. When not used, will return all vendor's reconciliations on choosed datetime. Complies with UUID Version 4.

int32
≥ 1
Defaults to 1

Use this param to indicate which page you want to read data.

int32
20 to 1000
Defaults to 20

Number of elements you want to read in the request.

Responses

403

Necessary permission scope.

404

Resource not found.

500

Internal Server Error

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