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

Documentation Index

Fetch the complete documentation index at: https://docs.wepayout.co/llms.txt

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

Each schedule is tied to a specific authorization. The only field that can be updated on an existing schedule is amount. If you need to change any other detail — such as the due date or the payer — you must cancel the schedule and generate a new one.

​
Path Parameters

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

​
Request Body

​
amount
number
required
The new amount for the schedule. Must be greater than 0.

​
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": 150.00,
  "due_date": "2023-01-01",
  "settlement_date": null,
  "status": {
    "id": 1,
    "name": "PENDING"
  },
  "history": [
    {
      "id": 1,
      "schedule_id": 1,
      "status_id": 1,
      "status_name": "PENDING",
      "created_at": "2023-01-01T00:00:00Z"
    }
  ],
  "tx_id": null,
  "attempts": [],
  "created_at": "2023-01-01T00:00:00Z",
  "buyer": {
    "id": 1,
    "name": "Buyer Name",
    "document": "12345678900"
  }
}