Get Settlement

Retrieve the details of a specific settlement by its ID.

GET /pg/settlements/{settlement_id}

Try it

Get Settlement

cURL

curl --request GET \
  --url https://api-staging.eximpe.com/pg/settlements/{settlement_id} \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'

200

{
  "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
      }
    ]
  }
}

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.

Path Parameters

settlement_id · string · required

The ID of the settlement to retrieve.

Response

200

application/json

The details of the settlement.

success · boolean

message · string

data · object

Show child attributes

data. settlement_id · string

Unique identifier for the settlement.

data. utr_number · string

UTR (Unique Transaction Reference) number for the settlement.

data. settlement_completed_date · string<date-time>

The timestamp of when the settlement was completed.

data. forex_rate_cents · integer

Forex rate in cents (e.g., 8600 represents 86.00).

data. settlement_amount_cents · integer

Settlement amount in cents (e.g., 100000 represents 1000.00).

data. settlement_currency · string

Currency code for the settlement amount.

data. transactions · object[]

Show child attributes

data.transactions. settlement_type · string

Type of settlement transaction (e.g., capture, refund)

data.transactions. transaction_id · string

Unique identifier for the transaction

data.transactions. transaction_amount · number<float>

Transaction amount

data.transactions. merchant_service_fee · number<float>

Merchant service fee

data.transactions. merchant_service_tax · number<float>

Merchant service tax

data.transactions. merchant_net_amount · number<float>

Net amount for merchant

data.transactions. mop_type · enum<string>

Method of payment type

Available options: UPI, CREDIT_CARD, DEBIT_CARD, NET_BANKING, QR

data.transactions. transaction_currency · string

Currency of the transaction

data.transactions. forex_rate · number<float>

Forex rate applied to the transaction