Skip to main content
GET
/
v2
/
automatic-pix
/
schedules
List Schedules
curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules \
  --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": 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"
    }
  }
]
Schedules are created one at a time. When an authorization is confirmed, only the first upcoming schedule is generated. The next one is created automatically once the current schedule is paid or processed — not all future installments are pre-created upfront.This means that at any given time, you will typically see one active schedule per authorization. Additional schedules will appear in this list as their payment dates approach.

Response

Response
array
List of schedules
[
  {
    "id": 1,
    "merchant_id": 1,
    "authorization": {
      "id": 1,
      "name": "Authorization Name"
    },
    "amount": 100.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"
    }
  }
]