Registrar una remoción de titularidad
curl --request POST \
--url https://plugin-pix-direct.api.lerian.net/v1/holder-removals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account": "<string>",
"accountId": "<string>",
"accountType": 123,
"document": "<string>",
"personType": 123,
"branch": "<string>"
}
'import requests
url = "https://plugin-pix-direct.api.lerian.net/v1/holder-removals"
payload = {
"account": "<string>",
"accountId": "<string>",
"accountType": 123,
"document": "<string>",
"personType": 123,
"branch": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account: '<string>',
accountId: '<string>',
accountType: 123,
document: '<string>',
personType: 123,
branch: '<string>'
})
};
fetch('https://plugin-pix-direct.api.lerian.net/v1/holder-removals', 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/holder-removals",
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([
'account' => '<string>',
'accountId' => '<string>',
'accountType' => 123,
'document' => '<string>',
'personType' => 123,
'branch' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/holder-removals"
payload := strings.NewReader("{\n \"account\": \"<string>\",\n \"accountId\": \"<string>\",\n \"accountType\": 123,\n \"document\": \"<string>\",\n \"personType\": 123,\n \"branch\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/holder-removals")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account\": \"<string>\",\n \"accountId\": \"<string>\",\n \"accountType\": 123,\n \"document\": \"<string>\",\n \"personType\": 123,\n \"branch\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-direct.api.lerian.net/v1/holder-removals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account\": \"<string>\",\n \"accountId\": \"<string>\",\n \"accountType\": 123,\n \"document\": \"<string>\",\n \"personType\": 123,\n \"branch\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"deletedKeys": [
{
"key": "<string>",
"reason": 123,
"result": 123,
"document": "<string>",
"name": "<string>",
"resultDescription": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Registrar una remoción de titularidad
Corta la titularidad de un titular sobre una cuenta transaccional, haciendo que el DICT elimine en lote todas las claves Pix vinculadas a ese titular y cuenta. Devuelve los resultados de eliminación por clave.
POST
/
v1
/
holder-removals
Registrar una remoción de titularidad
curl --request POST \
--url https://plugin-pix-direct.api.lerian.net/v1/holder-removals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account": "<string>",
"accountId": "<string>",
"accountType": 123,
"document": "<string>",
"personType": 123,
"branch": "<string>"
}
'import requests
url = "https://plugin-pix-direct.api.lerian.net/v1/holder-removals"
payload = {
"account": "<string>",
"accountId": "<string>",
"accountType": 123,
"document": "<string>",
"personType": 123,
"branch": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account: '<string>',
accountId: '<string>',
accountType: 123,
document: '<string>',
personType: 123,
branch: '<string>'
})
};
fetch('https://plugin-pix-direct.api.lerian.net/v1/holder-removals', 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/holder-removals",
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([
'account' => '<string>',
'accountId' => '<string>',
'accountType' => 123,
'document' => '<string>',
'personType' => 123,
'branch' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/holder-removals"
payload := strings.NewReader("{\n \"account\": \"<string>\",\n \"accountId\": \"<string>\",\n \"accountType\": 123,\n \"document\": \"<string>\",\n \"personType\": 123,\n \"branch\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/holder-removals")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account\": \"<string>\",\n \"accountId\": \"<string>\",\n \"accountType\": 123,\n \"document\": \"<string>\",\n \"personType\": 123,\n \"branch\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-direct.api.lerian.net/v1/holder-removals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account\": \"<string>\",\n \"accountId\": \"<string>\",\n \"accountType\": 123,\n \"document\": \"<string>\",\n \"personType\": 123,\n \"branch\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"deletedKeys": [
{
"key": "<string>",
"reason": 123,
"result": 123,
"document": "<string>",
"name": "<string>",
"resultDescription": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Autorizaciones
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).
Cuerpo
application/json
El número de cuenta.
El id de cuenta del CRM de quien llama (resuelve el ISPB del lado del servidor).
El tipo de cuenta (0=Checking,1=Salary,2=Savings,3=Payment,4=PI).
El documento del titular objetivo (CPF/CNPJ).
El tipo de persona del titular objetivo (0=Person,1=Corporate).
El número de agencia de la cuenta.
Respuesta
OK
Los resultados de eliminación por clave.
Show child attributes
Show child attributes
¿Esta página le ayudó?
⌘I