Pular para o conteúdo principal
POST
/
v1
/
pix-automatico
/
events
/
schedule-registered
Receber evento de registro de agendamento de Pix Automático
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-registered \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DataHoraEvento: <x-datahoraevento>' \
  --header 'X-NomeEvento: <x-nomeevento>' \
  --data '
{
  "dtVencimento": "<string>",
  "endToEndId": "<string>",
  "finalidadeAgendamento": 123,
  "idConciliacaoRecebedor": "<string>",
  "idRecorrencia": "<string>",
  "pagador": {
    "cpfCnpj": "<string>",
    "ispb": "<string>",
    "tpPessoa": 123
  },
  "recebedor": {
    "cnpj": "<string>",
    "ispb": "<string>",
    "nome": "<string>",
    "nrConta": "<string>",
    "tpConta": 123,
    "nrAgencia": "<string>"
  },
  "stAgendamento": 123,
  "codigoErro": "<string>",
  "descCodigoErro": "<string>",
  "dtHrRecepcaoPspRecebedor": "<string>",
  "infEntreClientes": "<string>",
  "valor": 123
}
'
import requests

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

payload = {
    "dtVencimento": "<string>",
    "endToEndId": "<string>",
    "finalidadeAgendamento": 123,
    "idConciliacaoRecebedor": "<string>",
    "idRecorrencia": "<string>",
    "pagador": {
        "cpfCnpj": "<string>",
        "ispb": "<string>",
        "tpPessoa": 123
    },
    "recebedor": {
        "cnpj": "<string>",
        "ispb": "<string>",
        "nome": "<string>",
        "nrConta": "<string>",
        "tpConta": 123,
        "nrAgencia": "<string>"
    },
    "stAgendamento": 123,
    "codigoErro": "<string>",
    "descCodigoErro": "<string>",
    "dtHrRecepcaoPspRecebedor": "<string>",
    "infEntreClientes": "<string>",
    "valor": 123
}
headers = {
    "X-DataHoraEvento": "<x-datahoraevento>",
    "X-NomeEvento": "<x-nomeevento>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'X-DataHoraEvento': '<x-datahoraevento>',
    'X-NomeEvento': '<x-nomeevento>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    dtVencimento: '<string>',
    endToEndId: '<string>',
    finalidadeAgendamento: 123,
    idConciliacaoRecebedor: '<string>',
    idRecorrencia: '<string>',
    pagador: {cpfCnpj: '<string>', ispb: '<string>', tpPessoa: 123},
    recebedor: {
      cnpj: '<string>',
      ispb: '<string>',
      nome: '<string>',
      nrConta: '<string>',
      tpConta: 123,
      nrAgencia: '<string>'
    },
    stAgendamento: 123,
    codigoErro: '<string>',
    descCodigoErro: '<string>',
    dtHrRecepcaoPspRecebedor: '<string>',
    infEntreClientes: '<string>',
    valor: 123
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-registered', 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/events/schedule-registered",
  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([
    'dtVencimento' => '<string>',
    'endToEndId' => '<string>',
    'finalidadeAgendamento' => 123,
    'idConciliacaoRecebedor' => '<string>',
    'idRecorrencia' => '<string>',
    'pagador' => [
        'cpfCnpj' => '<string>',
        'ispb' => '<string>',
        'tpPessoa' => 123
    ],
    'recebedor' => [
        'cnpj' => '<string>',
        'ispb' => '<string>',
        'nome' => '<string>',
        'nrConta' => '<string>',
        'tpConta' => 123,
        'nrAgencia' => '<string>'
    ],
    'stAgendamento' => 123,
    'codigoErro' => '<string>',
    'descCodigoErro' => '<string>',
    'dtHrRecepcaoPspRecebedor' => '<string>',
    'infEntreClientes' => '<string>',
    'valor' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-DataHoraEvento: <x-datahoraevento>",
    "X-NomeEvento: <x-nomeevento>"
  ],
]);

