Create a Pix key entry

curl --request POST \
  --url https://api.example.com/dict-hub/v1/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --header 'X-Reason: <x-reason>' \
  --data '
{
  "keyType": "CPF",
  "keyValue": "52998224725",
  "metadata": {
    "source": "mobile"
  }
}
'

package main

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

func main() {

	url := "https://api.example.com/dict-hub/v1/entries"

	payload := strings.NewReader("{\n  \"keyType\": \"CPF\",\n  \"keyValue\": \"52998224725\",\n  \"metadata\": {\n    \"source\": \"mobile\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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-Idempotency': '<x-idempotency>',
    'X-Account-Id': '<x-account-id>',
    'X-Reason': '<x-reason>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({keyType: 'CPF', keyValue: '52998224725', metadata: {source: 'mobile'}})
};

fetch('https://api.example.com/dict-hub/v1/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/dict-hub/v1/entries"

payload = {
    "keyType": "CPF",
    "keyValue": "52998224725",
    "metadata": { "source": "mobile" }
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "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",
    "number": "0007654321",
    "participant": "12345678",
    "type": "CACC",
    "openingDate": "2010-01-10T03:00:00Z"
  },
  "createdAt": "2019-11-18T03:00:00Z",
  "holderId": "019606e5-7f80-9102-3d45-678901234ef0",
  "id": "019606c3-5d6e-7f80-1b23-456789012cde",
  "keyCreationDate": "2019-11-18T03:00:00Z",
  "keyOwnershipDate": "2019-11-18T03:00:00Z",
  "keyType": "CPF",
  "keyValue": "52998224725",
  "organizationId": "019606d4-6e7f-8091-2c34-567890123def",
  "owner": {
    "document": "52998224725",
    "name": "João Silva",
    "personType": "NATURAL",
    "tradeName": "Silva ME"
  },
  "requestId": "a946d533-7f22-42a5-9a9b-e87cd55c0f4d",
  "status": "ACTIVE",
  "updatedAt": "2019-11-18T03:00:00Z",
  "metadata": {}
}

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The Idempotency-Key header is required for this operation and must be within the accepted length."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0102",
  "title": "Conflict",
  "status": 409,
  "detail": "Key value is already registered.",
  "code": "PIX-0102"
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The Idempotency-Key was already used with a different request."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0100",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Missing or malformed required fields.",
  "code": "PIX-0100"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "internal error",
  "code": "PIX-0000"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0140",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "internal error",
  "code": "PIX-0140"
}

{
  "code": "PIX-0032",
  "title": "Idempotency Unavailable",
  "message": "The request was not processed because the idempotency store is unavailable. Please retry."
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

POST

entries

Create a Pix key entry

curl --request POST \
  --url https://api.example.com/dict-hub/v1/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --header 'X-Reason: <x-reason>' \
  --data '
{
  "keyType": "CPF",
  "keyValue": "52998224725",
  "metadata": {
    "source": "mobile"
  }
}
'

package main

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

func main() {

	url := "https://api.example.com/dict-hub/v1/entries"

	payload := strings.NewReader("{\n  \"keyType\": \"CPF\",\n  \"keyValue\": \"52998224725\",\n  \"metadata\": {\n    \"source\": \"mobile\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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-Idempotency': '<x-idempotency>',
    'X-Account-Id': '<x-account-id>',
    'X-Reason': '<x-reason>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({keyType: 'CPF', keyValue: '52998224725', metadata: {source: 'mobile'}})
};

fetch('https://api.example.com/dict-hub/v1/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/dict-hub/v1/entries"

payload = {
    "keyType": "CPF",
    "keyValue": "52998224725",
    "metadata": { "source": "mobile" }
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "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",
    "number": "0007654321",
    "participant": "12345678",
    "type": "CACC",
    "openingDate": "2010-01-10T03:00:00Z"
  },
  "createdAt": "2019-11-18T03:00:00Z",
  "holderId": "019606e5-7f80-9102-3d45-678901234ef0",
  "id": "019606c3-5d6e-7f80-1b23-456789012cde",
  "keyCreationDate": "2019-11-18T03:00:00Z",
  "keyOwnershipDate": "2019-11-18T03:00:00Z",
  "keyType": "CPF",
  "keyValue": "52998224725",
  "organizationId": "019606d4-6e7f-8091-2c34-567890123def",
  "owner": {
    "document": "52998224725",
    "name": "João Silva",
    "personType": "NATURAL",
    "tradeName": "Silva ME"
  },
  "requestId": "a946d533-7f22-42a5-9a9b-e87cd55c0f4d",
  "status": "ACTIVE",
  "updatedAt": "2019-11-18T03:00:00Z",
  "metadata": {}
}

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The Idempotency-Key header is required for this operation and must be within the accepted length."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0102",
  "title": "Conflict",
  "status": 409,
  "detail": "Key value is already registered.",
  "code": "PIX-0102"
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The Idempotency-Key was already used with a different request."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0100",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Missing or malformed required fields.",
  "code": "PIX-0100"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "internal error",
  "code": "PIX-0000"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0140",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "internal error",
  "code": "PIX-0140"
}

{
  "code": "PIX-0032",
  "title": "Idempotency Unavailable",
  "message": "The request was not processed because the idempotency store is unavailable. Please retry."
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency

string

requerido

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Replaying the same key with a divergent method, URL or body is PIX-0031 @ 412.

Required string length: 1 - 64

X-Account-Id

string

requerido

Account ID (UUID format)

Ejemplo:

"019606a1-3b4c-7d8e-9f01-234567890abc"

X-Reason

string

requerido

Reason for creating the entry: USER_REQUESTED or RECONCILIATION

Ejemplo:

"USER_REQUESTED"

Cuerpo

application/json

keyType

string

requerido

Pix key type

Ejemplo:

"CPF"

keyValue

string

Pix key value

Ejemplo:

"52998224725"

metadata

object

Free-form, single-level key/value pairs persisted with the entry. Keys up to 100 characters, values up to 2000 characters, at most 25 entries; nested objects are rejected.

Show child attributes

Ejemplo:

{ "source": "mobile" }

Respuesta

Created

account

object

requerido

Show child attributes

createdAt

string<date-time>

requerido

Ejemplo:

"2019-11-18T03:00:00Z"

holderId

string

requerido

Ejemplo:

"019606e5-7f80-9102-3d45-678901234ef0"

string

requerido

Ejemplo:

"019606c3-5d6e-7f80-1b23-456789012cde"

keyCreationDate

string<date-time>

requerido

Ejemplo:

"2019-11-18T03:00:00Z"

keyOwnershipDate

string<date-time>

requerido

Ejemplo:

"2019-11-18T03:00:00Z"

keyType

string

requerido

Ejemplo:

"CPF"

keyValue

string

requerido

Ejemplo:

"52998224725"

organizationId

string

requerido

Ejemplo:

"019606d4-6e7f-8091-2c34-567890123def"

owner

object

requerido

Show child attributes

requestId

string

requerido

Ejemplo:

"a946d533-7f22-42a5-9a9b-e87cd55c0f4d"

status

string

requerido

Ejemplo:

"ACTIVE"

updatedAt

string<date-time>

requerido

Ejemplo:

"2019-11-18T03:00:00Z"

metadata

object

Show child attributes

DICT y claves Pix

Cobros y códigos BR

Pagos y devoluciones

Manejo de errores

Create a Pix key entry

Autorizaciones

Encabezados

Cuerpo

Respuesta