Saltar al contenido principal
POST
/
v1
/
pix-automatico
/
authorizations
/
{idRecorrencia}
/
confirm
Confirmar una autorización de Pix Automático
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/confirm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contractNumber": "<string>",
  "frequency": 123,
  "journey": 123,
  "payer": {
    "account": "<string>",
    "accountType": 123,
    "cpfCnpj": "<string>",
    "ibgeCode": 123,
    "ispb": "<string>",
    "name": "<string>",
    "personType": 123,
    "agency": "<string>"
  },
  "recipient": {
    "cnpj": "<string>",
    "ispb": "<string>",
    "name": "<string>"
  },
  "startDate": "<string>",
  "amount": 123,
  "authorizedAt": "<string>",
  "contractDesc": "<string>",
  "createdDateTime": "<string>",
  "endDate": "<string>",
  "floorMaxAmount": 123,
  "payerMaxAmount": 123,
  "settlementConfirmedAt": "<string>"
}
'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/confirm"

payload = {
"contractNumber": "<string>",
"frequency": 123,
"journey": 123,
"payer": {
"account": "<string>",
"accountType": 123,
"cpfCnpj": "<string>",
"ibgeCode": 123,
"ispb": "<string>",
"name": "<string>",
"personType": 123,
"agency": "<string>"
},
"recipient": {
"cnpj": "<string>",
"ispb": "<string>",
"name": "<string>"
},
"startDate": "<string>",
"amount": 123,
"authorizedAt": "<string>",
"contractDesc": "<string>",
"createdDateTime": "<string>",
"endDate": "<string>",
"floorMaxAmount": 123,
"payerMaxAmount": 123,
"settlementConfirmedAt": "<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({
contractNumber: '<string>',
frequency: 123,
journey: 123,
payer: {
account: '<string>',
accountType: 123,
cpfCnpj: '<string>',
ibgeCode: 123,
ispb: '<string>',
name: '<string>',
personType: 123,
agency: '<string>'
},
recipient: {cnpj: '<string>', ispb: '<string>', name: '<string>'},
startDate: '<string>',
amount: 123,
authorizedAt: '<string>',
contractDesc: '<string>',
createdDateTime: '<string>',
endDate: '<string>',
floorMaxAmount: 123,
payerMaxAmount: 123,
settlementConfirmedAt: '<string>'
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/confirm', 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/authorizations/{idRecorrencia}/confirm",
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([
'contractNumber' => '<string>',
'frequency' => 123,
'journey' => 123,
'payer' => [
'account' => '<string>',
'accountType' => 123,
'cpfCnpj' => '<string>',
'ibgeCode' => 123,
'ispb' => '<string>',
'name' => '<string>',
'personType' => 123,
'agency' => '<string>'
],
'recipient' => [
'cnpj' => '<string>',
'ispb' => '<string>',
'name' => '<string>'
],
'startDate' => '<string>',
'amount' => 123,
'authorizedAt' => '<string>',
'contractDesc' => '<string>',
'createdDateTime' => '<string>',
'endDate' => '<string>',
'floorMaxAmount' => 123,
'payerMaxAmount' => 123,
'settlementConfirmedAt' => '<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/authorizations/{idRecorrencia}/confirm"

payload := strings.NewReader("{\n \"contractNumber\": \"<string>\",\n \"frequency\": 123,\n \"journey\": 123,\n \"payer\": {\n \"account\": \"<string>\",\n \"accountType\": 123,\n \"cpfCnpj\": \"<string>\",\n \"ibgeCode\": 123,\n \"ispb\": \"<string>\",\n \"name\": \"<string>\",\n \"personType\": 123,\n \"agency\": \"<string>\"\n },\n \"recipient\": {\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"startDate\": \"<string>\",\n \"amount\": 123,\n \"authorizedAt\": \"<string>\",\n \"contractDesc\": \"<string>\",\n \"createdDateTime\": \"<string>\",\n \"endDate\": \"<string>\",\n \"floorMaxAmount\": 123,\n \"payerMaxAmount\": 123,\n \"settlementConfirmedAt\": \"<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/authorizations/{idRecorrencia}/confirm")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contractNumber\": \"<string>\",\n \"frequency\": 123,\n \"journey\": 123,\n \"payer\": {\n \"account\": \"<string>\",\n \"accountType\": 123,\n \"cpfCnpj\": \"<string>\",\n \"ibgeCode\": 123,\n \"ispb\": \"<string>\",\n \"name\": \"<string>\",\n \"personType\": 123,\n \"agency\": \"<string>\"\n },\n \"recipient\": {\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"startDate\": \"<string>\",\n \"amount\": 123,\n \"authorizedAt\": \"<string>\",\n \"contractDesc\": \"<string>\",\n \"createdDateTime\": \"<string>\",\n \"endDate\": \"<string>\",\n \"floorMaxAmount\": 123,\n \"payerMaxAmount\": 123,\n \"settlementConfirmedAt\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/confirm")

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 \"contractNumber\": \"<string>\",\n \"frequency\": 123,\n \"journey\": 123,\n \"payer\": {\n \"account\": \"<string>\",\n \"accountType\": 123,\n \"cpfCnpj\": \"<string>\",\n \"ibgeCode\": 123,\n \"ispb\": \"<string>\",\n \"name\": \"<string>\",\n \"personType\": 123,\n \"agency\": \"<string>\"\n },\n \"recipient\": {\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"startDate\": \"<string>\",\n \"amount\": 123,\n \"authorizedAt\": \"<string>\",\n \"contractDesc\": \"<string>\",\n \"createdDateTime\": \"<string>\",\n \"endDate\": \"<string>\",\n \"floorMaxAmount\": 123,\n \"payerMaxAmount\": 123,\n \"settlementConfirmedAt\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "idRecorrencia": "<string>",
  "requestedAt": "<string>",
  "idReqJdPi": "<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).

Parámetros de ruta

idRecorrencia
string
requerido

The recurrence id (29-char, RR...). El id de recurrencia (29 caracteres, RR...).

Cuerpo

application/json
contractNumber
string
requerido

Identificador de contrato/orden (nrContrato).

frequency
integer<int64>
requerido

tpFrequencia (0..4).

journey
integer<int64>
requerido

jornada (2..4).

payer
object
requerido
recipient
object
requerido
startDate
string
requerido

Fecha del primer pago (dtInicialRecorrencia; aaaa-mm-dd).

amount
number<double>

Monto fijo del pago en reales (valor).

authorizedAt
string

Marca de tiempo de la autorización (dtHrAutorizacaoRecorrencia, UTC).

contractDesc
string

Descripción de contrato de texto libre.

createdDateTime
string

Marca de tiempo de creación de la recurrencia (dtHrCriacaoRecorrencia, UTC).

debtor
object
endDate
string

Fecha del último pago (dtFinalRecorrencia).

floorMaxAmount
number<double>

Monto mínimo del receptor en reales (pisoValorMaximo).

payerMaxAmount
number<double>

Tope máximo del pagador en reales (vlrMaxPagador).

settlementConfirmedAt
string

Marca de tiempo de confirmación de liquidación (dtHrConfirmacaoLiquidacao, UTC; obligatoria para jornada=3).

Respuesta

Aceptado

idRecorrencia
string
requerido

El id de recurrencia.

requestedAt
string
requerido

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

idReqJdPi
string

El id de solicitud del upstream (GUID de 36 caracteres; omitido por 4.3.10).

status
string

El estado local resultante de la autorización.