> ## 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.

# Crear un cobro inmediato

> Usa este endpoint para crear un cobro Pix inmediato (cobrança imediata) con un código QR dinámico que expira después de un período definido.

**Notas:**
- Cada cobro inmediato es único y solo se puede pagar una vez
- El monto y el tiempo de expiración son obligatorios
- El ID de transacción (txId) debe ser único entre todos los cobros
- El estado pasa automáticamente a CONCLUDED cuando se recibe el pago
- El cobro expira automáticamente después del período de tiempo especificado



## OpenAPI

````yaml es/openapi/v3-current/indirect-pix.yaml POST /v1/collections/immediate
openapi: 3.0.3
info:
  title: Plugin BR Pix Indirect - API completa
  description: |
    API completa para el sistema de pagos instantáneos Pix de Brasil, que
    incluye operaciones del diccionario de claves Pix, generación/decodificación
    de códigos QR, transacciones y límites transaccionales.
  version: 1.0.0
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/collections/immediate:
    post:
      tags:
        - Collections API
      summary: Crear un cobro inmediato
      description: >-
        Usa este endpoint para crear un cobro Pix inmediato (cobrança imediata)
        con un código QR dinámico que expira después de un período definido.


        **Notas:**

        - Cada cobro inmediato es único y solo se puede pagar una vez

        - El monto y el tiempo de expiración son obligatorios

        - El ID de transacción (txId) debe ser único entre todos los cobros

        - El estado pasa automáticamente a CONCLUDED cuando se recibe el pago

        - El cobro expira automáticamente después del período de tiempo
        especificado
      parameters:
        - name: X-Account-Id
          in: header
          description: ID de la cuenta (formato UUID)
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateImmediateCollectionInput'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImmediateCollectionOutput'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
      deprecated: false
      security:
        - bearerAuth: []
components:
  schemas:
    CreateImmediateCollectionInput:
      properties:
        additionalInfo:
          additionalProperties:
            type: string
          description: AdditionalInfo es un mapa de clave-valor para información adicional
          example:
            customerId: '67890'
            orderId: '12345'
          type: object
        amount:
          description: Amount es el monto de la cobranza en formato decimal con 2 decimales
          example: '100.00'
          type: string
        debtorDocument:
          description: >-
            DebtorDocument es el CPF o CNPJ del pagador (opcional, debe
            proporcionarse junto con DebtorName)
          example: '12345678901'
          type: string
        debtorName:
          description: >-
            DebtorName es el nombre del pagador (opcional, debe proporcionarse
            junto con DebtorDocument)
          example: João da Silva
          type: string
        description:
          description: >-
            Description es un mensaje o descripción personalizada para la
            cobranza
          example: 'Payment for order #12345'
          type: string
        expirationSeconds:
          description: >-
            ExpirationSeconds es el tiempo en segundos hasta que la cobranza
            expira
          example: 3600
          type: integer
        locationInformation:
          allOf:
            - $ref: '#/components/schemas/LocationInformationDTO'
          description: >-
            LocationInformation contiene los datos de ubicación del comerciante
            para la generación del código QR
        metadata:
          additionalProperties: {}
          description: >-
            Metadata es un mapa opcional para pares clave-valor personalizados
            (máx. 50 claves)
          type: object
        receiverKey:
          description: Clave Pix que recibirá el pago
          example: '+5511999999999'
          type: string
        tags:
          description: Tags es un arreglo de etiquetas personalizadas para categorización
          example:
            - ecommerce
            - subscription
          items:
            type: string
          type: array
        transactionAmount:
          description: Monto de la compra para Pix Troco (servicio de cambio)
          example: '150.00'
          type: string
        txId:
          description: TxID es el identificador único de transacción para esta cobranza
          example: TXabcdefghijklmno123456789
          type: string
        withdrawalAmount:
          description: Monto de retiro para Pix Saque o Pix Troco
          example: '50.00'
          type: string
      required:
        - amount
        - expirationSeconds
        - receiverKey
        - txId
      type: object
    ImmediateCollectionOutput:
      properties:
        additionalInfo:
          additionalProperties:
            type: string
          description: AdditionalInfo contiene información adicional de clave-valor
          example:
            customerId: '67890'
            orderId: '12345'
          type: object
        amount:
          description: Amount es el monto de la cobranza en formato decimal
          example: '100.00'
          type: string
        createdAt:
          description: CreatedAt es la marca de tiempo en que se creó la cobranza
          example: '2024-01-15T10:30:00Z'
          type: string
        debtorDocument:
          description: DebtorDocument es el CPF o CNPJ del pagador
          example: '12345678901'
          type: string
        debtorName:
          description: DebtorName es el nombre del pagador
          example: João da Silva
          type: string
        description:
          description: Description es la descripción personalizada de la cobranza
          example: 'Payment for order #12345'
          type: string
        emv:
          description: EMV es el payload del código QR en formato EMV
          example: 00020126580014br.gov.bcb.pix...
          type: string
        expirationSeconds:
          description: ExpirationSeconds es el tiempo en segundos hasta la expiración
          example: 3600
          type: integer
        id:
          description: ID es el identificador único de la cobranza
          example: 550e8400-e29b-41d4-a716-446655440000
          type: string
        locationUrl:
          description: >-
            LocationURL es la URL para acceder a la ubicación/código QR de la
            cobranza
          example: https://api.example.com/qr/550e8400
          type: string
        metadata:
          additionalProperties: {}
          description: >-
            Metadata son los metadatos personalizados asociados con esta
            cobranza
          type: object
        receiverKey:
          description: Clave Pix que recibirá el pago
          example: '+5511999999999'
          type: string
        status:
          description: Status es el estado actual de la cobranza
          example: ACTIVE
          type: string
        tags:
          description: Tags es un arreglo de etiquetas personalizadas
          example:
            - ecommerce
            - subscription
          items:
            type: string
          type: array
        txId:
          description: TxID es el identificador de la transacción
          example: TXN123456789
          type: string
        updatedAt:
          description: UpdatedAt es la marca de tiempo de la última actualización
          example: '2024-01-15T10:30:00Z'
          type: string
      type: object
    ErrorFormat:
      type: object
      description: El mensaje de error de la respuesta.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Un identificador único y estable para el error.
        title:
          type: string
          description: Un breve resumen del problema.
        message:
          type: string
          description: Orientación detallada para resolver el error.
    LocationInformationDTO:
      properties:
        categoryCode:
          description: CategoryCode es el código de categoría del comerciante (MCC)
          example: '5411'
          type: string
        merchantCity:
          description: MerchantCity es la ciudad donde se ubica el comerciante
          example: São Paulo
          type: string
        merchantName:
          description: MerchantName es el nombre del comerciante
          example: Loja ABC
          type: string
        postalCode:
          description: PostalCode es el código postal del comerciante (CEP)
          example: 01310-100
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````