Settlement Details

Fetch detailed settlement breakdown including transaction-level details for reconciliation.

Settlement Details

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/details?settlement_id=id`

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

Field	Type	Required	Description
settlement_id	String	Yes	The settlement/payout ID to fetch details for. Returns `Settlement ID is required` if omitted and `Invalid Settlement ID` if not found.

This endpoint returns the full transaction list for the settlement. Pagination parameters are not currently applied.

Request

curl -X GET "https://api.payorc.com/settlements/v1/details?settlement_id=100001020" \
  -H "merchant-key: live-XXXXXXXXXX" \
  -H "merchant-secret: sec-XXXXXXXXXX"

Response (200)

{
  "data": {
    "submerchant_name": "Demo",
    "date": "15-04-2025",
    "payout_id": "1000010002",
    "sales_amount": "AED 2200.29",
    "total_tax": "AED 112.35",
    "settled_amount": "AED 2087.94",
    "status": "Settled",
    "transaction": [
      {
        "txn_date": "06-04-2025 17:33:14",
        "settlement_id": "1000010002",
        "payorc_order_id": "1000010445",
        "psp_ref_no": "030036755660",
        "settled_amount": "AED 2095.00",
        "mdr": "AED 84.80",
        "fee": "AED 0.00",
        "tax": "AED 4.24",
        "net_amount": "AED 2005.96",
        "settlement_date": "07-05-2025",
        "channel": "HOSTED",
        "email": "[email protected]",
        "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 (with HH:mm:ss for txn_date).

Response Fields — Settlement Summary

Field	Type	Description
submerchant_name	String	Name of the submerchant
date	String	Date of payout statement (`DD-MM-YYYY`)
payout_id	String	ID of the payout
sales_amount	String	Total sales amount, currency-prefixed (e.g. `AED 2200.29`)
total_tax	String	Total tax amount, currency-prefixed
settled_amount	String	Settled amount after deductions, currency-prefixed
status	String	Settled status
transaction	Array	List of transaction details

Response Fields — Transaction Details

Field	Type	Description
txn_date	String	Transaction date and time (`DD-MM-YYYY HH:mm:ss`)
settlement_id	String	Settlement/payout ID this transaction belongs to
payorc_order_id	String	Order ID from PayOrc
psp_ref_no	String	PSP reference number
settled_amount	String	Settled amount for transaction, currency-prefixed
mdr	String	MDR fee deducted for the transaction, currency-prefixed
fee	String	Additional fee charged, currency-prefixed
tax	String	Tax deducted for the transaction, currency-prefixed
net_amount	String	Net amount after deductions, currency-prefixed
settlement_date	String	Date of settlement (`DD-MM-YYYY`)
channel	String	Channel through which payment was processed
email	String	Email associated with transaction
status	String	Status of the transaction

Settlement List — List all settlements
Settlement Pending — Pending transactions
Settlement Due — Due transactions
Settlement Account Info — Bank account & balance info

Settlement Details

On this page