Pular para o conteúdo principal
POST
/
v1
/
dict
/
entries
Criar uma Entry
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Reason: <x-reason>' \
  --data '
{
  "keyType": "EMAIL",
  "key": "john.doe@example.com"
}
'
{ "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" }

Autorizações

​
Authorization
string
header
obrigatório

Header de autenticação Bearer no formato Bearer <token>, onde <token> é o seu token de acesso JWT.

Cabeçalhos

​
X-Account-Id
string
obrigatório

Identificador único da Conta do Ledger Midaz (formato UUID).

​
X-Reason
enum<string>
obrigatório

Motivo para criação da entrada.

Opções disponíveis:
USER_REQUESTED,
RECONCILIATION

Corpo

application/json
​
keyType
enum<string>
obrigatório

Tipo de chave PIX sendo criada.

Opções disponíveis:
EMAIL,
PHONE,
CPF,
CNPJ,
EVP
Exemplo:

"EMAIL"

​
key
string

Valor da chave PIX sendo registrada (ex.: endereço de e-mail, telefone ou CPF). Não é obrigatório para o tipo EVP.

Exemplo:

"john.doe@example.com"

​
metadata
object

Mapa chave-valor opcional para armazenar atributos personalizados.

Resposta

Entry PIX criada com sucesso.

​
id
string

Identificador único da entrada (formato UUID).

Exemplo:

"019c96a0-0c0c-7221-8cf3-13313fb60081"

​
key
string

Valor da chave PIX.

Exemplo:

"john.doe@example.com"

​
keyType
string

Tipo de chave PIX.

Exemplo:

"EMAIL"

​
status
string

Status da entrada (ACTIVE, INACTIVE).

Exemplo:

"ACTIVE"

​
account
object
​
owner
object
​
createdAt
string<date-time>

Timestamp de criação.

Exemplo:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>

Timestamp da última atualização.

Exemplo:

"2024-01-15T10:30:00Z"