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

# Decode a composite PIX Automatico QR code from its URL

> Decodes a composite PIX QR code from its embedded recurrence URL (urlPayloadJsonRec), returning the recurring-payment authorization configuration.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml post /v1/pix-automatico/composite/decode
openapi: 3.1.0
info:
  description: Brazilian PIX Direct (DICT + SPI) plugin API.
  title: plugin-br-pix-jd
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
paths:
  /v1/pix-automatico/composite/decode:
    post:
      tags:
        - PIX Automatico
      summary: Decode a composite PIX Automatico QR code from its URL
      description: >-
        Decodes a composite PIX QR code from its embedded recurrence URL
        (urlPayloadJsonRec), returning the recurring-payment authorization
        configuration.
      operationId: decodeCompositeQRCode
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DecodeCompositeBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecodeCompositeResponse'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    DecodeCompositeBody:
      additionalProperties: false
      properties:
        recurrencePayloadUrl:
          description: >-
            The recurrence JWS host URL to decode (urlPayloadJsonRec; no
            scheme).
          examples:
            - pix.example.com/rec/2353c790eefb11eaadc10242ac120004
          type: string
      required:
        - recurrencePayloadUrl
      type: object
    DecodeCompositeResponse:
      additionalProperties: false
      properties:
        amount:
          description: Fixed payment amount in centavos.
          examples:
            - 0
          format: int64
          type: integer
        contractDesc:
          description: Free-text contract description.
          examples:
            - Conta de energia
          type: string
        contractNumber:
          description: Contract/order identifier (nrContrato).
          examples:
            - 1234567890ABC
          type: string
        createdDateTime:
          description: QR creation timestamp (dtHrCriacao).
          examples:
            - '2024-11-08T14:24:15.043Z'
          type: string
        debtor:
          $ref: '#/components/schemas/CompositeDebtorBody'
          description: The recurrence devedor.
        endDate:
          description: Last payment date (aaaa-mm-dd).
          examples:
            - '2026-01-10'
          type: string
        frequency:
          description: tpFrequencia.
          examples:
            - 4
          format: int64
          type: integer
        maxFloorAmount:
          description: Floor amount in centavos (pisoValorMaximo).
          examples:
            - 55000
          format: int64
          type: integer
        presentedDateTime:
          description: QR presentation timestamp (dtHrApresentacao).
          examples:
            - '2024-11-10T10:21:34.107Z'
          type: string
        recipient:
          $ref: '#/components/schemas/CompositeRecipientBody'
          description: The recurrence recebedor.
        recurrenceId:
          description: Unique recurrence id.
          examples:
            - RR0435879820240605njua7shf40o
          type: string
        retry:
          description: retentativa policy.
          examples:
            - 1
          format: int64
          type: integer
        startDate:
          description: First payment date (aaaa-mm-dd).
          examples:
            - '2024-01-10'
          type: string
        updates:
          description: Recurrence status history (atualizacoes).
          items:
            $ref: '#/components/schemas/CompositeRecurrenceUpdateResponse'
          type:
            - array
            - 'null'
      required:
        - recurrenceId
        - frequency
        - startDate
        - recipient
        - debtor
        - contractNumber
        - retry
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    CompositeDebtorBody:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: Debtor CPF or CNPJ (string).
          examples:
            - '04623217035'
          type: string
        name:
          description: Debtor name.
          examples:
            - Ciclano da Silva
          type: string
        personType:
          description: Debtor person type (0=Pessoa Fisica, 1=Pessoa Juridica).
          examples:
            - 0
          format: int64
          type: integer
      required:
        - personType
        - cpfCnpj
        - name
      type: object
    CompositeRecipientBody:
      additionalProperties: false
      properties:
        cnpj:
          description: Recipient CNPJ (14 digits, string).
          examples:
            - '61695227000193'
          type: string
        ispb:
          description: Recipient participant ISPB (8 digits, string).
          examples:
            - '04358798'
          type: string
        name:
          description: Recipient legal/trade name.
          examples:
            - Enel
          type: string
      required:
        - ispb
        - cnpj
        - name
      type: object
    CompositeRecurrenceUpdateResponse:
      additionalProperties: false
      properties:
        status:
          description: >-
            stRecorrencia
            (0=Created,1=Approved,2=Rejected,3=Expired,4=Cancelled).
          examples:
            - 0
          format: int64
          type: integer
        statusDateTime:
          description: Status update timestamp (ISO-8601).
          examples:
            - '2024-11-08T14:25:49.025Z'
          type: string
      required:
        - status
        - statusDateTime
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````