Skip to main content
POST
/
v1
/
pix-automatico
/
schedules
/
inbound
/
register
Register an inbound Pix Automático payment instruction
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/inbound/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --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/schedules/inbound/register"

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 = {
    "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({
    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/schedules/inbound/register', 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/inbound/register",
  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"
  ],
]);

$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/inbound/register"

	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("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/inbound/register")
  .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/schedules/inbound/register")

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  \"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
{
  "dtHrSgct": "<string>",
  "idSgct": "<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
​
dtVencimento
string
required

Recurring charge due date (aaaa-mm-dd).

​
endToEndId
string
required

Unique payment-instruction id (32-char).

​
finalidadeAgendamento
integer<int64>
required

Schedule purpose (0=first, 1=post-due retry, 2=settlement resend).

​
idConciliacaoRecebedor
string
required

Receiver conciliation id (35-char).

​
idRecorrencia
string
required

Unique recurrence id (29-char, RR...).

​
pagador
object
required
​
recebedor
object
required
​
stAgendamento
integer<int64>
required

Schedule status (0=Aceito, 1=Rejeitado).

​
codigoErro
string

Upstream error code (100-char; on a rejection).

​
descCodigoErro
string

Upstream error description (1000-char).

​
devedor
object
​
dtHrRecepcaoPspRecebedor
string

PSP-receiver reception timestamp (UTC; required when finalidadeAgendamento=0).

​
infEntreClientes
string

Free-text receiver-to-payer info (140-char).

​
valor
number<double>

Recurring payment amount in reais (a JSON number).

Response

OK

​
dtHrSgct
string
required

settlement-gateway registration timestamp (UTC).

​
idSgct
string
required

Local settlement-gateway schedule id (36-char GUID).