Saltar al contenido principal
POST
/
v1
/
pix-automatico
/
settlements
/
inbound
/
debit
Efectuar un débito de liquidación entrante de Pix Automático
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/settlements/inbound/debit \
  --header 'Authorization: Bearer <token>' \
  --header 'Chave-Idempotencia: <chave-idempotencia>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtContabil": "<string>",
  "dtHrEfetivacao": "<string>",
  "dtHrLiquidacao": "<string>",
  "endToEndId": "<string>",
  "ispb": "<string>"
}
'
import requests

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

payload = {
"dtContabil": "<string>",
"dtHrEfetivacao": "<string>",
"dtHrLiquidacao": "<string>",
"endToEndId": "<string>",
"ispb": "<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({
dtContabil: '<string>',
dtHrEfetivacao: '<string>',
dtHrLiquidacao: '<string>',
endToEndId: '<string>',
ispb: '<string>'
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/settlements/inbound/debit', 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/debit",
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([
'dtContabil' => '<string>',
'dtHrEfetivacao' => '<string>',
'dtHrLiquidacao' => '<string>',
'endToEndId' => '<string>',
'ispb' => '<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/debit"

payload := strings.NewReader("{\n \"dtContabil\": \"<string>\",\n \"dtHrEfetivacao\": \"<string>\",\n \"dtHrLiquidacao\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"ispb\": \"<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/debit")
.header("Chave-Idempotencia", "<chave-idempotencia>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dtContabil\": \"<string>\",\n \"dtHrEfetivacao\": \"<string>\",\n \"dtHrLiquidacao\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"ispb\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"dtContabil\": \"<string>\",\n \"dtHrEfetivacao\": \"<string>\",\n \"dtHrLiquidacao\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"ispb\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "dtHrOperacaoSgct": "<string>",
  "endToEndId": "<string>",
  "idOperacaoSgct": "<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
dtContabil
string
requerido

Fecha contable (aaaa-mm-dd).

dtHrEfetivacao
string
requerido

Marca de tiempo de efectuación en el upstream (UTC).

dtHrLiquidacao
string
requerido

Marca de tiempo de liquidación del SPI (UTC).

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

Respuesta

OK

dtHrOperacaoSgct
string
requerido

Marca de tiempo de la operación del settlement-gateway (UTC).

endToEndId
string
requerido

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

idOperacaoSgct
string
requerido

Id de operación de débito del settlement-gateway (el id de transacción de Midaz, un GUID).