Retrieve settlement options

Production

https://api.paypaga.com

GET

/v2/settlements/options

Can be used to get the settlement configuration for the merchant.

Error codes for Retrieve Settlement Options

HTTP status	Error code	Description
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

Responses

🟢200

application/json

Settlement configuration for the merchant.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🔴500InternalError

Response Example

200 - Example 1

{
    "settlement_currency": "USD",
    "reporting_currency": "USD",
    "settlement_cycle": "1w",
    "next_window": {
        "start_at": "2024-08-05T00:00:00Z",
        "end_at": "2024-08-11T23:59:59Z",
        "settles_after": "2024-08-12T12:00:00Z"
    },
    "manual_request_enabled": true
}

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

Search settlements

Retrieve settlement transactions

Retrieve settlement options

Error codes for Retrieve Settlement Options#

Request

Responses

Error codes for Retrieve Settlement Options