Settlement List

Generate an API Key for Payment Link channel: Navigate to Developers → API Keys → Add new API key → Select HOSTED in the Channel Dropdown.

Endpoint

Method	URL
GET	`https://api.payorc.com/settlements/v1/list`

Settlement APIs are available in live mode only. Requests made with test/sandbox credentials return Settlement is not available for test mode. Use your live merchant-key and merchant-secret.

Headers

Field	Type	Description
merchant-key	String	Your merchant key (e.g. live-D111PIS13YK)
merchant-secret	String	Your merchant secret (e.g. sec-JI11G0P13Z0)

Query Parameters

This endpoint returns all settled settlements for your account. Pagination parameters are not currently applied.

Request

curl -X GET "https://api.payorc.com/settlements/v1/list?perpage=10&page=1" \
  -H "merchant-key: live-XXXXXXXXXX" \
  -H "merchant-secret: sec-XXXXXXXXXX"

Response (200)

{
  "data": [
    {
      "submerchant_name": "Demo",
      "settlement_date": "15-04-2025",
      "settlement_id": "1000010002",
      "sales_amount": "AED 2200.29",
      "total_tax": "AED 112.35",
      "settled_amount": "AED 2087.94",
      "status": "Settled"
    }
  ],
  "message": "Success",
  "status": "success",
  "code": "00"
}

Amount fields are returned as currency-prefixed strings (e.g. AED 2200.29). There is no separate currency field. Dates use DD-MM-YYYY.

Response Fields

Field	Type	Description
data	Array	Array containing individual settlement details
data[].submerchant_name	String	Name of the submerchant
data[].settlement_date	String	Date of the settlement (`DD-MM-YYYY`)
data[].settlement_id	String	ID of the settlement (payout ID)
data[].sales_amount	String	Total sales amount, currency-prefixed (e.g. `AED 2200.29`)
data[].total_tax	String	Total tax amount, currency-prefixed
data[].settled_amount	String	Settled amount after deductions, currency-prefixed
data[].status	String	Settlement status (`Settled`)
message	String	Response message
status	String	Response status
code	String	Response code

Settlement Details — Fetch detailed settlement breakdown
Settlement Pending — Pending transactions
Settlement Due — Due transactions

Settlement List

On this page