Cancel Payout

Endpoint to cancel a payout; only payouts with "pending" status can be cancelled.

Request:

Field	Type	Description
id	Integer	Unique identifier for payout

Example request

cURL

curl --location 'https://api.vendy.money/payout/cancel-payout' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
        "id": 5
}'

Response:

Field	Type	Description
status	Boolean	States if request was successfully executed or not
code	Integer	Internal code, success if 200
msg	String	A description of the status of the request
data	JSON

Example response

JSON

{
  "status": true,
  "code": 200,
  "msg": "Payout has been cancelled",
  "data": {}
}