Delete key
curl --request DELETE \
--url https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accountId": "019c96a0-0a98-7287-9a31-786e0809c769"
}
'import requests
url = "https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}"
payload = { "accountId": "019c96a0-0a98-7287-9a31-786e0809c769" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({accountId: '019c96a0-0a98-7287-9a31-786e0809c769'})
};
fetch('https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}', 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/entries/{entryId}",
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([
'accountId' => '019c96a0-0a98-7287-9a31-786e0809c769'
]),
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/entries/{entryId}"
payload := strings.NewReader("{\n \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}")
req, _ := http.NewRequest("DELETE", 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.delete("https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}"
response = http.request(request)
puts response.read_body{
"key": "+5511987654321"
}Delete key
Remove a Pix key registration from an account. This permanently deletes the key from the Pix directory. Only keys in certain statuses can be deleted (typically status 1=ACTIVE or 0=FINALIZED).
DELETE
/
v1
/
entries
/
{entryId}
Delete key
curl --request DELETE \
--url https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accountId": "019c96a0-0a98-7287-9a31-786e0809c769"
}
'import requests
url = "https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}"
payload = { "accountId": "019c96a0-0a98-7287-9a31-786e0809c769" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({accountId: '019c96a0-0a98-7287-9a31-786e0809c769'})
};
fetch('https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}', 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/entries/{entryId}",
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([
'accountId' => '019c96a0-0a98-7287-9a31-786e0809c769'
]),
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/entries/{entryId}"
payload := strings.NewReader("{\n \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}")
req, _ := http.NewRequest("DELETE", 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.delete("https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}"
response = http.request(request)
puts response.read_body{
"key": "+5511987654321"
}Authorizations
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).
Path Parameters
Pix key value to delete.
Body
application/json
Account identifier.
Example:
"019c96a0-0a98-7287-9a31-786e0809c769"
Response
Pix Key deleted successfully
Deleted Pix key value.
Example:
"+5511987654321"
Was this page helpful?
⌘I