Create a Pix Entry

curl --request POST \
  --url https://api.example.com/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://api.example.com/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://api.example.com/v1/dict/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/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://api.example.com/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://api.example.com/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://api.example.com/v1/dict/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/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>"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id

string<uuid>

requerido

Account ID (UUID format)

X-Reason

enum<string>

requerido

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

Opciones disponibles:

USER_REQUESTED,

RECONCILIATION

Cuerpo

application/json

keyType

enum<string>

requerido

Type of Pix key being created

Opciones disponibles:

EMAIL,

PHONE,

CPF,

CNPJ,

EVP

Minimum string length: 1

Ejemplo:

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

Ejemplo:

"john.doe@example.com"

keyCreationDate

string<date-time>

Original key creation date from BTG DICT (reconciliation mode)

Ejemplo:

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

keyOwnershipDate

string<date-time>

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

Ejemplo:

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

Ejemplo:

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

Respuesta

Created

account

object

requerido

Account information associated with this Pix key

Show child attributes

createdAt

string<date-time>

requerido

Timestamp when the entity was created

Ejemplo:

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

holderId

string

requerido

Unique identifier of the customer who owns this Pix key

Ejemplo:

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

string

requerido

Unique identifier of the Pix key entry

Ejemplo:

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

keyCreationDate

string<date-time>

requerido

Date when this Pix key was created on DICT

Ejemplo:

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

keyOwnershipDate

string<date-time>

requerido

Date when the customer became the owner of this Pix key

Ejemplo:

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

keyType

enum<string>

requerido

Type of Pix key that was created

Opciones disponibles:

EMAIL,

PHONE,

CPF,

CNPJ,

EVP

Ejemplo:

"EMAIL"

keyValue

string

requerido

Pix key value that was registered

Ejemplo:

"john.doe@example.com"

owner

object

requerido

Owner information associated with this Pix key

Show child attributes

requestId

string

requerido

Unique identifier for this creation request (for idempotency)

Ejemplo:

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

status

enum<string>

requerido

Operational status of this Pix key

Opciones disponibles:

ACTIVE,

INACTIVE

Ejemplo:

"ACTIVE"

updatedAt

string<date-time>

requerido

Timestamp when the entity was last updated

Ejemplo:

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

metadata

object

Custom key-value attributes associated with this entry

Show child attributes

API de DICT

API de Reclamaciones

MED · Infracciones

MED · Marcadores de fraude

MED · Solicitudes de devolución

MED · Estadísticas

API de Transacciones

API de Códigos QR

API de Cobros

API de Recuperación de Fondos

API de Conciliación

API de Pix Automático

API de Programaciones

API de Informes de Transacción

Tiempos de transacciones

API de Webhooks

Manejo de errores

Eventos

Create a Pix Entry

Autorizaciones

Encabezados

Cuerpo

Respuesta