Crear una entrada

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

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)

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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'keyType' => 'EMAIL',
    'key' => 'john.doe@example.com'
  ]),
  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"

	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))

}

HttpResponse<String> response = Unirest.post("https://plugin-pix-indirect.api.lerian.net/v1/dict/entries")
  .header("X-Account-Id", "<x-account-id>")
  .header("X-Reason", "<x-reason>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"keyType\": \"EMAIL\",\n  \"key\": \"john.doe@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.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  \"keyType\": \"EMAIL\",\n  \"key\": \"john.doe@example.com\"\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"
}

Crear una entrada

Usa este endpoint para crear una nueva entrada Pix asociada a una cuenta y sus datos.

Este servicio no realiza las siguientes validaciones y asume que el cliente las completó antes de hacer la solicitud:

Validación con la Receita Federal: el servicio no valida los datos con la Receita Federal. Se asume que el cliente ya realizó la validación necesaria con un proveedor debidamente contratado e integrado a las APIs de la RFB.
Autenticación de titularidad por MFA: el servicio asume que la autenticación multifactor (MFA) para la verificación de titularidad se completó previamente antes de hacer la solicitud.

POST

dict

entries

Crear una entrada

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

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)

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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'keyType' => 'EMAIL',
    'key' => 'john.doe@example.com'
  ]),
  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"

	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))

}

HttpResponse<String> response = Unirest.post("https://plugin-pix-indirect.api.lerian.net/v1/dict/entries")
  .header("X-Account-Id", "<x-account-id>")
  .header("X-Reason", "<x-reason>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"keyType\": \"EMAIL\",\n  \"key\": \"john.doe@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.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  \"keyType\": \"EMAIL\",\n  \"key\": \"john.doe@example.com\"\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"
}

Autorizaciones

Authorization

string

header

requerido

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

Encabezados

X-Account-Id

string

requerido

Identificador único de la cuenta del Ledger de Midaz (formato UUID).

X-Reason

enum<string>

requerido

Motivo de la creación del registro.

Opciones disponibles:

USER_REQUESTED,

RECONCILIATION

Cuerpo

application/json

keyType

enum<string>

requerido

Tipo de clave Pix que se está creando.

Opciones disponibles:

EMAIL,

PHONE,

CPF,

CNPJ,

EVP

Ejemplo:

"EMAIL"

key

string

Valor de la clave Pix que se está registrando (por ejemplo, dirección de correo electrónico, teléfono o CPF). No es obligatorio para el tipo EVP.

Ejemplo:

"john.doe@example.com"

metadata

object

Mapa opcional de clave-valor para almacenar atributos personalizados.

Show child attributes

Respuesta

Entrada Pix creada correctamente.

string

Identificador único del registro (formato UUID).

Ejemplo:

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

key

string

Valor de la clave Pix.

Ejemplo:

"john.doe@example.com"

keyType

string

Tipo de clave Pix.

Ejemplo:

"EMAIL"

status

string

Estado del registro (ACTIVE, INACTIVE).

Ejemplo:

"ACTIVE"

account

object

Show child attributes

owner

object

Show child attributes

createdAt

string<date-time>

Marca de tiempo de creación.

Ejemplo:

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

updatedAt

string<date-time>

Marca de tiempo de la última actualización.

Ejemplo:

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

Verificar la existencia de claves

Eliminar una entrada

⌘I