Skip to main content
GET
/
pg
/
settlements
List Settlements
curl --request GET \
  --url https://api-staging.eximpe.com/pg/settlements \
  --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_cents": 8600,
    "settlement_amount_cents": 100000,
    "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
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://eximpe.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Client-ID
string
header
required

Client app ID. You can find your app id in the merchant dashboard.

​
X-Client-Secret
string
header
required

Client secret key. You can find your secret in the merchant dashboard.

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[]