GET /settlements
Endpoint
GET /api/v1/settlements
Authentication
| Header | Required |
|---|---|
x-api-key | Yes |
Success response
{
"items": [
{
"id": "0fbb6b17-8d2d-438e-87e7-2f9f427f5e3f",
"partnerId": "ECHEZONA001",
"clientId": "AIRPEACE001",
"currency": "USD",
"transactionIds": ["CLVTX_1739378102312_420"],
"totalGross": 750,
"totalProcessorFees": 24.75,
"totalPlatformFees": 9,
"totalNet": 716.25,
"status": "pending",
"mercuryTransferId": null,
"wiseTransferId": null,
"createdAt": "2026-03-05T15:30:01.100Z"
}
]
}
Notes
- Use this endpoint for payout reconciliation and settlement reporting.
statusindicates payout state for each batch.