Log in to see full request history

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

Request:

FieldTypeDescription
idIntegerUnique identifier for payout

Example request

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

Response:

FieldTypeDescription
statusBooleanStates if request was successfully executed or not
codeIntegerInternal code, success if 200
msgStringA description of the status of the request
dataJSON

Example response

{ "status": true, "code": 200, "msg": "Payout has been cancelled", "data": {} }
Path Params
string
required
Body Params
string
required

Payout identifier

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json