> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Create a Pix Entry > Use this endpoint to create a new Pix entry associated with an account and its data. ## OpenAPI ````yaml /pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/entries openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- API for Pix Indirect via BTG. It covers DICT keys and claims; MED infraction reports, fraud markers, refund requests, and funds recoveries; DICT statistics and reconciliation; Pix transfers, refunds, and schedules; static QR codes and QR code decoding; immediate and due-date collections; Pix Automático for the payer; transaction reports and TemposTransacoes statistics; and inbound and outbound webhook records. license: name: Lerian Studio General License title: Pix BTG API version: 1.14.0 servers: - url: https://api.example.com description: >- Replace the example host with the URL provided during environment onboarding. security: - BearerAuth: [] paths: /v1/dict/entries: post: tags: - Entries summary: Create a Pix Entry description: >- Use this endpoint to create a new Pix entry associated with an account and its data. operationId: dict-create-entry parameters: - description: Account ID (UUID format) in: header name: X-Account-Id required: true schema: description: Account ID (UUID format) format: uuid type: string - description: >- Reason for creating the entry. Valid values: USER_REQUESTED, RECONCILIATION in: header name: X-Reason required: true schema: description: >- Reason for creating the entry. Valid values: USER_REQUESTED, RECONCILIATION enum: - USER_REQUESTED - RECONCILIATION type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEntryInput' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/EntryOutput' description: Created '400': content: application/json: schema: $ref: '#/components/schemas/LegacyErrorBody' description: Bad Request '413': content: application/json: schema: $ref: '#/components/schemas/LegacyErrorBody' description: Request Entity Too Large '500': content: application/json: schema: $ref: '#/components/schemas/LegacyErrorBody' description: Internal Server Error default: content: application/json: schema: $ref: '#/components/schemas/LegacyErrorBody' description: Error components: schemas: CreateEntryInput: additionalProperties: false properties: account: $ref: '#/components/schemas/ReconciliationAccountInput' description: Pre-populated account data for reconciliation mode holder: $ref: '#/components/schemas/ReconciliationHolderInput' description: Pre-populated holder data for reconciliation mode key: description: Pix key value to register (email, phone, CPF, CNPJ, or EVP) examples: - john.doe@example.com type: string keyCreationDate: description: Original key creation date from BTG DICT (reconciliation mode) examples: - '2024-01-15T10:30:00Z' format: date-time type: string keyOwnershipDate: description: >- Date when ownership was established from BTG DICT (reconciliation mode) examples: - '2024-01-15T10:30:00Z' format: date-time type: string keyType: description: Type of Pix key being created enum: - EMAIL - PHONE - CPF - CNPJ - EVP examples: - EMAIL minLength: 1 type: string metadata: additionalProperties: {} description: Optional key-value map for storing custom attributes type: object requestId: description: >- Unique request identifier from BTG VSync data (for idempotency during reconciliation) examples: - 680e8400-e29b-41d4-a716-446655440002 type: string required: - keyType type: object EntryOutput: additionalProperties: false properties: account: $ref: '#/components/schemas/AccountOutput' description: Account information associated with this Pix key createdAt: description: Timestamp when the entity was created examples: - '2024-01-15T10:30:00Z' format: date-time type: string holderId: description: Unique identifier of the customer who owns this Pix key examples: - 550e8400-e29b-41d4-a716-446655440001 type: string id: description: Unique identifier of the Pix key entry examples: - 550e8400-e29b-41d4-a716-446655440010 type: string keyCreationDate: description: Date when this Pix key was created on DICT examples: - '2024-01-15T10:30:00Z' format: date-time type: string keyOwnershipDate: description: Date when the customer became the owner of this Pix key examples: - '2024-01-15T10:30:00Z' format: date-time type: string keyType: description: Type of Pix key that was created enum: - EMAIL - PHONE - CPF - CNPJ - EVP examples: - EMAIL type: string keyValue: description: Pix key value that was registered examples: - john.doe@example.com type: string metadata: additionalProperties: {} description: Custom key-value attributes associated with this entry type: object owner: $ref: '#/components/schemas/OwnerOutput' description: Owner information associated with this Pix key requestId: description: Unique identifier for this creation request (for idempotency) examples: - 680e8400-e29b-41d4-a716-446655440002 type: string status: description: Operational status of this Pix key enum: - ACTIVE - INACTIVE examples: - ACTIVE type: string updatedAt: description: Timestamp when the entity was last updated examples: - '2024-01-20T14:45:00Z' format: date-time type: string required: - id - keyValue - keyType - account - owner - holderId - keyCreationDate - keyOwnershipDate - requestId - status - createdAt - updatedAt type: object LegacyErrorBody: additionalProperties: false properties: code: type: string fields: additionalProperties: type: string type: object headers: additionalProperties: type: string type: object message: type: string paths: additionalProperties: type: string type: object queryParams: additionalProperties: type: string type: object raw: type: string title: type: string required: - code - title - message type: object ReconciliationAccountInput: additionalProperties: true properties: branch: description: Bank branch code where the account is held examples: - '0001' type: string id: description: Unique identifier of the customer account (reconciliation mode) examples: - 550e8400-e29b-41d4-a716-446655440000 type: string number: description: Unique account number at the institution examples: - '123456789' type: string openingDate: description: Date when the account was opened examples: - '2020-01-15T10:30:00Z' format: date-time type: string participant: description: ISPB of the participant institution (8 alphanumeric characters) examples: - '30306294' type: string type: description: Kind of account holding this Pix key examples: - TRAN type: string type: object ReconciliationHolderInput: additionalProperties: true properties: document: description: Holder's CPF or CNPJ document examples: - '52998224725' type: string id: description: Unique identifier of the holder in CRM (reconciliation mode) examples: - 550e8400-e29b-41d4-a716-446655440001 type: string name: description: Holder's full name or company name examples: - John Doe type: string personType: description: 'Person type: NATURAL_PERSON or LEGAL_PERSON' examples: - NATURAL_PERSON type: string tradeName: description: Business trade name (for LEGAL_PERSON) examples: - John's Business type: string type: object AccountOutput: additionalProperties: false properties: branch: description: Bank branch code where the account is held (4 digits) examples: - '0001' type: string id: description: Unique identifier of the customer account examples: - 550e8400-e29b-41d4-a716-446655440000 type: string number: description: >- Unique account number at the institution, as sent to DICT: 1-20 uppercase letters or digits, ending in a digit examples: - '123456789' type: string openingDate: description: Date when the account was opened examples: - '2020-01-15T10:30:00Z' format: date-time type: string participant: description: >- ISPB of the participant institution (8 uppercase alphanumeric characters) examples: - '12345678' type: string type: description: Kind of account holding this Pix key enum: - CACC - SLRY - SVGS - TRAN - OTHR examples: - TRAN type: string required: - id - participant - branch - number - type - openingDate type: object OwnerOutput: additionalProperties: false properties: document: description: Identification document of the account owner (CPF or CNPJ) examples: - '52998224725' type: string name: description: Full name or registered name of the account owner examples: - John Doe type: string tradeName: description: Business trade name or commercial alias examples: - John's Business type: string type: description: Whether the account owner is a person or organization enum: - NATURAL_PERSON - LEGAL_PERSON examples: - NATURAL_PERSON type: string required: - type - document - name - tradeName type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.