Skip to main content
View as Markdown

Settlement Statistics

Get settlement statistics and summary.

GEThttps://api.zenpayz.com/merchant/api/v1/settlements/stats/summary
Bearer · API key

Request​

Headers​

HeaderDescription
Authorization
REQUIRED		Bearer {api_key}
X-Signature
REQUIRED		HMAC-SHA256 signature
X-Timestamp
REQUIRED		ISO 8601 timestamp
X-Secret-Salt
REQUIRED		Secret salt for HMAC validation

Response​

Success (200 OK)​

{
  "success": true,
  "data": {
    "totalSettlements": 150,
    "totalSettled": 5000000,
    "pendingAmount": 250000,
    "byStatus": {
      "COMPLETED": 140,
      "PENDING": 8,
      "PROCESSING": 2,
      "FAILED": 0,
      "CANCELLED": 0
    },
    "averageSettlementTime": "1.5 days",
    "lastSettlement": {
      "settlementId": "stl_xxxxx",
      "amount": 100000,
      "status": "COMPLETED",
      "createdAt": "2024-01-17T10:00:00.000Z"
    }
  }
}

Examples​

curl -X GET "https://api.zenpayz.com/merchant/api/v1/settlements/stats/summary" \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt"