API Docs
Payouts
API ReferencePayoutsCancel

Cancel Payout

Cancel a payout that has not yet been fulfilled.

POST /payouts/:payout_id/cancel

Path Parameters

ParameterTypeDescription
payout_idstringRequired. The ID of the payout to cancel.

Request Example

curl -X POST 'https://api.v2.paychtec.com/payouts/po_1234567890abcdef/cancel' \  -H "api-key: snd_YOUR_API_KEY"

Response

{
  "payout_id": "po_1234567890abcdef",
  "status": "cancelled",
  "modified_at": "2024-01-22T12:00:00Z"
}