Saltar al contenido principal
POST
/
v1
/
pix-automatico
/
settlements
/
inbound
/
block
Reservar una retención de débito entrante de Pix Automático
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/settlements/inbound/block \
  --header 'Authorization: Bearer <token>' \
  --header 'Chave-Idempotencia: <chave-idempotencia>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "codMunIbge": 123,
  "cpfCnpj": "<string>",
  "endToEndId": "<string>",
  "ispb": "<string>",
  "nrConta": "<string>",
  "tpPessoa": 123,
  "valor": 123,
  "nrAgencia": "<string>"
}
'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/settlements/inbound/block"

payload = {
"codMunIbge": 123,
"cpfCnpj": "<string>",
"endToEndId": "<string>",
"ispb": "<string>",
"nrConta": "<string>",
"tpPessoa": 123,
"valor": 123,
"nrAgencia": "<string>"
}
headers = {
"Chave-Idempotencia": "<chave-idempotencia>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'Chave-Idempotencia': '<chave-idempotencia>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
codMunIbge: 123,
cpfCnpj: '<string>',
endToEndId: '<string>',
ispb: '<string>',
nrConta: '<string>',
tpPessoa: 123,
valor: 123,
nrAgencia: '<string>'
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/settlements/inbound/block', 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/settlements/inbound/block",
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([
'codMunIbge' => 123,
'cpfCnpj' => '<string>',
'endToEndId' => '<string>',
'ispb' => '<string>',
'nrConta' => '<string>',
'tpPessoa' => 123,
'valor' => 123,
'nrAgencia' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Chave-Idempotencia: <chave-idempotencia>",
"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/settlements/inbound/block"

payload := strings.NewReader("{\n \"codMunIbge\": 123,\n \"cpfCnpj\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nrConta\": \"<string>\",\n \"tpPessoa\": 123,\n \"valor\": 123,\n \"nrAgencia\": \"<string>\"\n}")

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

req.Header.Add("Chave-Idempotencia", "<chave-idempotencia>")
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/settlements/inbound/block")
.header("Chave-Idempotencia", "<chave-idempotencia>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"codMunIbge\": 123,\n \"cpfCnpj\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nrConta\": \"<string>\",\n \"tpPessoa\": 123,\n \"valor\": 123,\n \"nrAgencia\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/settlements/inbound/block")

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

request = Net::HTTP::Post.new(url)
request["Chave-Idempotencia"] = '<chave-idempotencia>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"codMunIbge\": 123,\n \"cpfCnpj\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nrConta\": \"<string>\",\n \"tpPessoa\": 123,\n \"valor\": 123,\n \"nrAgencia\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "dtHrRespostaSgct": "<string>",
  "endToEndId": "<string>",
  "resultado": 123,
  "idOperacaoSgct": "<string>",
  "motivo": "<string>",
  "motivoComplemento": "<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).

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

Chave-Idempotencia
string
requerido

Idempotency key (= the endToEndId of the transaction). Mandatory per Clave de idempotencia (= el endToEndId de la transacción). Obligatorio.

Cuerpo

application/json
codMunIbge
integer<int64>
requerido

Código IBGE del municipio del pagador (7 dígitos).

cpfCnpj
string
requerido

CPF o CNPJ del pagador (una cadena v5.5.0).

endToEndId
string
requerido

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

ispb
string
requerido

ISPB del participante pagador (8 dígitos, una cadena v5.5.0).

nrConta
string
requerido

Número de cuenta del pagador (nrConta, una cadena).

tpPessoa
integer<int64>
requerido

Tipo de persona del pagador (0=Pessoa Fisica, 1=Pessoa Juridica).

valor
number<double>
requerido

Monto a reservar en reales.

nrAgencia
string

Agencia del pagador (nrAgencia, 4 dígitos, cadena).

Respuesta

OK

dtHrRespostaSgct
string
requerido

Marca de tiempo de respuesta del settlement-gateway (UTC).

endToEndId
string
requerido

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

resultado
integer<int64>
requerido

Resultado del bloqueo (0=Rejeitado, 1=Aceito).

idOperacaoSgct
string

Id de operación de bloqueo del settlement-gateway (GUID; presente solo cuando resultado=1).

motivo
string

Motivo de rechazo (SGCTPIX001=fondos insuficientes, SGCTPIX999=otro; presente solo cuando resultado=0).

motivoComplemento
string

Detalle del rechazo (presente solo cuando resultado=0).