POST
/
payouts
/
fail-enqueued
/
{payoutId}
curl --request POST \
  --url https://api.sandbox.pawapay.io/payouts/fail-enqueued/{payoutId} \
  --header 'Authorization: Bearer <token>'
{
  "payoutId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
  "status": "ACCEPTED"
}

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

See Authentication.

Path Parameters

​
payoutId
string
required

The payoutId of the payout you want cancel.

Required string length: 36

Response

200
application/json
Request has been processed by pawaPay
​
payoutId
string
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"

Was this page helpful?