Change a PIX key entry

curl --request PUT \
  --url https://api.example.com/v1/entries/{entryId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "acc-123",
  "reason": 2,
  "accountOpeningDate": "2020-01-10T11:30:17.001Z",
  "newAccount": "0007654321",
  "newAccountType": 0,
  "newBranch": "0001",
  "newName": "Empresa Nova",
  "newTradeName": "Fantasia Nova"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/entries/{entryId}"

	payload := strings.NewReader("{\n  \"accountId\": \"acc-123\",\n  \"reason\": 2,\n  \"accountOpeningDate\": \"2020-01-10T11:30:17.001Z\",\n  \"newAccount\": \"0007654321\",\n  \"newAccountType\": 0,\n  \"newBranch\": \"0001\",\n  \"newName\": \"Empresa Nova\",\n  \"newTradeName\": \"Fantasia Nova\"\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))

}

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountId: 'acc-123',
    reason: 2,
    accountOpeningDate: '2020-01-10T11:30:17.001Z',
    newAccount: '0007654321',
    newAccountType: 0,
    newBranch: '0001',
    newName: 'Empresa Nova',
    newTradeName: 'Fantasia Nova'
  })
};

fetch('https://api.example.com/v1/entries/{entryId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/entries/{entryId}"

payload = {
    "accountId": "acc-123",
    "reason": 2,
    "accountOpeningDate": "2020-01-10T11:30:17.001Z",
    "newAccount": "0007654321",
    "newAccountType": 0,
    "newBranch": "0001",
    "newName": "Empresa Nova",
    "newTradeName": "Fantasia Nova"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "key": "foo@bar.com",
  "claimOpenedAt": "2026-01-03T00:00:00Z",
  "createdAt": "2026-01-01T00:00:00Z",
  "ownershipStartAt": "2026-01-02T00:00:00Z"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Change a PIX key entry

Re-points an existing PIX key to a new transactional account and/or a new owner name inside the SAME participant (§8.2.02 Alterar Chave de Endereçamento). entryId is the key VALUE, URL-encoded, and it never changes - no operation in this API edits a key’s value.

Only the destination travels in the body: newBranch, newAccountType, newAccount, accountOpeningDate, newName and newTradeName, all optional per the spec. The owner identity (ISPB, CPF/CNPJ, person type) is derived server-side from accountId and is never read from the payload. reason is required and is DICT’s motivo: 0=Customer Request, 2=Branch Transfer, 6=Reconciliation, 8=Receita Federal Validation; an EVP (RANDOM) key must not use 0.

It is a pure control-plane write: the plugin does NOT touch its own key row, so GET /v1/entries reflects the change only through its DICT source and a local row keeps the old coordinates until then. DICT may open a possession or portability claim as a consequence of the change; when it does, the response carries claimOpenedAt. Failures are DICT’s, translated into the PIX-1xxx family - an unknown key is 404 PIX-1011.

PUT

entries

{entryId}

Change a PIX key entry

curl --request PUT \
  --url https://api.example.com/v1/entries/{entryId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "acc-123",
  "reason": 2,
  "accountOpeningDate": "2020-01-10T11:30:17.001Z",
  "newAccount": "0007654321",
  "newAccountType": 0,
  "newBranch": "0001",
  "newName": "Empresa Nova",
  "newTradeName": "Fantasia Nova"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/entries/{entryId}"

	payload := strings.NewReader("{\n  \"accountId\": \"acc-123\",\n  \"reason\": 2,\n  \"accountOpeningDate\": \"2020-01-10T11:30:17.001Z\",\n  \"newAccount\": \"0007654321\",\n  \"newAccountType\": 0,\n  \"newBranch\": \"0001\",\n  \"newName\": \"Empresa Nova\",\n  \"newTradeName\": \"Fantasia Nova\"\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))

}

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountId: 'acc-123',
    reason: 2,
    accountOpeningDate: '2020-01-10T11:30:17.001Z',
    newAccount: '0007654321',
    newAccountType: 0,
    newBranch: '0001',
    newName: 'Empresa Nova',
    newTradeName: 'Fantasia Nova'
  })
};

fetch('https://api.example.com/v1/entries/{entryId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/entries/{entryId}"

payload = {
    "accountId": "acc-123",
    "reason": 2,
    "accountOpeningDate": "2020-01-10T11:30:17.001Z",
    "newAccount": "0007654321",
    "newAccountType": 0,
    "newBranch": "0001",
    "newName": "Empresa Nova",
    "newTradeName": "Fantasia Nova"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "key": "foo@bar.com",
  "claimOpenedAt": "2026-01-03T00:00:00Z",
  "createdAt": "2026-01-01T00:00:00Z",
  "ownershipStartAt": "2026-01-02T00:00:00Z"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

entryId

string

requerido

The PIX key value (URL-encoded).

Ejemplo:

"foo@bar.com"

Cuerpo

application/json

accountId

string

requerido

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

Ejemplo:

"acc-123"

reason

integer<int64>

requerido

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

Ejemplo:

2

accountOpeningDate

string

The new account's opening timestamp (RFC3339).

Ejemplo:

"2020-01-10T11:30:17.001Z"

newAccount

string

The new account number to associate with the key.

Ejemplo:

"0007654321"

newAccountType

integer<int64>

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

Ejemplo:

0

newBranch

string

The new branch number to associate with the key.

Ejemplo:

"0001"

newName

string

The new owner full name / legal name.

Ejemplo:

"Empresa Nova"

newTradeName

string

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

Ejemplo:

"Fantasia Nova"

Respuesta

key

string

requerido

The PIX key (unchanged).

Ejemplo:

"foo@bar.com"

claimOpenedAt

string

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

Ejemplo:

"2026-01-03T00:00:00Z"

createdAt

string

When the key was created (RFC3339).

Ejemplo:

"2026-01-01T00:00:00Z"

ownershipStartAt

string

When ownership of the key began (RFC3339).

Ejemplo:

"2026-01-02T00:00:00Z"

Asientos

Reclamaciones

Bancos

Indirectos

Transacciones

Límites

Códigos QR

Devoluciones

PIX Automatico

MED Infracciones

MED Devoluciones

MED Marcadores de Fraude

MED Recuperaciones

MED Crédito Entrante

Webhooks

Manejo de errores

Eventos

Change a PIX key entry

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta