Skip to main content
DELETE
https://api.sandbox.wepayout.com.br
/
v2
/
automatic-pix
/
schedules
/
{id}
Cancel Schedule
curl --request DELETE \
  --url https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 1,
  "merchant_id": 1,
  "authorization": {
    "id": 1,
    "name": "Authorization Name"
  },
  "amount": 100.00,
  "due_date": "2023-01-01",
  "settlement_date": null,
  "status": {
    "id": 2,
    "name": "CANCELED"
  },
  "history": [
    {
      "id": 1,
      "schedule_id": 1,
      "status_id": 1,
      "status_name": "PENDING",
      "created_at": "2023-01-01T00:00:00Z"
    },
    {
      "id": 2,
      "schedule_id": 1,
      "status_id": 2,
      "status_name": "CANCELED",
      "created_at": "2023-01-02T00:00:00Z"
    }
  ],
  "tx_id": null,
  "attempts": [],
  "created_at": "2023-01-01T00:00:00Z",
  "buyer": {
    "id": 1,
    "name": "Buyer Name",
    "document": "12345678900"
  }
}

​
Path Parameters

​
id
integer
required
The ID of the schedule to cancel.

​
Response

​
id
integer
Schedule ID
​
merchant_id
integer
Merchant ID
​
authorization
object
Authorization
​
amount
number
Amount
​
due_date
string
Due Date
​
settlement_date
string or null
Settlement Date
​
status
object
Status
​
history
array or null
History
​
tx_id
string or null
Transaction ID
​
attempts
array
Attempts
​
created_at
string
Creation Date
​
buyer
object
Buyer
{
  "id": 1,
  "merchant_id": 1,
  "authorization": {
    "id": 1,
    "name": "Authorization Name"
  },
  "amount": 100.00,
  "due_date": "2023-01-01",
  "settlement_date": null,
  "status": {
    "id": 2,
    "name": "CANCELED"
  },
  "history": [
    {
      "id": 1,
      "schedule_id": 1,
      "status_id": 1,
      "status_name": "PENDING",
      "created_at": "2023-01-01T00:00:00Z"
    },
    {
      "id": 2,
      "schedule_id": 1,
      "status_id": 2,
      "status_name": "CANCELED",
      "created_at": "2023-01-02T00:00:00Z"
    }
  ],
  "tx_id": null,
  "attempts": [],
  "created_at": "2023-01-01T00:00:00Z",
  "buyer": {
    "id": 1,
    "name": "Buyer Name",
    "document": "12345678900"
  }
}