Get Settlements

A settlement batch is one bank transfer from Omniware's nodal account to yours, covering many individual transactions. This API returns the batches; Get Settlement Details returns the transactions inside one.

note

This API only reports successful transactions — by definition, a failed transaction has no settlement. Use Payment Status to investigate failures.

Endpoint

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

Request parameters

api_keystring (36)required

bank_referencestring (100)

The bank reference number of the actual NEFT/IMPS/RTGS transaction performed by Omniware to your current account. Useful if you want to look up a specific settlement by its bank UTR.

date_fromstring (10)

Start date of the settlement range. Format: DD-MM-YYYY.

date_tostring (10)

End date of the settlement range. Format: DD-MM-YYYY.

completedstring (1)

y or n — filter by whether the settlement has been completed.

settlement_idnumber (20)

The unique numeric settlement ID assigned to a single settlement.

hashstring (255)required

Response

{
  "data": [
    {
      "settlement_id": 10075,
      "bank_reference": "710061536126",
      "payout_amount": "2.06",
      "completed": "y",
      "account_name": "Tester Sharma",
      "account_number": "50100012341231",
      "ifsc_code": "HDFC0000002",
      "bank_name": "HDFC BANK",
      "bank_branch": "CMH RD, INDIRA NAGAR BRANCH",
      "settlement_datetime": "2017-02-20 16:31:28",
      "sale_amount": "3.00",
      "chargeback_amount": "0.00",
      "refund_amount": "0.00"
    }
  ],
  "hash": "684CDA22F7A429D68281444A8F6809A5FEFEA7A055258984E129554AC359C956E58E36B67A4EB9F9481E616888E722DDB95A81EFBED4416B24F19E3126077F5E"
}

Field	Description
settlement_id	Aggregated settlement ID.
bank_reference	Bank UTR / reference number. Blank if not yet settled.
payout_amount	Net amount credited to your bank account.
completed	y once funds have actually been disbursed.
account_name / account_number / ifsc_code / bank_name / bank_branch	Your settlement bank account.
settlement_datetime	When the settlement was processed.
sale_amount	Gross of all transactions in this batch.
chargeback_amount	Deducted for chargeback adjustments.
refund_amount	Deducted for refund adjustments.

payout_amount = sale_amount − chargeback_amount − refund_amount − tdr − tax_on_tdr.

Errors

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

tip

If the API returns no data, Omniware hasn't yet calculated settlements for your filter — settlement calculation runs after 12:30 AM IST. Try again after that window. If bank_reference is empty on a returned record, the amount is queued but not yet wired.

Use the settlement_id against Get Settlement Details to drill into the line items.