Settlement Webhook

Receive real-time notifications when settlements are processed — use with Settlement Details API for reconciliation.

Settlement Webhook

Overview

After receiving a SETTLEMENT webhook, merchants can call the Settlement Details API to fetch detailed settlement information, including associated transaction-level details.

This ensures accurate reconciliation between payouts and individual transactions.

Endpoint

Method	URL
GET	`https://api.payorc.com/settlements/v1/details?settlement_id=100001020`

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.

Settlement Details API Response

After the webhook, call Settlement Details. The response includes settlement summary along with transaction-level breakdown.

{
  "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"
}

Flow Integration

Receive SETTLEMENT webhook
Extract payout_id from webhook payload
Call Settlement Details API using settlement_id = payout_id
Fetch settlement summary and transaction list
Perform reconciliation and reporting

Summary: Webhook gives trigger — API gives detailed data. Use both for accurate reconciliation.

Webhook Payload Sample

PayOrc POSTs this payload to your configured settlement webhook URL when a settlement is processed:

{
  "action": "SETTLEMENT",
  "status": "SUCCESS",
  "payout_id": "1000010002",
  "date": "2025-04-15 10:30:00",
  "sales_amount": "AED 2200.29",
  "total_tax": "AED 112.35",
  "settled_amount": "AED 2087.94",
  "sub_merchant_identifier": "Demo"
}

Webhook Payload Fields

Field	Type	Description
action	String	Type of operation performed. For this response, the value will be SETTLEMENT.
status	String	Indicates the status of the settlement (e.g., SUCCESS, FAILED).
payout_id	String	Unique identifier for the settlement payout generated by the system.
date	String	Settlement date and time in YYYY-MM-DD HH:MM:SS format.
sales_amount	String	Total sales amount processed before deductions.
total_tax	String	Total tax amount applied to the transactions.
settled_amount	String	Final amount settled to the merchant after deductions (sales_amount - total_tax - fees if applicable).
sub_merchant_identifier	String	Unique identifier of the sub-merchant associated with the settlement.

Settlement Details — Fetch detailed settlement breakdown
Settlement List — List all settlements
Settlement Account Info — Bank account & balance info

Settlement Webhook

On this page