Revertir un débito de liquidación entrante de Pix Automático

curl --request DELETE \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/settlements/inbound/debit/{endToEndId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Chave-Idempotencia: <chave-idempotencia>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "codigoErro": "<string>",
  "endToEndId": "<string>",
  "stJdPiProc": 123,
  "descCodigoErro": "<string>"
}
'

import requests

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

payload = {
    "codigoErro": "<string>",
    "endToEndId": "<string>",
    "stJdPiProc": 123,
    "descCodigoErro": "<string>"
}
headers = {
    "Chave-Idempotencia": "<chave-idempotencia>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {
    'Chave-Idempotencia': '<chave-idempotencia>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    codigoErro: '<string>',
    endToEndId: '<string>',
    stJdPiProc: 123,
    descCodigoErro: '<string>'
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/settlements/inbound/debit/{endToEndId}', 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/{endToEndId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'codigoErro' => '<string>',
    'endToEndId' => '<string>',
    'stJdPiProc' => 123,
    'descCodigoErro' => '<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/{endToEndId}"

	payload := strings.NewReader("{\n  \"codigoErro\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"stJdPiProc\": 123,\n  \"descCodigoErro\": \"<string>\"\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/settlements/inbound/debit/{endToEndId}")
  .header("Chave-Idempotencia", "<chave-idempotencia>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"codigoErro\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"stJdPiProc\": 123,\n  \"descCodigoErro\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Delete.new(url)
request["Chave-Idempotencia"] = '<chave-idempotencia>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"codigoErro\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"stJdPiProc\": 123,\n  \"descCodigoErro\": \"<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"
}

DELETE

pix-automatico

settlements

inbound

debit

{endToEndId}

Revertir un débito de liquidación entrante de Pix Automático

curl --request DELETE \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/settlements/inbound/debit/{endToEndId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Chave-Idempotencia: <chave-idempotencia>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "codigoErro": "<string>",
  "endToEndId": "<string>",
  "stJdPiProc": 123,
  "descCodigoErro": "<string>"
}
'

import requests

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

payload = {
    "codigoErro": "<string>",
    "endToEndId": "<string>",
    "stJdPiProc": 123,
    "descCodigoErro": "<string>"
}
headers = {
    "Chave-Idempotencia": "<chave-idempotencia>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {
    'Chave-Idempotencia': '<chave-idempotencia>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    codigoErro: '<string>',
    endToEndId: '<string>',
    stJdPiProc: 123,
    descCodigoErro: '<string>'
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/settlements/inbound/debit/{endToEndId}', 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/{endToEndId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'codigoErro' => '<string>',
    'endToEndId' => '<string>',
    'stJdPiProc' => 123,
    'descCodigoErro' => '<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/{endToEndId}"

	payload := strings.NewReader("{\n  \"codigoErro\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"stJdPiProc\": 123,\n  \"descCodigoErro\": \"<string>\"\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/settlements/inbound/debit/{endToEndId}")
  .header("Chave-Idempotencia", "<chave-idempotencia>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"codigoErro\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"stJdPiProc\": 123,\n  \"descCodigoErro\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Delete.new(url)
request["Chave-Idempotencia"] = '<chave-idempotencia>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"codigoErro\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"stJdPiProc\": 123,\n  \"descCodigoErro\": \"<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.

Parámetros de ruta

endToEndId

string

requerido

Unique payment-instruction id (32-char), the natural key. Id único de la instrucción de pago (32 caracteres), la clave natural.

Cuerpo

application/json

codigoErro

string

requerido

Código de error.

endToEndId

string

requerido

Id único de la instrucción de pago (32 caracteres; coincide con el parámetro de ruta).

stJdPiProc

integer<int64>

requerido

Clasificación del retorno negativo.

descCodigoErro

string

Descripción del error (1000 caracteres).

Respuesta

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 reversión del settlement-gateway (un GUID).

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Revertir un débito de liquidación entrante de Pix Automático

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta