PUT
/
v1.1
/
pix-automatic
/
scheduled-payments
/
{instructionId}
/
cancel
Cancel scheduled payment
curl --request PUT \
  --url https://api.paymee.com.br/v1.1/pix-automatic/scheduled-payments/{instructionId}/cancel \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data '{
  "reason": "Customer request."
}'
{
  "status": 0,
  "message": "success"
}

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Path Parameters

​
instructionId
string
required

Instruction ID of the scheduled payment to be canceled.

Body

application/json

Reason for the cancellation.

The body is of type object.

Response

200
application/json

Scheduled payment canceled successfully.

The response is of type object.