Change a Pix key entry

curl --request PUT \
  --url https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "reason": 123,
  "accountOpeningDate": "<string>",
  "newAccount": "<string>",
  "newAccountType": 123,
  "newBranch": "<string>",
  "newName": "<string>",
  "newTradeName": "<string>"
}
'

import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}"

payload = {
    "accountId": "<string>",
    "reason": 123,
    "accountOpeningDate": "<string>",
    "newAccount": "<string>",
    "newAccountType": 123,
    "newBranch": "<string>",
    "newName": "<string>",
    "newTradeName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountId: '<string>',
    reason: 123,
    accountOpeningDate: '<string>',
    newAccount: '<string>',
    newAccountType: 123,
    newBranch: '<string>',
    newName: '<string>',
    newTradeName: '<string>'
  })
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'accountId' => '<string>',
    'reason' => 123,
    'accountOpeningDate' => '<string>',
    'newAccount' => '<string>',
    'newAccountType' => 123,
    'newBranch' => '<string>',
    'newName' => '<string>',
    'newTradeName' => '<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/entries/{entryId}"

	payload := strings.NewReader("{\n  \"accountId\": \"<string>\",\n  \"reason\": 123,\n  \"accountOpeningDate\": \"<string>\",\n  \"newAccount\": \"<string>\",\n  \"newAccountType\": 123,\n  \"newBranch\": \"<string>\",\n  \"newName\": \"<string>\",\n  \"newTradeName\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountId\": \"<string>\",\n  \"reason\": 123,\n  \"accountOpeningDate\": \"<string>\",\n  \"newAccount\": \"<string>\",\n  \"newAccountType\": 123,\n  \"newBranch\": \"<string>\",\n  \"newName\": \"<string>\",\n  \"newTradeName\": \"<string>\"\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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accountId\": \"<string>\",\n  \"reason\": 123,\n  \"accountOpeningDate\": \"<string>\",\n  \"newAccount\": \"<string>\",\n  \"newAccountType\": 123,\n  \"newBranch\": \"<string>\",\n  \"newName\": \"<string>\",\n  \"newTradeName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "key": "<string>",
  "claimOpenedAt": "<string>",
  "createdAt": "<string>",
  "ownershipStartAt": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

PUT

entries

{entryId}

Change a Pix key entry

curl --request PUT \
  --url https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "reason": 123,
  "accountOpeningDate": "<string>",
  "newAccount": "<string>",
  "newAccountType": 123,
  "newBranch": "<string>",
  "newName": "<string>",
  "newTradeName": "<string>"
}
'

import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}"

payload = {
    "accountId": "<string>",
    "reason": 123,
    "accountOpeningDate": "<string>",
    "newAccount": "<string>",
    "newAccountType": 123,
    "newBranch": "<string>",
    "newName": "<string>",
    "newTradeName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountId: '<string>',
    reason: 123,
    accountOpeningDate: '<string>',
    newAccount: '<string>',
    newAccountType: 123,
    newBranch: '<string>',
    newName: '<string>',
    newTradeName: '<string>'
  })
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'accountId' => '<string>',
    'reason' => 123,
    'accountOpeningDate' => '<string>',
    'newAccount' => '<string>',
    'newAccountType' => 123,
    'newBranch' => '<string>',
    'newName' => '<string>',
    'newTradeName' => '<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/entries/{entryId}"

	payload := strings.NewReader("{\n  \"accountId\": \"<string>\",\n  \"reason\": 123,\n  \"accountOpeningDate\": \"<string>\",\n  \"newAccount\": \"<string>\",\n  \"newAccountType\": 123,\n  \"newBranch\": \"<string>\",\n  \"newName\": \"<string>\",\n  \"newTradeName\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://plugin-pix-direct.api.lerian.net/v1/entries/{entryId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountId\": \"<string>\",\n  \"reason\": 123,\n  \"accountOpeningDate\": \"<string>\",\n  \"newAccount\": \"<string>\",\n  \"newAccountType\": 123,\n  \"newBranch\": \"<string>\",\n  \"newName\": \"<string>\",\n  \"newTradeName\": \"<string>\"\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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accountId\": \"<string>\",\n  \"reason\": 123,\n  \"accountOpeningDate\": \"<string>\",\n  \"newAccount\": \"<string>\",\n  \"newAccountType\": 123,\n  \"newBranch\": \"<string>\",\n  \"newName\": \"<string>\",\n  \"newTradeName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "key": "<string>",
  "claimOpenedAt": "<string>",
  "createdAt": "<string>",
  "ownershipStartAt": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Authorizations

Authorization

string

header

required

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

entryId

string

required

The Pix key value (URL-encoded).

Body

application/json

accountId

string

required

The CRM account id of the key owner (resolves the server-side ISPB).

reason

integer<int64>

required

Change reason (0=Customer Request,2=Branch Transfer,6=Reconciliation,8=Receita Federal Validation). EVP keys must not use 0.

accountOpeningDate

string

The new account's opening timestamp (RFC3339).

newAccount

string

The new account number to associate with the key.

newAccountType

integer<int64>

The new account type (0=Checking,1=Salary,2=Savings,3=Payment,4=PI).

newBranch

string

The new branch number to associate with the key.

newName

string

The new owner full name / legal name.

newTradeName

string

The new owner trade name (sent only for a corporate owner).

Response

key

string

required

The Pix key (unchanged).

claimOpenedAt

string

When a possession/portability claim was opened by the change (RFC3339), if any.

createdAt

string

When the key was created (RFC3339).

ownershipStartAt

string

When ownership of the key began (RFC3339).

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Change a Pix key entry

Authorizations

Path Parameters

Body

Response