Get Settlement Details

Drill into a settlement batch (or filter by any transaction attribute) to get the per-transaction reconciliation view, including TDR / GST breakdown and amount actually credited.

note

This API only reports successful transactions. Failed transactions have no settlement record — use Payment Status for those.

Endpoint

POST https://pgbiz.omniware.in/v2/getsettlementdetails
Content-Type: application/x-www-form-urlencoded

Request parameters

All filters are optional — pass any combination to scope the result. At minimum supply settlement_id or a date range to keep the result set small.

api_keystring (36)required

settlement_idnumber (20)

The settlement batch to pull line items for. From Get Settlements.

order_idstring (30)

Filter by your merchant reference.

transaction_idstring (30)

Filter by Omniware transaction ID.

bank_codestring (4)

4-letter bank code signifying payment mode/channel. See Bank codes.

customer_phonestring (30)

customer_emailstring (255)

customer_namestring (255)

date_fromstring (10)

DD-MM-YYYY.

date_tostring (10)

DD-MM-YYYY.

completedstring (1)

y / n.

hashstring (255)required

Response

{
  "data": [
    {
      "transaction_id": "HDMASC2746901262",
      "order_id": "225495",
      "settlement_id": 27837,
      "bank_reference": "710061536126",
      "settlement_datetime": null,
      "customer_name": "Tester",
      "customer_email": "tester@example.com",
      "customer_phone": "8050603774",
      "completed": "y",
      "description": "Settlement for Rs. 2.06 paid through transaction ID HDMASC2746901262 on 201709-28 13:36:19 for merchant hotel booking",
      "gross_transaction_amount": "2.06",
      "payment_mode": "Credit Card",
      "payment_channel": "Master",
      "applicable_tdr_percent": "3.00",
      "applicable_tdr_fixed_fee": "0.00",
      "percent_tdr_paid_by_merchant": "0",
      "tdr_amount": "0.06",
      "tax_on_tdr_amount": "0.00",
      "amount_reimbursed": "2.00"
    }
  ],
  "hash": "D2EFF4776D973DA46563DA0F80139B84AFED77C58496A34DD0D653272A0EE1E5D09F4C94AD4394512B16341A5A44906B4B10FF5B6AA1F03DE98A164B39881C4E"
}

Field reference

Field	Description
transaction_id	Omniware transaction ID.
order_id	Your merchant reference.
settlement_id	The batch this transaction was settled in.
bank_reference	UTR of the bank transfer for the batch.
settlement_datetime	When the batch reached the bank.
gross_transaction_amount	What the customer paid.
payment_mode / payment_channel	e.g. Credit Card / Visa.
applicable_tdr_percent	TDR rate applied.
applicable_tdr_fixed_fee	Flat fee component, if any.
percent_tdr_paid_by_merchant	100 if the merchant absorbs the full TDR; 0 if fully passed to the customer.
tdr_amount / tax_on_tdr_amount	TDR + GST charged on this transaction.
amount_reimbursed	What landed in your bank account for this transaction.

Errors

{
  "error": {
    "code": 404,
    "message": "No record found"
  }
}

tip

Reconcile amount_reimbursed summed by settlement_id against payout_amount from Get Settlements. They should match to the paisa.