List Schedules

curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "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"
    }
  }
]

GET

automatic-pix

schedules

List Schedules

curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v2/automatic-pix/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "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

array

List of schedules

Show schedule object

integer

Unique identifier for this specific schedule. Each billing cycle generates a new schedule with its own ID — do not assume this ID is stable across cycles.

merchant_id

integer

Merchant ID

authorization

object

Authorization

Show authorization properties

integer

Authorization ID

name

string

Authorization Name

amount

number

Amount

due_date

string

Due Date

settlement_date

string or null

Settlement Date

status

object

Status

Show status properties

integer

Status ID

name

string

Status Name

history

array or null

History

Show history items

integer

History ID

schedule_id

integer

ID of the schedule this history entry belongs to. Matches the parent schedule id — each billing cycle has its own unique schedule ID.

status_id

integer

Status ID

status_name

string

Status Name

created_at

string

Date

tx_id

string or null

Transaction ID

attempts

array

Attempts

Show attempt items

integer

Attempt ID

status

string

Status

end_to_end_id

string

End To End ID

attempt_date

string

Date

created_at

string

Creation Date

buyer

object

Buyer

Show buyer properties

integer

Buyer ID

name

string

Buyer Name

document

string

Buyer Document

[
  {
    "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"
    }
  }
]

Cancel Authorization Get Schedule

Account

Banks

Payin

Payout

KYC

Markup

List Schedules

Response

​Response

Response