Create a Pix 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 @- <<EOF
{
  "keyType": "EMAIL",
  "account": {
    "branch": "0001",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "number": "123456789",
    "openingDate": "2020-01-15T10:30:00Z",
    "participant": "30306294",
    "type": "TRAN"
  },
  "holder": {
    "document": "52998224725",
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "John Doe",
    "personType": "NATURAL_PERSON",
    "tradeName": "John's Business"
  },
  "key": "john.doe@example.com",
  "keyCreationDate": "2024-01-15T10:30:00Z",
  "keyOwnershipDate": "2024-01-15T10:30:00Z",
  "metadata": {},
  "requestId": "680e8400-e29b-41d4-a716-446655440002"
}
EOF

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  \"account\": {\n    \"branch\": \"0001\",\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"number\": \"123456789\",\n    \"openingDate\": \"2020-01-15T10:30:00Z\",\n    \"participant\": \"30306294\",\n    \"type\": \"TRAN\"\n  },\n  \"holder\": {\n    \"document\": \"52998224725\",\n    \"id\": \"550e8400-e29b-41d4-a716-446655440001\",\n    \"name\": \"John Doe\",\n    \"personType\": \"NATURAL_PERSON\",\n    \"tradeName\": \"John's Business\"\n  },\n  \"key\": \"john.doe@example.com\",\n  \"keyCreationDate\": \"2024-01-15T10:30:00Z\",\n  \"keyOwnershipDate\": \"2024-01-15T10:30:00Z\",\n  \"metadata\": {},\n  \"requestId\": \"680e8400-e29b-41d4-a716-446655440002\"\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',
    account: {
      branch: '0001',
      id: '550e8400-e29b-41d4-a716-446655440000',
      number: '123456789',
      openingDate: '2020-01-15T10:30:00Z',
      participant: '30306294',
      type: 'TRAN'
    },
    holder: {
      document: '52998224725',
      id: '550e8400-e29b-41d4-a716-446655440001',
      name: 'John Doe',
      personType: 'NATURAL_PERSON',
      tradeName: 'John\'s Business'
    },
    key: 'john.doe@example.com',
    keyCreationDate: '2024-01-15T10:30:00Z',
    keyOwnershipDate: '2024-01-15T10:30:00Z',
    metadata: {},
    requestId: '680e8400-e29b-41d4-a716-446655440002'
  })
};

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",
    "account": {
        "branch": "0001",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "number": "123456789",
        "openingDate": "2020-01-15T10:30:00Z",
        "participant": "30306294",
        "type": "TRAN"
    },
    "holder": {
        "document": "52998224725",
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "name": "John Doe",
        "personType": "NATURAL_PERSON",
        "tradeName": "John's Business"
    },
    "key": "john.doe@example.com",
    "keyCreationDate": "2024-01-15T10:30:00Z",
    "keyOwnershipDate": "2024-01-15T10:30:00Z",
    "metadata": {},
    "requestId": "680e8400-e29b-41d4-a716-446655440002"
}
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)

{
  "account": {
    "branch": "0001",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "number": "123456789",
    "openingDate": "2020-01-15T10:30:00Z",
    "participant": "12345678",
    "type": "TRAN"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "holderId": "550e8400-e29b-41d4-a716-446655440001",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "keyCreationDate": "2024-01-15T10:30:00Z",
  "keyOwnershipDate": "2024-01-15T10:30:00Z",
  "keyType": "EMAIL",
  "keyValue": "john.doe@example.com",
  "owner": {
    "document": "52998224725",
    "name": "John Doe",
    "tradeName": "John's Business",
    "type": "NATURAL_PERSON"
  },
  "requestId": "680e8400-e29b-41d4-a716-446655440002",
  "status": "ACTIVE",
  "updatedAt": "2024-01-20T14:45:00Z",
  "metadata": {}
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

POST

dict

entries

Create a Pix 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 @- <<EOF
{
  "keyType": "EMAIL",
  "account": {
    "branch": "0001",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "number": "123456789",
    "openingDate": "2020-01-15T10:30:00Z",
    "participant": "30306294",
    "type": "TRAN"
  },
  "holder": {
    "document": "52998224725",
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "John Doe",
    "personType": "NATURAL_PERSON",
    "tradeName": "John's Business"
  },
  "key": "john.doe@example.com",
  "keyCreationDate": "2024-01-15T10:30:00Z",
  "keyOwnershipDate": "2024-01-15T10:30:00Z",
  "metadata": {},
  "requestId": "680e8400-e29b-41d4-a716-446655440002"
}
EOF

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  \"account\": {\n    \"branch\": \"0001\",\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"number\": \"123456789\",\n    \"openingDate\": \"2020-01-15T10:30:00Z\",\n    \"participant\": \"30306294\",\n    \"type\": \"TRAN\"\n  },\n  \"holder\": {\n    \"document\": \"52998224725\",\n    \"id\": \"550e8400-e29b-41d4-a716-446655440001\",\n    \"name\": \"John Doe\",\n    \"personType\": \"NATURAL_PERSON\",\n    \"tradeName\": \"John's Business\"\n  },\n  \"key\": \"john.doe@example.com\",\n  \"keyCreationDate\": \"2024-01-15T10:30:00Z\",\n  \"keyOwnershipDate\": \"2024-01-15T10:30:00Z\",\n  \"metadata\": {},\n  \"requestId\": \"680e8400-e29b-41d4-a716-446655440002\"\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',
    account: {
      branch: '0001',
      id: '550e8400-e29b-41d4-a716-446655440000',
      number: '123456789',
      openingDate: '2020-01-15T10:30:00Z',
      participant: '30306294',
      type: 'TRAN'
    },
    holder: {
      document: '52998224725',
      id: '550e8400-e29b-41d4-a716-446655440001',
      name: 'John Doe',
      personType: 'NATURAL_PERSON',
      tradeName: 'John\'s Business'
    },
    key: 'john.doe@example.com',
    keyCreationDate: '2024-01-15T10:30:00Z',
    keyOwnershipDate: '2024-01-15T10:30:00Z',
    metadata: {},
    requestId: '680e8400-e29b-41d4-a716-446655440002'
  })
};

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",
    "account": {
        "branch": "0001",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "number": "123456789",
        "openingDate": "2020-01-15T10:30:00Z",
        "participant": "30306294",
        "type": "TRAN"
    },
    "holder": {
        "document": "52998224725",
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "name": "John Doe",
        "personType": "NATURAL_PERSON",
        "tradeName": "John's Business"
    },
    "key": "john.doe@example.com",
    "keyCreationDate": "2024-01-15T10:30:00Z",
    "keyOwnershipDate": "2024-01-15T10:30:00Z",
    "metadata": {},
    "requestId": "680e8400-e29b-41d4-a716-446655440002"
}
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)

