Update an Entry
curl --request PATCH \
--url https://plugin-pix-indirect.api.lerian.net/v1/dict/entries/{entry_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Account-Id: <x-account-id>' \
--header 'X-Reason: <x-reason>' \
--data '
{
"account": {
"branch": "0001",
"number": "123456789",
"type": "TRAN"
},
"owner": {
"name": "John Doe",
"tradeName": "Johns Store"
}
}
'import requests
url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries/{entry_id}"
payload = {
"account": {
"branch": "0001",
"number": "123456789",
"type": "TRAN"
},
"owner": {
"name": "John Doe",
"tradeName": "Johns Store"
}
}
headers = {
"X-Account-Id": "<x-account-id>",
"X-Reason": "<x-reason>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-Account-Id': '<x-account-id>',
'X-Reason': '<x-reason>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
account: {branch: '0001', number: '123456789', type: 'TRAN'},
owner: {name: 'John Doe', tradeName: 'Johns Store'}
})
};
fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/entries/{entry_id}', 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-indirect.api.lerian.net/v1/dict/entries/{entry_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'account' => [
'branch' => '0001',
'number' => '123456789',
'type' => 'TRAN'
],
'owner' => [
'name' => 'John Doe',
'tradeName' => 'Johns Store'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Account-Id: <x-account-id>",
"X-Reason: <x-reason>"
],
]);
$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-indirect.api.lerian.net/v1/dict/entries/{entry_id}"
payload := strings.NewReader("{\n \"account\": {\n \"branch\": \"0001\",\n \"number\": \"123456789\",\n \"type\": \"TRAN\"\n },\n \"owner\": {\n \"name\": \"John Doe\",\n \"tradeName\": \"Johns Store\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Account-Id", "<x-account-id>")
req.Header.Add("X-Reason", "<x-reason>")
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.patch("https://plugin-pix-indirect.api.lerian.net/v1/dict/entries/{entry_id}")
.header("X-Account-Id", "<x-account-id>")
.header("X-Reason", "<x-reason>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account\": {\n \"branch\": \"0001\",\n \"number\": \"123456789\",\n \"type\": \"TRAN\"\n },\n \"owner\": {\n \"name\": \"John Doe\",\n \"tradeName\": \"Johns Store\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-indirect.api.lerian.net/v1/dict/entries/{entry_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["X-Reason"] = '<x-reason>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account\": {\n \"branch\": \"0001\",\n \"number\": \"123456789\",\n \"type\": \"TRAN\"\n },\n \"owner\": {\n \"name\": \"John Doe\",\n \"tradeName\": \"Johns Store\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "019c96a0-0c0c-7221-8cf3-13313fb60081",
"key": "john.doe@example.com",
"keyType": "EMAIL",
"status": "ACTIVE",
"account": {
"branch": "0001",
"number": "123456789",
"participant": "12345678",
"type": "TRAN"
},
"owner": {
"name": "John Doe",
"taxIdNumber": "12345678901",
"type": "NATURAL_PERSON"
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}Update an Entry
Use this endpoint to update an existing Pix entry data associated with an account.
Notes:
-
Only the account information, name, and trade name can be changed.
-
EVP keys (random) - Changes are allowed with the following reasons: BRANCH_TRANSFER, RECONCILIATION, and RFB_VALIDATION.
PATCH
/
v1
/
dict
/
entries
/
{entry_id}
Update an Entry
curl --request PATCH \
--url https://plugin-pix-indirect.api.lerian.net/v1/dict/entries/{entry_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Account-Id: <x-account-id>' \
--header 'X-Reason: <x-reason>' \
--data '
{
"account": {
"branch": "0001",
"number": "123456789",
"type": "TRAN"
},
"owner": {
"name": "John Doe",
"tradeName": "Johns Store"
}
}
'import requests
url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries/{entry_id}"
payload = {
"account": {
"branch": "0001",
"number": "123456789",
"type": "TRAN"
},
"owner": {
"name": "John Doe",
"tradeName": "Johns Store"
}
}
headers = {
"X-Account-Id": "<x-account-id>",
"X-Reason": "<x-reason>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-Account-Id': '<x-account-id>',
'X-Reason': '<x-reason>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
account: {branch: '0001', number: '123456789', type: 'TRAN'},
owner: {name: 'John Doe', tradeName: 'Johns Store'}
})
};
fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/entries/{entry_id}', 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-indirect.api.lerian.net/v1/dict/entries/{entry_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'account' => [
'branch' => '0001',
'number' => '123456789',
'type' => 'TRAN'
],
'owner' => [
'name' => 'John Doe',
'tradeName' => 'Johns Store'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Account-Id: <x-account-id>",
"X-Reason: <x-reason>"
],
]);
$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-indirect.api.lerian.net/v1/dict/entries/{entry_id}"
payload := strings.NewReader("{\n \"account\": {\n \"branch\": \"0001\",\n \"number\": \"123456789\",\n \"type\": \"TRAN\"\n },\n \"owner\": {\n \"name\": \"John Doe\",\n \"tradeName\": \"Johns Store\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Account-Id", "<x-account-id>")
req.Header.Add("X-Reason", "<x-reason>")
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.patch("https://plugin-pix-indirect.api.lerian.net/v1/dict/entries/{entry_id}")
.header("X-Account-Id", "<x-account-id>")
.header("X-Reason", "<x-reason>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account\": {\n \"branch\": \"0001\",\n \"number\": \"123456789\",\n \"type\": \"TRAN\"\n },\n \"owner\": {\n \"name\": \"John Doe\",\n \"tradeName\": \"Johns Store\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-indirect.api.lerian.net/v1/dict/entries/{entry_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["X-Reason"] = '<x-reason>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account\": {\n \"branch\": \"0001\",\n \"number\": \"123456789\",\n \"type\": \"TRAN\"\n },\n \"owner\": {\n \"name\": \"John Doe\",\n \"tradeName\": \"Johns Store\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "019c96a0-0c0c-7221-8cf3-13313fb60081",
"key": "john.doe@example.com",
"keyType": "EMAIL",
"status": "ACTIVE",
"account": {
"branch": "0001",
"number": "123456789",
"participant": "12345678",
"type": "TRAN"
},
"owner": {
"name": "John Doe",
"taxIdNumber": "12345678901",
"type": "NATURAL_PERSON"
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Unique identifier of the Midaz Ledger Account (UUID format).
Specifies the reason for Pix key entry update. Valid values: USER_REQUESTED, BRANCH_TRANSFER, RECONCILIATION.
Available options:
USER_REQUESTED, BRANCH_TRANSFER, RECONCILIATION Path Parameters
Unique identifier of the Pix entry (UUID format).
Body
application/json
Response
Entry updated successfully in DICT and local database.
Unique identifier of the entry (UUID format).
Example:
"019c96a0-0c0c-7221-8cf3-13313fb60081"
Pix key value.
Example:
"john.doe@example.com"
Type of Pix key.
Example:
"EMAIL"
Entry status (ACTIVE, INACTIVE).
Example:
"ACTIVE"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Creation timestamp.
Example:
"2024-01-15T10:30:00Z"
Last update timestamp.
Example:
"2024-01-15T10:30:00Z"
Was this page helpful?
⌘I