Reserve an inbound Pix Automático debit hold

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"
}

POST

pix-automatico

settlements

inbound

block

Reserve an inbound Pix Automático debit hold

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"
}

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

Headers

Authorization

string

Bearer access token (the financial-ingress gate; the handler fails closed with Pix-0082 when absent).

Chave-Idempotencia

string

required

Idempotency key (= the endToEndId of the transaction). Mandatory per

Body

application/json

codMunIbge

integer<int64>

required

Payer IBGE municipality code (7 digits).

cpfCnpj

string

required

Payer CPF or CNPJ (a v5.5.0 string).

endToEndId

string

required

Unique payment-instruction id (32-char).

ispb

string

required

Payer participant ISPB (8 digits, a v5.5.0 string).

nrConta

string

required

Payer account number (nrConta, a string).

tpPessoa

integer<int64>

required

Payer person type (0=Pessoa Fisica, 1=Pessoa Juridica).

valor

number<double>

required

Reserve amount in reais.

nrAgencia

string

Payer branch (nrAgencia, 4 digits, string).

Response

dtHrRespostaSgct

string

required

settlement-gateway response timestamp (UTC).

endToEndId

string

required

Unique payment-instruction id (32-char).

resultado

integer<int64>

required

Block result (0=Rejeitado, 1=Aceito).

idOperacaoSgct

string

settlement-gateway block-operation id (GUID; present only when resultado=1).

motivo

string

Rejection reason (SGCTPIX001=insufficient funds, SGCTPIX999=other; present only when resultado=0).

motivoComplemento

string

Rejection detail (present only when resultado=0).

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Reserve an inbound Pix Automático debit hold

Authorizations

Headers

Body

Response