Get Settlement

Retrieve details of a specific settlement.

GEThttps://api.zenpayz.com/merchant/api/v1/settlements/{id}

Bearer · API key

Request

Path Parameters

Parameter	Type	Description
id REQUIRED	string	Settlement ID

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

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

Response Fields

Parameter	Type	Description
settlementId OPTIONAL	string	Unique settlement identifier
merchantId OPTIONAL	string	Merchant identifier
amount OPTIONAL	number	Requested settlement amount
settlementFee OPTIONAL	number	Fee charged for the settlement
netAmount OPTIONAL	number	Amount after fees
currency OPTIONAL	string	ISO 4217 currency code
type OPTIONAL	string	Settlement type
priority OPTIONAL	string	Settlement priority
status OPTIONAL	string	Settlement status
description OPTIONAL	string	Settlement description
bankAccountId OPTIONAL	string	Target bank account
scheduledDate OPTIONAL	string	Scheduled settlement date, if any
createdAt OPTIONAL	string	ISO 8601 creation timestamp

Examples

cURL

curl -X GET "https://api.zenpayz.com/merchant/api/v1/settlements/stl_xxxxx" \
  -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 settlement = await zenpays.settlements.get('stl_xxxxx');