Search settlements

Production

https://api.paypaga.com

GET

/v2/settlements

Retrieve a paginated list of settlements processed for the merchant in descending order. Filters can be applied to narrow down the results by settlement ID and date range.

Error codes for Search Settlements

HTTP status	Error code	Description
400	VALIDATION_ERROR	Request validation failed
401	UNAUTHORIZED	Missing or invalid authorization token
500	INTERNAL_ERROR	Unexpected server error

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://api.paypaga.com/oauth2/token

Query Params

Responses

🟢200

application/json

Paginated settlement list.

Bodyapplication/json

🟠400ValidationError

🟠401Unauthorized

🟠403Forbidden

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.paypaga.com/v2/settlements?settlement_id=undefined&date_from=undefined&date_to=undefined&page=undefined&page_size=undefined'

Response Example

200 - Example 1

{
    "items": [
        {
            "settlement_id": "settlement-2024-08-01",
            "created_on": "2024-08-01T10:00:00Z",
            "settled_on": "2024-08-02T14:30:00Z",
            "status": "pending",
            "total_amount": 150000,
            "currency": "BRL"
        }
    ],
    "meta": {
        "page": 1,
        "page_size": 25,
        "total_items": 200
    }
}

Modified at 2026-06-09 15:16:31

List supported payment methods

Retrieve settlement options

Search settlements

Error codes for Search Settlements#

Request

Responses

Error codes for Search Settlements