Skip to main content

POST /settlements/pay

Endpoint

POST /api/v1/settlements/pay

Authentication

HeaderRequired
x-api-keyYes

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

HTTPCodeMeaning
404BATCH_NOT_FOUNDInvalid batch ID
409BATCH_ALREADY_PAIDBatch already in final sent state
502PAYOUT_FAILEDUpstream payout provider failed

Side effects

  • batch status updated (pending -> sent or failed)
  • linked transaction settlement statuses set to paid on success