Create an 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"
}
'

package main

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

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries"

	payload := strings.NewReader("{\n  \"keyType\": \"EMAIL\",\n  \"key\": \"john.doe@example.com\"\n}")

	req, _ := http.NewRequest("POST", 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))

}

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    'X-Reason': '<x-reason>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({keyType: 'EMAIL', key: 'john.doe@example.com'})
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries"

payload = {
    "keyType": "EMAIL",
    "key": "john.doe@example.com"
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "X-Reason": "<x-reason>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "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"
}

Create an Entry

Use this endpoint to create a new Pix entry associated with an account and its data.

This service does not perform the following validations and assumes they have been completed by the client before making the request:

Receita Federal Validation: The service does not validate data with Receita Federal. It is assumed that the client has already performed the necessary validation with a properly contracted provider integrated to RFB APIs.
MFA Ownership Authentication: The service assumes that Multi-Factor Authentication (MFA) for ownership verification has been previously completed before the request is made.

POST

/

v1

/

dict

/

entries

Create an 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"
}
'

package main

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

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries"

	payload := strings.NewReader("{\n  \"keyType\": \"EMAIL\",\n  \"key\": \"john.doe@example.com\"\n}")

	req, _ := http.NewRequest("POST", 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))

}

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    'X-Reason': '<x-reason>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({keyType: 'EMAIL', key: 'john.doe@example.com'})
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries"

payload = {
    "keyType": "EMAIL",
    "key": "john.doe@example.com"
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "X-Reason": "<x-reason>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "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

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

X-Account-Id

string

obrigatório

Unique identifier of the Midaz Ledger Account (UUID format).

X-Reason

enum<string>

obrigatório

Reason for creating the entry.

Opções disponíveis:

USER_REQUESTED,

RECONCILIATION

Corpo

application/json

keyType

enum<string>

obrigatório

Type of Pix key being created.

Opções disponíveis:

EMAIL,

PHONE,

CPF,

CNPJ,

EVP

Exemplo:

"EMAIL"

key

string

Pix key value being registered (e.g., email address, phone, or CPF). Not required for EVP type.

Exemplo:

"john.doe@example.com"

metadata

object

Optional key-value map for storing custom attributes.

Show child attributes

Resposta

Pix entry created successfully.

id

string

Unique identifier of the entry (UUID format).

Exemplo:

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

key

string

Pix key value.

Exemplo:

"john.doe@example.com"

keyType

string

Type of Pix key.

Exemplo:

"EMAIL"

status

string

Entry status (ACTIVE, INACTIVE).

Exemplo:

"ACTIVE"

account

object

Show child attributes

owner

object

Show child attributes

createdAt

string<date-time>

Creation timestamp.

Exemplo:

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

updatedAt

string<date-time>

Last update timestamp.

Exemplo:

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