Solicitar el envío de una programación 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"
}

POST

pix-automatico

schedules

Solicitar el envío de una programación 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"
}

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).

Cuerpo

application/json

dueDate

string

requerido

Fecha de vencimiento (dtVencimento; aaaa-mm-dd).

endToEndId

string

requerido

Id único de la transacción de pago (clave natural de 32 caracteres).

idRecorrencia

string

requerido

Id de recurrencia que vincula la autorización (29 caracteres, RR...).

payer

object

requerido

Show child attributes

purpose

integer<int64>

requerido

finalidadeAgendamento (0=primero, 1=reintento posterior al vencimiento, 2=reenvío por error de liquidación).

recipient

object

requerido

Show child attributes

reconciliationId

string

requerido

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

amount

number<double>

Monto programado en reales (valor).

debtor

object

Show child attributes

infoBetweenClients

string

Información del receptor al pagador de texto libre (infEntreClientes).

recipientReceivedAt

string

Marca de tiempo de recepción del PSP beneficiario (dtHrRecepcaoPspRecebedor, UTC; obligatoria cuando purpose=0).

Respuesta

Aceptado

endToEndId

string

requerido

El id de la transacción de pago (reflejado).

idRecorrencia

string

requerido

El id de recurrencia (reflejado).

reconciliationId

string

requerido

El id de conciliación del receptor (reflejado).

requestedAt

string

requerido

Marca de tiempo de la solicitud en el upstream (marca de tiempo de la solicitud del upstream, UTC).

status

string

requerido

El estado local resultante de la programación.

⌘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)

Solicitar el envío de una programación de Pix Automático

Autorizaciones

Cuerpo

Respuesta