Pular para o conteúdo principal
DELETE
/
v1
/
pix-automatico
/
settlements
/
inbound
/
debit
/
{endToEndId}
Reverter débito de liquidação de Pix Automático de entrada
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"
}

Autorizações

Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Cabeçalhos

Authorization
string

Token de acesso Bearer (o portão de entrada financeira; o handler falha de forma fechada com Pix-0082 quando ausente).

Chave-Idempotencia
string
obrigatório

Chave de idempotência (= o endToEndId da transação). Obrigatório conforme

Parâmetros de caminho

endToEndId
string
obrigatório

Id único de instrução de pagamento (32 caracteres), a chave natural.

Corpo

application/json
codigoErro
string
obrigatório

Código de erro.

endToEndId
string
obrigatório

Id único de instrução de pagamento (32 caracteres; corresponde ao parâmetro de path).

stJdPiProc
integer<int64>
obrigatório

Classificação de retorno negativo.

descCodigoErro
string

Descrição do erro (1000 caracteres).

Resposta

OK

dtHrOperacaoSgct
string
obrigatório

carimbo de data/hora da operação do gateway de liquidação (UTC).

endToEndId
string
obrigatório

Id único de instrução de pagamento (32 caracteres).

idOperacaoSgct
string
obrigatório

id da operação de reversão do gateway de liquidação (um GUID).