Settlement
Settlement Due Transactions
Fetch transactions that are due for settlement — cleared and awaiting payout.
Settlement Due Transactions
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/due/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) |
Request
curl -X GET "https://api.payorc.com/settlements/v1/due/list" \
-H "merchant-key: live-XXXXXXXXXX" \
-H "merchant-secret: sec-XXXXXXXXXX"Response (200)
{
"data": [
{
"txn_date": "13-04-2025",
"payorc_order_id": "1000010430",
"psp_txn_id": "030036755200",
"amount": "AED 1200.00",
"channel": "HOSTED",
"email": "[email protected]",
"status": "due"
}
],
"message": "Success",
"status": "success",
"code": "00"
}The amount field is returned as a currency-prefixed string (e.g. AED 1200.00). There is no separate currency field. txn_date uses DD-MM-YYYY.
Response Fields
| Field | Type | Description |
|---|---|---|
| data | Array | Array containing individual transaction details |
| data[].txn_date | String | Date of the transaction (DD-MM-YYYY) |
| data[].payorc_order_id | String | Order ID from PayOrc |
| data[].psp_txn_id | String | PSP transaction ID |
| data[].amount | String | Total amount of the transaction, currency-prefixed (e.g. AED 1200.00) |
| data[].channel | String | Payment processing channel |
| data[].email | String | Email associated with the transaction |
| data[].status | String | Status of the transaction (due) |
| message | String | Response message |
| status | String | Response status |
| code | String | Response code |
Related Pages
- Settlement Details — Fetch detailed settlement breakdown
- Settlement Pending — Pending transactions
- Settlement List — List all settlements