$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/events/schedule-registered"

	payload := strings.NewReader("{\n  \"dtVencimento\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"finalidadeAgendamento\": 123,\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"idRecorrencia\": \"<string>\",\n  \"pagador\": {\n    \"cpfCnpj\": \"<string>\",\n    \"ispb\": \"<string>\",\n    \"tpPessoa\": 123\n  },\n  \"recebedor\": {\n    \"cnpj\": \"<string>\",\n    \"ispb\": \"<string>\",\n    \"nome\": \"<string>\",\n    \"nrConta\": \"<string>\",\n    \"tpConta\": 123,\n    \"nrAgencia\": \"<string>\"\n  },\n  \"stAgendamento\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\",\n  \"dtHrRecepcaoPspRecebedor\": \"<string>\",\n  \"infEntreClientes\": \"<string>\",\n  \"valor\": 123\n}")

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

	req.Header.Add("X-DataHoraEvento", "<x-datahoraevento>")
	req.Header.Add("X-NomeEvento", "<x-nomeevento>")
	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/events/schedule-registered")
  .header("X-DataHoraEvento", "<x-datahoraevento>")
  .header("X-NomeEvento", "<x-nomeevento>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dtVencimento\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"finalidadeAgendamento\": 123,\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"idRecorrencia\": \"<string>\",\n  \"pagador\": {\n    \"cpfCnpj\": \"<string>\",\n    \"ispb\": \"<string>\",\n    \"tpPessoa\": 123\n  },\n  \"recebedor\": {\n    \"cnpj\": \"<string>\",\n    \"ispb\": \"<string>\",\n    \"nome\": \"<string>\",\n    \"nrConta\": \"<string>\",\n    \"tpConta\": 123,\n    \"nrAgencia\": \"<string>\"\n  },\n  \"stAgendamento\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\",\n  \"dtHrRecepcaoPspRecebedor\": \"<string>\",\n  \"infEntreClientes\": \"<string>\",\n  \"valor\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-DataHoraEvento"] = '<x-datahoraevento>'
request["X-NomeEvento"] = '<x-nomeevento>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dtVencimento\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"finalidadeAgendamento\": 123,\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"idRecorrencia\": \"<string>\",\n  \"pagador\": {\n    \"cpfCnpj\": \"<string>\",\n    \"ispb\": \"<string>\",\n    \"tpPessoa\": 123\n  },\n  \"recebedor\": {\n    \"cnpj\": \"<string>\",\n    \"ispb\": \"<string>\",\n    \"nome\": \"<string>\",\n    \"nrConta\": \"<string>\",\n    \"tpConta\": 123,\n    \"nrAgencia\": \"<string>\"\n  },\n  \"stAgendamento\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\",\n  \"dtHrRecepcaoPspRecebedor\": \"<string>\",\n  \"infEntreClientes\": \"<string>\",\n  \"valor\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "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).

Cabeçalhos

​
Authorization
string

Token de acesso Bearer (o portão de entrada financeira; o handler falha de forma fechada com Pix-0082 quando ausente).

​
X-DataHoraEvento
string
obrigatório

Instante de registro do evento (UTC: aaaa-mm-ddTHH:mm:ss.sssZ). Obrigatório conforme

​
X-NomeEvento
string
obrigatório

Nome do evento. Obrigatório conforme; passthrough informativo.

Corpo

application/json
​
dtVencimento
string
obrigatório

Data de vencimento da cobrança recorrente (aaaa-mm-dd).

​
endToEndId
string
obrigatório

Id único de instrução de pagamento (32 caracteres).

​
finalidadeAgendamento
integer<int64>
obrigatório

Finalidade do agendamento (0=primeiro, 1=retentativa pós-vencimento, 2=reenvio de liquidação).

​
idConciliacaoRecebedor
string
obrigatório

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

​
idRecorrencia
string
obrigatório

Id único de recorrência (29 caracteres, RR...).

​
pagador
object
obrigatório
​
recebedor
object
obrigatório
​
stAgendamento
integer<int64>
obrigatório

Status do agendamento (0=Aceito, 1=Rejeitado).

​
codigoErro
string

Código de erro do upstream (100 caracteres; em uma rejeição).

​
descCodigoErro
string

Descrição de erro do upstream (1000 caracteres).

​
devedor
object
​
dtHrRecepcaoPspRecebedor
string

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

​
infEntreClientes
string

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

​
valor
number<double>

Valor de pagamento recorrente em reais (um número JSON).

Resposta

Sem Conteúdo