{
  "account": {
    "branch": "0001",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "number": "123456789",
    "openingDate": "2020-01-15T10:30:00Z",
    "participant": "12345678",
    "type": "TRAN"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "holderId": "550e8400-e29b-41d4-a716-446655440001",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "keyCreationDate": "2024-01-15T10:30:00Z",
  "keyOwnershipDate": "2024-01-15T10:30:00Z",
  "keyType": "EMAIL",
  "keyValue": "john.doe@example.com",
  "owner": {
    "document": "52998224725",
    "name": "John Doe",
    "tradeName": "John's Business",
    "type": "NATURAL_PERSON"
  },
  "requestId": "680e8400-e29b-41d4-a716-446655440002",
  "status": "ACTIVE",
  "updatedAt": "2024-01-20T14:45:00Z",
  "metadata": {}
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id

string<uuid>

required

Account ID (UUID format)

X-Reason

enum<string>

required

Reason for creating the entry. Valid values: USER_REQUESTED, RECONCILIATION

Available options:

USER_REQUESTED,

RECONCILIATION

Body

application/json

keyType

enum<string>

required

Type of Pix key being created

Available options:

EMAIL,

PHONE,

CPF,

CNPJ,

EVP

Minimum string length: 1

Example:

"EMAIL"

account

object

Pre-populated account data for reconciliation mode

Show child attributes

holder

object

Pre-populated holder data for reconciliation mode

Show child attributes

key

string

Pix key value to register (email, phone, CPF, CNPJ, or EVP)

Example:

"john.doe@example.com"

keyCreationDate

string<date-time>

Original key creation date from BTG DICT (reconciliation mode)

Example:

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

keyOwnershipDate

string<date-time>

Date when ownership was established from BTG DICT (reconciliation mode)

Example:

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

metadata

object

Optional key-value map for storing custom attributes

Show child attributes

requestId

string

Unique request identifier from BTG VSync data (for idempotency during reconciliation)

Example:

"680e8400-e29b-41d4-a716-446655440002"

Response

Created

account

object

required

Account information associated with this Pix key

Show child attributes

createdAt

string<date-time>

required

Timestamp when the entity was created

Example:

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

holderId

string

required

Unique identifier of the customer who owns this Pix key

Example:

"550e8400-e29b-41d4-a716-446655440001"

string

required

Unique identifier of the Pix key entry

Example:

"550e8400-e29b-41d4-a716-446655440010"

keyCreationDate

string<date-time>

required

Date when this Pix key was created on DICT

Example:

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

keyOwnershipDate

string<date-time>

required

Date when the customer became the owner of this Pix key

Example:

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

keyType

enum<string>

required

Type of Pix key that was created

Available options:

EMAIL,

PHONE,

CPF,

CNPJ,

EVP

Example:

"EMAIL"

keyValue

string

required

Pix key value that was registered

Example:

"john.doe@example.com"

owner

object

required

Owner information associated with this Pix key

Show child attributes

requestId

string

required

Unique identifier for this creation request (for idempotency)

Example:

"680e8400-e29b-41d4-a716-446655440002"

status

enum<string>

required

Operational status of this Pix key

Available options:

ACTIVE,

INACTIVE

Example:

"ACTIVE"

updatedAt

string<date-time>

required

Timestamp when the entity was last updated

Example:

"2024-01-20T14:45:00Z"

metadata

object

Custom key-value attributes associated with this entry

Show child attributes

DICT API

Claims API

MED · Infractions

MED · Fraud markers

MED · Refund requests

MED · Statistics

Transactions API

QR Codes API

Collections API

Funds Recovery API

Reconciliation API

Pix Automático API

Schedules API

Transaction Reports API

Transaction times

Webhooks API

Error handling

Create a Pix Entry

Authorizations

Headers

Body

Response