Recibir un evento de estado de programación de Pix Automático

curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DataHoraEvento: <x-datahoraevento>' \
  --header 'X-NomeEvento: <x-nomeevento>' \
  --data '
{
  "dtHrSituacao": "<string>",
  "endToEndId": "<string>",
  "stJdPi": 123,
  "stJdPiProc": 123,
  "codigoErro": "<string>",
  "descCodigoErro": "<string>",
  "dtHrAceiteRejeite": "<string>",
  "dtHrReqJdPi": "<string>",
  "dtVencimento": "<string>",
  "idConciliacaoRecebedor": "<string>",
  "idRecorrencia": "<string>",
  "stAgendamento": 123,
  "valor": 123
}
'

import requests

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

payload = {
    "dtHrSituacao": "<string>",
    "endToEndId": "<string>",
    "stJdPi": 123,
    "stJdPiProc": 123,
    "codigoErro": "<string>",
    "descCodigoErro": "<string>",
    "dtHrAceiteRejeite": "<string>",
    "dtHrReqJdPi": "<string>",
    "dtVencimento": "<string>",
    "idConciliacaoRecebedor": "<string>",
    "idRecorrencia": "<string>",
    "stAgendamento": 123,
    "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({
    dtHrSituacao: '<string>',
    endToEndId: '<string>',
    stJdPi: 123,
    stJdPiProc: 123,
    codigoErro: '<string>',
    descCodigoErro: '<string>',
    dtHrAceiteRejeite: '<string>',
    dtHrReqJdPi: '<string>',
    dtVencimento: '<string>',
    idConciliacaoRecebedor: '<string>',
    idRecorrencia: '<string>',
    stAgendamento: 123,
    valor: 123
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-status', 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-status",
  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([
    'dtHrSituacao' => '<string>',
    'endToEndId' => '<string>',
    'stJdPi' => 123,
    'stJdPiProc' => 123,
    'codigoErro' => '<string>',
    'descCodigoErro' => '<string>',
    'dtHrAceiteRejeite' => '<string>',
    'dtHrReqJdPi' => '<string>',
    'dtVencimento' => '<string>',
    'idConciliacaoRecebedor' => '<string>',
    'idRecorrencia' => '<string>',
    'stAgendamento' => 123,
    '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-status"

	payload := strings.NewReader("{\n  \"dtHrSituacao\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"stJdPi\": 123,\n  \"stJdPiProc\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\",\n  \"dtHrAceiteRejeite\": \"<string>\",\n  \"dtHrReqJdPi\": \"<string>\",\n  \"dtVencimento\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"idRecorrencia\": \"<string>\",\n  \"stAgendamento\": 123,\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-status")
  .header("X-DataHoraEvento", "<x-datahoraevento>")
  .header("X-NomeEvento", "<x-nomeevento>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dtHrSituacao\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"stJdPi\": 123,\n  \"stJdPiProc\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\",\n  \"dtHrAceiteRejeite\": \"<string>\",\n  \"dtHrReqJdPi\": \"<string>\",\n  \"dtVencimento\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"idRecorrencia\": \"<string>\",\n  \"stAgendamento\": 123,\n  \"valor\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"dtHrSituacao\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"stJdPi\": 123,\n  \"stJdPiProc\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\",\n  \"dtHrAceiteRejeite\": \"<string>\",\n  \"dtHrReqJdPi\": \"<string>\",\n  \"dtVencimento\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"idRecorrencia\": \"<string>\",\n  \"stAgendamento\": 123,\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"
}

POST

pix-automatico

events

schedule-status

Recibir un evento de estado de programación de Pix Automático

curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DataHoraEvento: <x-datahoraevento>' \
  --header 'X-NomeEvento: <x-nomeevento>' \
  --data '
{
  "dtHrSituacao": "<string>",
  "endToEndId": "<string>",
  "stJdPi": 123,
  "stJdPiProc": 123,
  "codigoErro": "<string>",
  "descCodigoErro": "<string>",
  "dtHrAceiteRejeite": "<string>",
  "dtHrReqJdPi": "<string>",
  "dtVencimento": "<string>",
  "idConciliacaoRecebedor": "<string>",
  "idRecorrencia": "<string>",
  "stAgendamento": 123,
  "valor": 123
}
'

import requests

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

payload = {
    "dtHrSituacao": "<string>",
    "endToEndId": "<string>",
    "stJdPi": 123,
    "stJdPiProc": 123,
    "codigoErro": "<string>",
    "descCodigoErro": "<string>",
    "dtHrAceiteRejeite": "<string>",
    "dtHrReqJdPi": "<string>",
    "dtVencimento": "<string>",
    "idConciliacaoRecebedor": "<string>",
    "idRecorrencia": "<string>",
    "stAgendamento": 123,
    "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({
    dtHrSituacao: '<string>',
    endToEndId: '<string>',
    stJdPi: 123,
    stJdPiProc: 123,
    codigoErro: '<string>',
    descCodigoErro: '<string>',
    dtHrAceiteRejeite: '<string>',
    dtHrReqJdPi: '<string>',
    dtVencimento: '<string>',
    idConciliacaoRecebedor: '<string>',
    idRecorrencia: '<string>',
    stAgendamento: 123,
    valor: 123
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-status', 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-status",
  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([
    'dtHrSituacao' => '<string>',
    'endToEndId' => '<string>',
    'stJdPi' => 123,
    'stJdPiProc' => 123,
    'codigoErro' => '<string>',
    'descCodigoErro' => '<string>',
    'dtHrAceiteRejeite' => '<string>',
    'dtHrReqJdPi' => '<string>',
    'dtVencimento' => '<string>',
    'idConciliacaoRecebedor' => '<string>',
    'idRecorrencia' => '<string>',
    'stAgendamento' => 123,
    '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-status"

	payload := strings.NewReader("{\n  \"dtHrSituacao\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"stJdPi\": 123,\n  \"stJdPiProc\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\",\n  \"dtHrAceiteRejeite\": \"<string>\",\n  \"dtHrReqJdPi\": \"<string>\",\n  \"dtVencimento\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"idRecorrencia\": \"<string>\",\n  \"stAgendamento\": 123,\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-status")
  .header("X-DataHoraEvento", "<x-datahoraevento>")
  .header("X-NomeEvento", "<x-nomeevento>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dtHrSituacao\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"stJdPi\": 123,\n  \"stJdPiProc\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\",\n  \"dtHrAceiteRejeite\": \"<string>\",\n  \"dtHrReqJdPi\": \"<string>\",\n  \"dtVencimento\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"idRecorrencia\": \"<string>\",\n  \"stAgendamento\": 123,\n  \"valor\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"dtHrSituacao\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"stJdPi\": 123,\n  \"stJdPiProc\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\",\n  \"dtHrAceiteRejeite\": \"<string>\",\n  \"dtHrReqJdPi\": \"<string>\",\n  \"dtVencimento\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"idRecorrencia\": \"<string>\",\n  \"stAgendamento\": 123,\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"
}

Autorizaciones

Authorization

string

header

requerido

Autenticación con token JWT Bearer. Obtén el token desde el endpoint /v1/login/oauth/access_token usando credenciales de cliente (clientId y clientSecret).

Incluye el token en el encabezado Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

El token expira después de 3600 segundos (1 hora).

Encabezados

Authorization

string

Bearer access token (the financial-ingress gate; the handler fails closed with Pix-0082 when absent). Token de acceso Bearer (la puerta de ingreso financiero; el handler falla en modo cerrado con Pix-0082 cuando está ausente).

X-DataHoraEvento

string

requerido

Event registration instant (UTC: aaaa-mm-ddTHH:mm:ss.sssZ). Mandatory per Instante de registro del evento (UTC: aaaa-mm-ddTHH:mm:ss.sssZ). Obligatorio.

X-NomeEvento

string

requerido

Event name. Mandatory per; informational passthrough. Nombre del evento. Obligatorio; dato de paso informativo.

Cuerpo

application/json

dtHrSituacao

string

requerido

Marca de tiempo de la consulta de situación (UTC).

endToEndId

string

requerido

Id único de la instrucción de pago (32 caracteres).

stJdPi

integer<int64>

requerido

Situación general de la solicitud (-1/0/9/10/11).

stJdPiProc

integer<int64>

requerido

Situación intermedia de procesamiento (0/1/2/5/7/8/9/10/11).

codigoErro

string

Código de error del upstream (en un rechazo o error interno).

descCodigoErro

string

Descripción del error del upstream.

dtHrAceiteRejeite

string

Marca de tiempo de aceptación/rechazo (UTC).

dtHrReqJdPi

string

Marca de tiempo de registro de la solicitud en el upstream (UTC).

dtVencimento

string

Fecha de vencimiento del cobro recurrente (aaaa-mm-dd).

idConciliacaoRecebedor

string

Id de conciliación del receptor (35 caracteres).

idRecorrencia

string

Id de recurrencia único (29 caracteres, RR...).

recebedor

object

Show child attributes

stAgendamento

integer<int64>

Estado de la programación (0=Aceito, 1=Rejeitado).

valor

number<double>

Monto del pago recurrente en reales (un número JSON).

Respuesta

Sin contenido

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Recibir un evento de estado de programación de Pix Automático

Autorizaciones

Encabezados

Cuerpo

Respuesta