Get All Settlements

get

https://pluraluat.v2.pinepg.in/api/settlements/v1/list

Use this API to fetch all the settlements against your account.

Environment

Use our UAT environment endpoint for testing and for integration utilize our production endpoint.

Environment	Endpoints
User Acceptance Testing [UAT]	`https://pluraluat.v2.pinepg.in//api/settlements/v1/list`
Production [PROD]	`https://api.pluralpay.in/api/settlements/v1/list`

📘
Note:

Date Range: Maximum date range for retrieving settlement data is 60 days.

Page Size: API supports a maximum of 10 records per page, one page at a time.

Query Params

start_date

string

required

The start date after which the details should be returned.

Example: 2024-10-01T00:00:00

end_date

string

required

The end date before which details should be returned.

Example: 2024-10-09T23:59:59

page

string

Enter the specific page of the data that should be retrieved and displayed..

Example: 1

per_page

string

The list of settlement transactions to be displayed on each page.

Example: 10

Note: By default, the transaction list displays 10 transactions per page.

Headers

Content-Type

string

The type of content included in the HTTP message body.

Possible value: application/json.

Authorization

string

required

The HTTP header where you can include your secret token for authentication.

Example: Bearer <access_token>

Note: Use the access token generated using our Generate Token API.

Request-Timestamp

string

Use ISO 8601 UTC Timestamp, to create a timestamp when the generate token is requested.

Example: 2024-07-09T07:57:08.022Z

Request-ID

string

Use a global unique identifier [GUID] for the request.

Minimum: 1 characters.
Maximum: 50 characters

Example: c17ce30f-f88e-4f81-ada1-c3b4909ed235

Responses

Environment

📘Note:

200200

400400

401401

500500

📘
Note: