> ## 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 Automático 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.0.3
info:
  title: Plugin BR Pix Direct - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/pix-automatico/composite/decode:
    post:
      tags:
        - Pix Automático API
      summary: Decode a composite Pix Automático QR code from its URL
      description: >-
        Decodes a composite Pix QR code from its embedded recurrence URL
        (urlPayloadJsonRec), returning the recurring-payment authorization
        configuration.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DecodeCompositeBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecodeCompositeResponse'
          description: OK
        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).
          type: string
      required:
        - recurrencePayloadUrl
      type: object
    DecodeCompositeResponse:
      additionalProperties: false
      properties:
        amount:
          description: Fixed payment amount in reais.
          format: double
          type: number
        contractDesc:
          description: Free-text contract description.
          type: string
        contractNumber:
          description: Contract/order identifier (nrContrato).
          type: string
        createdDateTime:
          description: QR creation timestamp (dtHrCriacao).
          type: string
        debtor:
          $ref: '#/components/schemas/CompositeDebtorBody'
        endDate:
          description: Last payment date (aaaa-mm-dd).
          type: string
        frequency:
          description: tpFrequencia.
          format: int64
          type: integer
        maxFloorAmount:
          description: Floor amount in reais (pisoValorMaximo).
          format: double
          type: number
        presentedDateTime:
          description: QR presentation timestamp (dtHrApresentacao).
          type: string
        recipient:
          $ref: '#/components/schemas/CompositeRecipientBody'
        recurrenceId:
          description: Unique recurrence id.
          type: string
        retry:
          description: retentativa policy.
          format: int64
          type: integer
        startDate:
          description: First payment date (aaaa-mm-dd).
          type: string
        updates:
          description: Recurrence status history (atualizacoes).
          items:
            $ref: '#/components/schemas/CompositeRecurrenceUpdateResponse'
          type: array
          nullable: true
      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).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          format: uri
          type: string
        status:
          description: HTTP status code
          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.
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          format: uri
          type: string
      type: object
    CompositeDebtorBody:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: Debtor CPF or CNPJ (string).
          type: string
        name:
          description: Debtor name.
          type: string
        personType:
          description: Debtor person type (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - personType
        - cpfCnpj
        - name
      type: object
    CompositeRecipientBody:
      additionalProperties: false
      properties:
        cnpj:
          description: Recipient CNPJ (14 digits, string).
          type: string
        ispb:
          description: Recipient participant ISPB (8 digits, string).
          type: string
        name:
          description: Recipient legal/trade name.
          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).
          format: int64
          type: integer
        statusDateTime:
          description: Status update timestamp (ISO-8601).
          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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        JWT Bearer token authentication. Obtain token from
        `/v1/login/oauth/access_token` endpoint

        using client credentials (clientId and clientSecret).


        Include token in Authorization header:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        Token expires after 3600 seconds (1 hour).

````