> ## 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. # Request a PIX Automatico authorization > Requests a recurring-payment authorization (recorrencia) as the PSP Recebedor (JDPI 4.3.1). Persists the authorization in the Requested state and returns the JDPI request id. ## OpenAPI ````yaml /en/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations 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: post: tags: - PIX Automatico summary: Request a PIX Automatico authorization description: >- Requests a recurring-payment authorization (recorrencia) as the PSP Recebedor (JDPI 4.3.1). Persists the authorization in the Requested state and returns the JDPI request id. operationId: requestPixAutomaticoAuthorization requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestAuthorizationBody' required: true responses: '202': content: application/json: schema: $ref: '#/components/schemas/RequestAuthorizationResponse' description: Accepted '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: RequestAuthorizationBody: additionalProperties: false properties: amount: description: >- Fixed payment amount in centavos (valor; omit/0 for a variable recurrence). examples: - 110001 format: int64 type: integer contractDesc: description: Free-text contract description (descContrato). examples: - Conta de energia type: string contractNumber: description: Contract/order identifier (nrContrato). examples: - 1234567890ABC type: string createdDateTime: description: Recurrence creation timestamp (dtHrCriacaoRecorrencia, UTC). examples: - '2024-01-05T10:00:00Z' type: string debtor: $ref: '#/components/schemas/AuthorizationDebtorBody' description: The devedor, sent only when it differs from the payer. endDate: description: Last payment date (dtFinalRecorrencia; aaaa-mm-dd). examples: - '2026-01-10' type: string expirationDateTime: description: Solicitation expiration timestamp (dtHrExpiracaoSolicitacao, UTC). examples: - '2024-01-06T10:00:00Z' type: string floorMaxAmount: description: Receiver floor in centavos (pisoValorMaximo). examples: - 55000 format: int64 type: integer frequency: description: tpFrequencia (0=Weekly,1=Monthly,2=Quarterly,3=Semiannual,4=Annual). examples: - 1 format: int64 type: integer idRecorrencia: description: Unique recurrence id (29-char, format RR...). examples: - RR0435879820240605njua7shf40o type: string payer: $ref: '#/components/schemas/AuthorizationPayerBody' description: The recurrence pagador (account being authorized). recipient: $ref: '#/components/schemas/AuthorizationRecipientBody' description: The recurrence recebedor (authorized charging entity). solicitationDateTime: description: Solicitation creation timestamp (dtHrCriacaoSolicitacao, UTC). examples: - '2024-01-05T10:00:00Z' type: string startDate: description: First payment date (dtInicialRecorrencia; aaaa-mm-dd). examples: - '2024-01-10' type: string required: - idRecorrencia - frequency - startDate - recipient - payer - contractNumber type: object RequestAuthorizationResponse: additionalProperties: false properties: idRecorrencia: description: The recurrence id (echoed). examples: - RR0435879820240605njua7shf40o type: string idReqJdPi: description: The JDPI request id (36-char GUID). examples: - 52c43361-caa1-4ddb-9152-708426a25db3 type: string requestedAt: description: JDPI request timestamp (dtHrReqJdPi, UTC). examples: - '2024-01-05T10:00:01Z' type: string status: description: The resulting local authorization status. examples: - Requested type: string required: - idReqJdPi - idRecorrencia - requestedAt - status 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 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 AuthorizationPayerBody: additionalProperties: false properties: account: description: Payer account number (nrConta, string). examples: - '0007654321' type: string agency: description: Payer branch (nrAgencia, 4 digits, string). examples: - '0001' type: string cpfCnpj: description: Payer CPF or CNPJ (string). examples: - '04623217035' type: string ispb: description: Payer participant ISPB (8 digits, string). examples: - '00038166' type: string personType: description: tpPessoa (0=Pessoa Fisica, 1=Pessoa Juridica). examples: - 0 format: int64 type: integer required: - ispb - personType - cpfCnpj - account 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 ````