Skip to main content
GET
/
pg
/
settlements
List Settlements
curl --request GET \
  --url https://api-pacb-uat.eximpe.com/pg/settlements/ \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'
{
  "success": true,
  "message": "Settlements fetched successfully",
  "data": {
    "settlement_id": "ST4353980017",
    "utr_number": "092dc30a-4f19-4318-9798-ad08b48801f6",
    "settlement_completed_date": "2025-06-20T08:06:59.293548Z",
    "forex_rate": 86,
    "settlement_amount": 1000,
    "settlement_currency": "USD",
    "transactions": [
      {
        "settlement_type": "capture",
        "transaction_id": "PR3828502708",
        "transaction_amount": 1000,
        "merchant_service_fee": 0,
        "merchant_service_tax": 0,
        "merchant_net_amount": 1000,
        "mop_type": "upi",
        "transaction_currency": "INR",
        "forex_rate": 86
      }
    ]
  }
}

Authorizations

​
X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

​
X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

​
X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X' or '2.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Query Parameters

​
from_date
string<date>

Filter settlements from this date. Format: YYYY-MM-DD.

​
to_date
string<date>

Filter settlements up to this date. Format: YYYY-MM-DD.

Response

200 - application/json

A paginated list of settlements.

​
count
integer
​
page
integer
​
page_size
integer
​
next
string<uri> | null
​
previous
string<uri> | null
​
results
object[]