POST /settlements/pay
Endpoint
POST /api/v1/settlements/pay
Authentication
| Header | Required |
|---|---|
x-api-key | Yes |
Request body
{
"settlement_batch_id": "0fbb6b17-8d2d-438e-87e7-2f9f427f5e3f"
}
Payout rail selection
GBP,EUR,USD-> Wise payout flow- other currencies -> Mercury payout flow
Success response
{
"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": "sent",
"wiseTransferId": "91827364",
"createdAt": "2026-03-05T15:30:01.100Z"
}
Common errors
| HTTP | Code | Meaning |
|---|---|---|
404 | BATCH_NOT_FOUND | Invalid batch ID |
409 | BATCH_ALREADY_PAID | Batch already in final sent state |
502 | PAYOUT_FAILED | Upstream payout provider failed |
Side effects
- batch status updated (
pending->sentorfailed) - linked transaction settlement statuses set to
paidon success