Skip to main content
POST
/
v1
/
pix-automatico
/
schedules
Request a Pix Automático schedule send
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dueDate": "<string>",
  "endToEndId": "<string>",
  "idRecorrencia": "<string>",
  "payer": {
    "cpfCnpj": "<string>",
    "ispb": "<string>",
    "personType": 123
  },
  "purpose": 123,
  "recipient": {
    "account": "<string>",
    "accountType": 123,
    "cnpj": "<string>",
    "ispb": "<string>",
    "agency": "<string>"
  },
  "reconciliationId": "<string>",
  "amount": 123,
  "infoBetweenClients": "<string>",
  "recipientReceivedAt": "<string>"
}
'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules"

payload = {
"dueDate": "<string>",
"endToEndId": "<string>",
"idRecorrencia": "<string>",
"payer": {
"cpfCnpj": "<string>",
"ispb": "<string>",
"personType": 123
},
"purpose": 123,
"recipient": {
"account": "<string>",
"accountType": 123,
"cnpj": "<string>",
"ispb": "<string>",
"agency": "<string>"
},
"reconciliationId": "<string>",
"amount": 123,
"infoBetweenClients": "<string>",
"recipientReceivedAt": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dueDate: '<string>',
endToEndId: '<string>',
idRecorrencia: '<string>',
payer: {cpfCnpj: '<string>', ispb: '<string>', personType: 123},
purpose: 123,
recipient: {
account: '<string>',
accountType: 123,
cnpj: '<string>',
ispb: '<string>',
agency: '<string>'
},
reconciliationId: '<string>',
amount: 123,
infoBetweenClients: '<string>',
recipientReceivedAt: '<string>'
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/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://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dueDate' => '<string>',
'endToEndId' => '<string>',
'idRecorrencia' => '<string>',
'payer' => [
'cpfCnpj' => '<string>',
'ispb' => '<string>',
'personType' => 123
],
'purpose' => 123,
'recipient' => [
'account' => '<string>',
'accountType' => 123,
'cnpj' => '<string>',
'ispb' => '<string>',
'agency' => '<string>'
],
'reconciliationId' => '<string>',
'amount' => 123,
'infoBetweenClients' => '<string>',
'recipientReceivedAt' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules"

payload := strings.NewReader("{\n \"dueDate\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"payer\": {\n \"cpfCnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"personType\": 123\n },\n \"purpose\": 123,\n \"recipient\": {\n \"account\": \"<string>\",\n \"accountType\": 123,\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"agency\": \"<string>\"\n },\n \"reconciliationId\": \"<string>\",\n \"amount\": 123,\n \"infoBetweenClients\": \"<string>\",\n \"recipientReceivedAt\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dueDate\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"payer\": {\n \"cpfCnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"personType\": 123\n },\n \"purpose\": 123,\n \"recipient\": {\n \"account\": \"<string>\",\n \"accountType\": 123,\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"agency\": \"<string>\"\n },\n \"reconciliationId\": \"<string>\",\n \"amount\": 123,\n \"infoBetweenClients\": \"<string>\",\n \"recipientReceivedAt\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dueDate\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"payer\": {\n \"cpfCnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"personType\": 123\n },\n \"purpose\": 123,\n \"recipient\": {\n \"account\": \"<string>\",\n \"accountType\": 123,\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"agency\": \"<string>\"\n },\n \"reconciliationId\": \"<string>\",\n \"amount\": 123,\n \"infoBetweenClients\": \"<string>\",\n \"recipientReceivedAt\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "endToEndId": "<string>",
  "idRecorrencia": "<string>",
  "reconciliationId": "<string>",
  "requestedAt": "<string>",
  "status": "<string>"
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Body

application/json
dueDate
string
required

Due date (dtVencimento; aaaa-mm-dd).

endToEndId
string
required

Unique payment-transaction id (32-char natural key).

idRecorrencia
string
required

Recurrence id linking the authorization (29-char, RR...).

payer
object
required
purpose
integer<int64>
required

finalidadeAgendamento (0=first, 1=post-due retry, 2=settlement-error resend).

recipient
object
required
reconciliationId
string
required

Receiver conciliation id (idConciliacaoRecebedor; 26..35-char).

amount
number<double>

Scheduled amount in reais (valor).

debtor
object
infoBetweenClients
string

Free-text receiver-to-payer info (infEntreClientes).

recipientReceivedAt
string

Recipient PSP reception timestamp (dtHrRecepcaoPspRecebedor, UTC; required when purpose=0).

Response

Accepted

endToEndId
string
required

The payment-transaction id (echoed).

idRecorrencia
string
required

The recurrence id (echoed).

reconciliationId
string
required

The receiver conciliation id (echoed).

requestedAt
string
required

Upstream request timestamp (upstream request timestamp, UTC).

status
string
required

The resulting local schedule status.