List Settlements

Retrieve a paginated list of settlements.

GEThttps://api.zenpayz.com/merchant/api/v1/settlements/list

Bearer · API key

Request

Headers

Header	Description
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

Query Parameters

Parameter	Type	Description
page OPTIONAL	integer1	Page number
limit OPTIONAL	integer20	Items per page
startDate OPTIONAL	string-	Start date filter (ISO 8601)
endDate OPTIONAL	string-	End date filter (ISO 8601)
status OPTIONAL	string-	Filter by status (PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED)
type OPTIONAL	string-	Filter by settlement type
priority OPTIONAL	string-	Filter by priority
bankAccountId OPTIONAL	string-	Filter by bank account
minAmount OPTIONAL	number-	Minimum settlement amount
maxAmount OPTIONAL	number-	Maximum settlement amount

Response

Success (200 OK)

{
  "success": true,
  "data": [
    {
      "settlementId": "stl_xxxxx",
      "merchantId": "mer_xxxxx",
      "amount": 100000,
      "settlementFee": 500,
      "netAmount": 99500,
      "currency": "USD",
      "type": "standard",
      "priority": "normal",
      "status": "COMPLETED",
      "description": "Monthly settlement",
      "bankAccountId": "ba_xxxxx",
      "scheduledDate": null,
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3
  }
}

Examples

cURL

curl -X GET "https://api.zenpayz.com/merchant/api/v1/settlements/list?status=COMPLETED&minAmount=50000" \
  -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"

SDK

const { data } = await zenpays.settlements.list({
  status: 'COMPLETED',
  minAmount: 50000,
});