Cancel Payout

Cancel a payout that hasn't been processed yet.

POSThttps://api.uprails.com/payouts/:payout_id/cancel

Cancels a payout that is still in a cancellable state. Once a payout has been processed or completed, it cannot be cancelled.

Cancellation Window

Payouts can only be cancelled while in requires_creation,requires_fulfillment, or pending status.

Path Parameters

Parameter	Type	Description
`payout_id`	string	Required. The ID of the payout to cancel.

Request Example

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

Response

200OK

{
  "payout_id": "po_1234567890abcdef",
  "merchant_id": "mer_xyz789",
  "status": "cancelled",
  "amount": 10000,
  "currency": "USD",
  "created": "2024-01-15T10:00:00Z"
}

Cancellable States

A payout can be cancelled when in these states:

requires_creation - Not yet sent to processor
requires_fulfillment - Awaiting fulfillment confirmation
pending - Being processed (may not be cancellable depending on processor)