Skip to main content
POST
Cancel enqueued payout
Cancels a payout that is currently in the ENQUEUED status.
  • The payment will be moved to FAILED status.
  • The payment will have the failure code MANUALLY_CANCELLED.
  • If you have configured callbacks, a callback will be sent.

Authorizations

Authorization
string
header
required

Path Parameters

payoutId
string<uuid>
required

The payoutId of the payout you want cancel.

Required string length: 36

Response

Request has been processed by PawaPay

payoutId
string<uuid>
required

The payoutId of the payout transaction.

Required string length: 36
Example:

"f4401bd2-1568-4140-bf2d-eb77d2b2b639"

status
enum<string>
required

Possible initiation statuses:

  • ACCEPTED - The manual action request has been accepted by PawaPay for processing.
  • REJECTED - The manual action request has been rejected by PawaPay. See rejectionReason for details.
  • FAILED - The manual action request has failed during submitting for processing due to internal reasons.
Available options:
ACCEPTED,
REJECTED,
FAILED
rejectionReason
string

Human-readable explanation why request has been rejected

Example:

"Payout with ID \\#f4401bd2-1568-4140-bf2d-eb77d2b2b639 not found"