> ## 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. # Register an inbound PIX Automatico authorization on the PSP Recebedor > Registers the payer's authorization result delivered by JDPI to the PSP Recebedor (section 5.2.4, the plugin is the server). It loads the existing recebedor-side authorization row and transitions it to Accepted or Rejected per resultadoAutorizacao, returning the local SGCT id. ## OpenAPI ````yaml /en/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/inbound/recipient/register 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/inbound/recipient/register: post: tags: - PIX Automatico summary: Register an inbound PIX Automatico authorization on the PSP Recebedor description: >- Registers the payer's authorization result delivered by JDPI to the PSP Recebedor (section 5.2.4, the plugin is the server). It loads the existing recebedor-side authorization row and transitions it to Accepted or Rejected per resultadoAutorizacao, returning the local SGCT id. operationId: registerInboundPixAutomaticoRecipientAuthorization requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterAuthorizationBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegisterAuthorizationResponse' 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: RegisterAuthorizationBody: additionalProperties: true properties: descContrato: description: Free-text contract description (35-char). examples: - Conta de energia type: string devedor: $ref: '#/components/schemas/InboundDebtorBlock' description: The devedor, sent only when it differs from the payer. dtFinalRecorrencia: description: Last payment date (aaaa-mm-dd). examples: - '2026-01-10' type: string dtHrAutorizacaoRecorrencia: description: Authorization timestamp (UTC). examples: - '2024-09-20T14:11:27.453Z' type: string dtHrCriacaoRecorrencia: description: Recurrence creation timestamp (UTC). examples: - '2024-09-20T09:25:49.025Z' type: string dtInicialRecorrencia: description: First payment date (aaaa-mm-dd). examples: - '2024-01-10' type: string idRecorrencia: description: Unique recurrence id (29-char, RR...). examples: - RR0435879820240920njua7shf40o type: string idReqJdPi: description: JDPI request id (36-char GUID). examples: - 45F763C6-7487-4363-9406-A1DE2A9636D3 type: string jornada: description: Authorization journey (2..4). examples: - 2 format: int64 type: integer motivoRejeicao: description: >- Rejection reason code (4-char; required when resultadoAutorizacao=false). examples: - AP13 type: string nrContrato: description: Contract/order identifier (35-char). examples: - 1234567890ABC type: string pagador: $ref: '#/components/schemas/InboundPayerBlock' description: >- The recurrence pagador. The spec marks pagador.codMunIbge Sim on 5.2.4, but it is accepted-not-consumed this wave (the domain has no municipality field). recebedor: $ref: '#/components/schemas/InboundRecipientBlock' description: The recurrence recebedor. resultadoAutorizacao: description: Payer analysis result (true=Aceita, false=Rejeitada). examples: - true type: boolean retentativa: description: Retry policy (0=none, 1=up to 3 in 7 days). examples: - 1 format: int64 type: integer tpFrequencia: description: Recurrence periodicity (0..4). examples: - 4 format: int64 type: integer valor: description: Fixed payment amount in reais (a JSON number). examples: - 550 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: SGCT registration timestamp (UTC). examples: - '2024-11-27T22:10:05.025Z' type: string idReqJdPi: description: Echoed JDPI request id (36-char GUID). examples: - 45F763C6-7487-4363-9406-A1DE2A9636D3 type: string idSgct: description: Local SGCT authorization id (36-char GUID). examples: - 69F963C6-7487-4363-9406-A1DE2A9636D4 type: string required: - idReqJdPi - idSgct - dtHrSgct 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 InboundDebtorBlock: additionalProperties: true properties: cpfCnpj: description: Debtor CPF or CNPJ (a v5.5.0 string). examples: - '04623217035' type: string nome: description: Debtor name/razao social. examples: - Ciclano da Silva type: string tpPessoa: description: Person type (0=Pessoa Fisica, 1=Pessoa Juridica). examples: - 0 format: int64 type: integer required: - tpPessoa - cpfCnpj - nome type: object InboundPayerBlock: additionalProperties: true properties: codMunIbge: description: >- Payer municipality IBGE code (7 digits). Carried for wire-completeness; the spec marks it Sim on 5.2.4, but the plugin does not consume or persist payer municipality this wave (the domain has no municipality field). examples: - 3550308 format: int64 type: integer cpfCnpj: description: Payer CPF or CNPJ (a v5.5.0 string). examples: - '11111111111' type: string ispb: description: Payer participant ISPB (8 digits, a v5.5.0 string). examples: - '99999004' type: string nrAgencia: description: Payer branch (nrAgencia, 4 digits, string; the branch source). examples: - '1234' type: string nrConta: description: Payer account number (nrConta, a string; NEVER the branch). examples: - '12345678' type: string tpPessoa: description: Person type (0=Pessoa Fisica, 1=Pessoa Juridica). examples: - 0 format: int64 type: integer required: - ispb - tpPessoa - cpfCnpj - nrConta type: object InboundRecipientBlock: additionalProperties: true properties: cnpj: description: Recipient CNPJ (14 digits, a v5.5.0 string). examples: - '61695227000193' type: string ispb: description: Recipient participant ISPB (8 digits, a v5.5.0 string). examples: - '04358798' type: string nome: description: Recipient legal/trade name (razao social). examples: - Enel type: string required: - ispb - cnpj - nome 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 ````