Pular para o conteúdo principal
POST
/
v1
/
pix-automatico
/
schedules
Solicitar envio de agendamento de Pix Automático
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"
}

Autorizações

​
Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Corpo

application/json
​
dueDate
string
obrigatório

Data de vencimento (dtVencimento; aaaa-mm-dd).

​
endToEndId
string
obrigatório

Id único de transação de pagamento (chave natural de 32 caracteres).

​
idRecorrencia
string
obrigatório

Id da recorrência vinculando a autorização (29 caracteres, RR...).

​
payer
object
obrigatório
​
purpose
integer<int64>
obrigatório

finalidadeAgendamento (0=primeiro, 1=retentativa pós-vencimento, 2=reenvio por erro de liquidação).

​
recipient
object
obrigatório
​
reconciliationId
string
obrigatório

Id de conciliação do recebedor (idConciliacaoRecebedor; 26..35 caracteres).

​
amount
number<double>

Valor agendado em reais (valor).

​
debtor
object
​
infoBetweenClients
string

Informação em texto livre do recebedor para o pagador (infEntreClientes).

​
recipientReceivedAt
string

Data/hora de recepção do PSP recebedor (dtHrRecepcaoPspRecebedor, UTC; obrigatório quando purpose=0).

Resposta

Aceito

​
endToEndId
string
obrigatório

O id da transação de pagamento (ecoado).

​
idRecorrencia
string
obrigatório

O id da recorrência (ecoado).

​
reconciliationId
string
obrigatório

O id de conciliação do recebedor (ecoado).

​
requestedAt
string
obrigatório

Data/hora da requisição upstream (upstream request timestamp, UTC).

​
status
string
obrigatório

O status local resultante do agendamento.