Skip to main content
DELETE
/
v1.1
/
payout
Cancel a payout
curl --request DELETE \
  --url https://api.paymee.com.br/v1.1/payout \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data '
{
  "reason": "Customer requested cancellation",
  "uuid": "83abc908-9233-4b66-b455-2339809886b1"
}
'
{
  "status": 0,
  "message": "success"
}

Documentation Index

Fetch the complete documentation index at: https://developer.paymee.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Body

application/json
​
uuid
string<uuid>
required

Payout's UUID to be canceled

Maximum string length: 36
Example:

"83abc908-9233-4b66-b455-2339809886b1"

​
reason
string

Cancel reason (optional)

Maximum string length: 255
Example:

"Customer requested cancellation"

Response

Payout successfully canceled

​
status
number

Response status code

Example:

0

​
message
string

Response status message

Example:

"success"