> ## 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. # Consult a PIX Automatico authorization situation > Consults the live JDPI situation of a recurring-payment authorization (JDPI 4.3.4), projecting the JDPI situation axes onto the local authorization status. ## OpenAPI ````yaml /en/openapi/v3-current/pix.yaml get /v1/pix-automatico/authorizations/{idRecorrencia} 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/authorizations/{idRecorrencia}: get: tags: - PIX Automatico summary: Consult a PIX Automatico authorization situation description: >- Consults the live JDPI situation of a recurring-payment authorization (JDPI 4.3.4), projecting the JDPI situation axes onto the local authorization status. operationId: getPixAutomaticoAuthorization parameters: - description: The recurrence id (29-char, RR...). in: path name: idRecorrencia required: true schema: description: The recurrence id (29-char, RR...). examples: - RR0435879820240605njua7shf40o type: string - description: >- The JDPI request id (GUID) fallback when the idRecorrencia consult 404s. explode: false in: query name: idReqJdPi schema: description: >- The JDPI request id (GUID) fallback when the idRecorrencia consult 404s. examples: - '' type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthorizationResponse' 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: AuthorizationResponse: additionalProperties: false properties: amount: description: Fixed payment amount in centavos. examples: - 110001 format: int64 type: integer authorizationGiven: description: resultadoAutorizacao. examples: - true type: boolean authorizedAt: description: Authorization timestamp (UTC). examples: - '2024-01-06T10:00:00Z' type: string cancellations: description: Cancellation history (cancelamentos). items: $ref: '#/components/schemas/AuthorizationCancellationItem' type: - array - 'null' contractDesc: description: Free-text contract description. examples: - Conta de energia type: string contractNumber: description: Contract/order identifier (nrContrato). examples: - 1234567890ABC type: string debtor: $ref: '#/components/schemas/AuthorizationDebtorBody' description: The recurrence devedor. endDate: description: Last payment date (aaaa-mm-dd). examples: - '2026-01-10' type: string floorMaxAmount: description: Receiver floor in centavos. examples: - 55000 format: int64 type: integer frequency: description: tpFrequencia (0..4). examples: - 1 format: int64 type: integer idRecorrencia: description: The recurrence id. examples: - RR0435879820240605njua7shf40o type: string idReqJdPi: description: The JDPI request id (GUID). examples: - 52c43361-caa1-4ddb-9152-708426a25db3 type: string idSolicitacao: description: The solicitation id (29-char, IS...). examples: - IS0435879820240605abcd1234567 type: string journey: description: jornada (1..4). examples: - 2 format: int64 type: integer localStatus: description: Local AuthorizationStatus projected from the JDPI situation. examples: - Active type: string localStatusKnown: description: False when the JDPI situation carries no projected local status. examples: - true type: boolean payer: $ref: '#/components/schemas/AuthorizationPayerView' description: The recurrence pagador. payerMaxAmount: description: Payer max cap in centavos. examples: - 200000 format: int64 type: integer recipient: $ref: '#/components/schemas/AuthorizationRecipientBody' description: The recurrence recebedor. requestedAt: description: JDPI request timestamp (UTC). examples: - '2024-01-05T10:00:01Z' type: string retry: description: retentativa (0/1). examples: - 1 format: int64 type: integer situationAt: description: Situation timestamp (dtHrSituacao, UTC). examples: - '2024-01-06T10:00:00Z' type: string stJdPi: description: JDPI overall situation (-1/0/9/10). examples: - 9 format: int64 type: integer stJdPiProc: description: JDPI intermediate situation (0..10). examples: - 9 format: int64 type: integer startDate: description: First payment date (aaaa-mm-dd). examples: - '2024-01-10' type: string updatedAt: description: Last-update timestamp (UTC). examples: - '2024-01-06T10:00:00Z' type: string required: - idRecorrencia - stJdPiProc - stJdPi - localStatus - localStatusKnown - authorizationGiven - frequency - startDate - recipient - payer - debtor type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -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 AuthorizationCancellationItem: additionalProperties: false properties: cancelStatus: description: stCancelamento (0=Aceito, 1=Rejeitado; -1 when absent). examples: - 0 format: int64 type: integer cancelledAt: description: Cancellation timestamp (UTC). examples: - '2024-02-01T10:00:00Z' type: string errorCode: description: JDPI error code (codigoErro). examples: - '' type: string errorDesc: description: JDPI error description (descCodigoErro). examples: - '' type: string idCancelamento: description: The cancellation id (29-char, IC...). examples: - IC0435879820240605abcd1234567 type: string reason: description: motivoCancelamento (0..10). examples: - 0 format: int64 type: integer requesterDocument: description: Requester CPF/CNPJ (string). examples: - '04623217035' type: string requesterType: description: tpPessoaSol. examples: - 0 format: int64 type: integer required: - idCancelamento - requesterType - requesterDocument - reason - cancelledAt - cancelStatus type: object AuthorizationDebtorBody: 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: tpPessoa (0=Pessoa Fisica, 1=Pessoa Juridica). examples: - 0 format: int64 type: integer required: - personType - cpfCnpj - name type: object AuthorizationPayerView: additionalProperties: false properties: account: description: Payer account (string). examples: - '0007654321' type: string accountType: description: tpConta. examples: - 0 format: int64 type: integer agency: description: Payer branch (string). examples: - '0001' type: string cpfCnpj: description: Payer CPF/CNPJ (string). examples: - '04623217035' type: string ibgeCode: description: Municipality IBGE code. examples: - 3550308 format: int64 type: integer ispb: description: Payer participant ISPB (string). examples: - '00038166' type: string name: description: Payer name. examples: - Fulano de Tal type: string personType: description: tpPessoa. examples: - 0 format: int64 type: integer type: object AuthorizationRecipientBody: 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 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 ````