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

# Registrar autorização de Pix Automático de entrada no PSP Recebedor

> Registra o resultado de autorização do pagador entregue pelo upstream ao PSP Recebedor. Carrega a linha de autorização existente do lado do recebedor e a transiciona para Accepted ou Rejected conforme resultadoAutorizacao, retornando o id local do gateway de liquidação.



## OpenAPI

````yaml pt/openapi/v3-current/pix.yaml POST /v1/pix-automatico/authorizations/inbound/recipient/register
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - API Completa
  description: >
    API completa para o sistema de pagamentos instantaneos PIX brasileiro,
    incluindo

    operacoes de dicionario de chaves PIX, geracao/decodificacao de QR codes,
    transacoes e

    limites de transacao.
  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/authorizations/inbound/recipient/register:
    post:
      tags:
        - Pix Automático API
      summary: Registrar autorização de Pix Automático de entrada no PSP Recebedor
      description: >-
        Registra o resultado de autorização do pagador entregue pelo upstream ao
        PSP Recebedor. Carrega a linha de autorização existente do lado do
        recebedor e a transiciona para Accepted ou Rejected conforme
        resultadoAutorizacao, retornando o id local do gateway de liquidação.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterAuthorizationBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterAuthorizationResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
components:
  schemas:
    RegisterAuthorizationBody:
      additionalProperties: false
      properties:
        descContrato:
          description: Descrição de contrato em texto livre (35 caracteres).
          type: string
        devedor:
          $ref: '#/components/schemas/InboundDebtorBlock'
        dtFinalRecorrencia:
          description: Data do último pagamento (aaaa-mm-dd).
          type: string
        dtHrAutorizacaoRecorrencia:
          description: Data/hora da autorização (UTC).
          type: string
        dtHrCriacaoRecorrencia:
          description: Data/hora de criação da recorrência (UTC).
          type: string
        dtInicialRecorrencia:
          description: Data do primeiro pagamento (aaaa-mm-dd).
          type: string
        idRecorrencia:
          description: Id único de recorrência (29 caracteres, RR...).
          type: string
        idReqJdPi:
          description: Id da requisição upstream (GUID de 36 caracteres).
          type: string
        jornada:
          description: Jornada de autorização (2..4).
          format: int64
          type: integer
        motivoRejeicao:
          description: >-
            Código de motivo de rejeição (4 caracteres; obrigatório quando
            resultadoAutorizacao=false).
          type: string
        nrContrato:
          description: Identificador de contrato/pedido (35 caracteres).
          type: string
        pagador:
          $ref: '#/components/schemas/InboundPayerBlock'
        recebedor:
          $ref: '#/components/schemas/InboundRecipientBlock'
        resultadoAutorizacao:
          description: Resultado da análise do pagador (true=Aceita, false=Rejeitada).
          type: boolean
        retentativa:
          description: Política de retentativa (0=nenhuma, 1=até 3 em 7 dias).
          format: int64
          type: integer
        tpFrequencia:
          description: Periodicidade da recorrência (0..4).
          format: int64
          type: integer
        valor:
          description: Valor fixo de pagamento em reais (um número JSON).
          format: double
          type: number
      required:
        - idReqJdPi
        - idRecorrencia
        - resultadoAutorizacao
        - retentativa
        - jornada
        - tpFrequencia
        - dtInicialRecorrencia
        - recebedor
        - pagador
        - nrContrato
        - dtHrCriacaoRecorrencia
        - dtHrAutorizacaoRecorrencia
      type: object
    RegisterAuthorizationResponse:
      additionalProperties: false
      properties:
        dtHrSgct:
          description: carimbo de data/hora de registro do gateway de liquidação (UTC).
          type: string
        idReqJdPi:
          description: Id da requisição upstream ecoado (GUID de 36 caracteres).
          type: string
        idSgct:
          description: >-
            Id local de autorização do gateway de liquidação (GUID de 36
            caracteres).
          type: string
      required:
        - idReqJdPi
        - idSgct
        - dtHrSgct
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina, escopado ao
            serviço emissor (formato: <SERVICE>-NNNN).
          type: string
        detail:
          description: Uma explicação legível específica desta ocorrência do problema.
          type: string
        errors:
          description: Lista opcional de detalhes individuais de erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            Uma referência URI que identifica a ocorrência específica do
            problema.
          format: uri
          type: string
        status:
          description: Código de status HTTP
          format: int64
          type: integer
        title:
          description: >-
            Um resumo curto e legível do tipo de problema. Este valor não deve
            mudar entre ocorrências do erro.
          type: string
        type:
          default: about:blank
          description: Uma referência URI para a documentação legível do erro.
          format: uri
          type: string
      type: object
    InboundDebtorBlock:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: CPF ou CNPJ do devedor (uma string v5.5.0).
          type: string
        nome:
          description: Nome/razão social do devedor.
          type: string
        tpPessoa:
          description: Tipo de pessoa (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - tpPessoa
        - cpfCnpj
        - nome
      type: object
    InboundPayerBlock:
      additionalProperties: false
      properties:
        codMunIbge:
          description: >-
            Código IBGE do município do pagador (7 dígitos). Carregado para
            completude de fio; a especificação o marca como Sim em 5.2.4, mas o
            serviço não consome nem persiste o município do pagador nesta wave
            (o domínio não tem campo de município).
          format: int64
          type: integer
        cpfCnpj:
          description: CPF ou CNPJ do pagador (uma string v5.5.0).
          type: string
        ispb:
          description: ISPB do participante pagador (8 dígitos, uma string v5.5.0).
          type: string
        nrAgencia:
          description: >-
            Agência do pagador (nrAgencia, 4 dígitos, string; a fonte da
            agência).
          type: string
        nrConta:
          description: Número da conta do pagador (nrConta, uma string; NUNCA a agência).
          type: string
        tpPessoa:
          description: Tipo de pessoa (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - ispb
        - tpPessoa
        - cpfCnpj
        - nrConta
      type: object
    InboundRecipientBlock:
      additionalProperties: false
      properties:
        cnpj:
          description: CNPJ do recebedor (14 dígitos, uma string v5.5.0).
          type: string
        ispb:
          description: ISPB do participante recebedor (8 dígitos, uma string v5.5.0).
          type: string
        nome:
          description: Razão social/nome fantasia do recebedor (razão social).
          type: string
      required:
        - ispb
        - cnpj
        - nome
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Onde o erro ocorreu, ex. 'body.items[3].tags' ou 'path.thing-id'
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: O valor no local informado
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticacao por token JWT Bearer. Obtenha o token no endpoint
        `/v1/login/oauth/access_token`

        usando credenciais do cliente (clientId e clientSecret).


        Inclua o token no header Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        O token expira apos 3600 segundos (1 hora).

````