Situação de autorização | Documentação API

Documentação API

post

Body

idRecorrenciastringRequired

Identificador único da recorrência para os pagamentos periódicos

Example: RR0435879820240605njua7shf40o

idReqJdPistring | nullableOptional

Identificador da requisição no JDPI

Example: RR0435879820240605njua7shf40o

dtHrReqJdPistringOptional

Data e hora do registro da requisição. Formato: aaaa-mm-ddTHH:mm:ss.sssZ

Example: 2022-05-17T14:30:00.000ZPattern: /^d{4}-d{2}-d{2}Td{2}:d{2}:d{2}.d{3}Z$/

dtHrSituacaostringRequired

Data e hora do retorno da consulta a situação da Autorização para Pagamento Recorrente.

Example: 2022-05-17T14:30:00.000ZPattern: /^d{4}-d{2}-d{2}Td{2}:d{2}:d{2}.d{3}Z$/

stJdPiProcnumber · enumRequired

Situação intermediária do processamento da requisição.

Default: 0Example: 9Possible values:

stJdPinumber · enumRequired

Situação final do processamento da requisição.

Default: nullExample: 9Possible values:

codigoErrostring | nullableRequired

Código de Erro, informado quando “stJdPi” possuir valor “0” ou “-1”. Vide domínios na seção “8.7” do documento “JDPI.ListaAPIs.pdf”.

Example: 100

descCodigoErrostring | nullableRequired

Descrição do Código de Erro, informado quando “stJdPi” possuir valor “0” ou “-1”.

Example: Descrição do erro

motivoRejeicaostring · enumRequired

Códigos de erro detalhados para transações Pix Automático. Domínio: - AC01: PSP do usuário pagador Conta não localizada ou não pertencente ao usuário pagador. - AC04: PSP do usuário pagador Conta transacional do usuário pagador encontra-se encerrada. - AC06: PSP do usuário pagador Conta transacional do usuário pagador encontra-se bloqueada. - AG12: SPI Não é permitido o envio da solicitação de autorização de recorrência, de cancelamento de recorrência, de confirmação de recorrência ou de cancelamento de pain.009 para uma conta transacional na mesma instituição ou em participante que utilize o serviço de liquidação de um mesmo participante liquidante no SPI. - AM05: PSP do usuário pagador Solicitação de confirmação de recorrência para pagamentos periódicos já confirmada previamente ou com status 'PDNG'. - AP01: PSP do usuário pagador / PSP do usuário recebedor Divergência no campo de atualização dos dados da recorrência para os pagamentos periódicos e o status da recorrência para os pagamentos periódicos (ex.: falta de sincronização). - AP02: PSP do usuário pagador / PSP do usuário recebedor CPF/CNPJ do usuário pagador não localizado ou diferente do constante na pain.009 original. Ou, no caso de cancelamento, o CPF/CNPJ usuário pagador não coincide com o contido nos dados da recorrência para os pagamentos periódicos. - AP03: PSP do usuário pagador Agência do usuário pagador não localizada. - AP04: PSP do usuário pagador / PSP do usuário recebedor ID da recorrência inválido ou não corresponde ao original. - AP05: PSP do usuário recebedor Status da recorrência para os pagamentos periódicos inconsistente. - AP06: PSP do usuário pagador / PSP do usuário recebedor CPF/CNPJ do usuário recebedor diferente do constante na pain.009 ou do payload. Ou, no caso de cancelamento, o CPF/CNPJ usuário recebedor não coincide com o contido nos dados da recorrência para os pagamentos periódicos. - AP07: Confirmação da recorrência pelo usuário pagador realizada após a expiração ou cancelamento da solicitação de confirmação (pain.009). - AP08: Primeiro pagamento imediato associado à recorrência não foi identificado. (Válido apenas para a Jornada 3 de autorização.) - AP09: Solicitação de confirmação de recorrência para pagamentos periódicos não foi identificada para viabilizar seu cancelamento. - AP10: CPF/CNPJ do solicitante do cancelamento não corresponde à identificação do usuário pagador/recebedor ou do PSP pagador/recebedor contidos na recorrência para os pagamentos periódicos. - AP11: ISPB do PSP pagador diverge da informação contida na recorrência para pagamentos periódicos. - AP12: ISPB do PSP recebedor diverge da informação contida na recorrência para pagamentos periódicos. - AP13: Solicitação de confirmação da recorrência para os pagamentos periódicos rejeitada pelo usuário pagador por não reconhecimento do usuário recebedor. - AP14: Solicitação de confirmação da recorrência para os pagamentos periódicos rejeitada pelo usuário pagador por não ter interesse no uso do Pix Automático para o usuário recebedor. - AP15: Solicitação de confirmação da recorrência para os pagamentos periódicos rejeitada pelo participante do usuário pagador que optou por não oferecer uso do Pix Automático para cliente pessoa jurídica. - CH16: Preenchimento do conteúdo da mensagem incorreto ou incompatível com as regras de negócio. - DS27: Participante não se encontra cadastrado ou ainda não iniciou a operação no SPI. - MD01: Recorrência objeto da solicitação de cancelamento não existe. Não deve ser utilizado para solicitações de cancelamento de pain.009 com status = 'PDNG'. Ou seja, uma recorrência com status = 'PDNG' deve ser considerada como uma recorrência existente. - MD20: Recorrência objeto da solicitação de cancelamento já expirou. - RC09: ISPB do participante do usuário pagador inválido ou inexistente. - RC10: ISPB do participante do usuário recebedor inválido ou inexistente. - AB10: Transação interrompida devido a erro no participante do usuário pagador. - AC05: Conta transacional do usuário pagador encerrada. - AM02: Valor da cobrança ultrapassa o valor máximo estabelecido pelo usuário pagador. - AM09: Valor da cobrança não corresponde ao valor estabelecido na recorrência. - DENC: PSP do usuário pagador CPF/CNPJ do usuário pagador não corresponde ao dado contido na recorrência/autorização. - DTED: PSP do usuário pagador Divergência entre a data de vencimento informada e a periodicidade da recorrência e/ou as regras do produto. - DTNT: PSP do usuário pagador Novas tentativas de agendamento pós vencimento em desacordo com o limite de dias definido na regra de negócio (a partir de D+8, considerando D0, a data do vencimento). - FBRD: PSP do usuário pagador Pain.013 recebida fora do prazo para cumprimento das regras de negócio. - IRNT: PSP do usuário pagador Cobrança recorrente não permite novas tentativas de agendamento pós vencimento (idRecorrencia com característica que não permite novas tentativas). - MIDI: PSP do usuário pagador idRecorrencia inexistente ou incorreto. - MSUC: PSP do usuário pagador statusRecorrencia diferente de "CFDB" (confirmado pelo usuário pagador). - NIEC: PSP do usuário pagador Nova instrução de pagamento inválida pois a mesma cobrança já possui ordem de pagamento agendada ainda pendente de envio ao SPI para liquidação. - NIPA: PSP do usuário pagador Nova instrução de pagamento inválida, pagamento já foi efetivado. - NITX: PSP do usuário pagador Nova instrução de pagamento não corresponde a uma cobrança recorrente gerada anteriormente (IdConciliacaoDoRecebedor diferentes). Utilizada somente para as finalidades de agendamento 'NTAG' e 'RIFL'. - QUNT: PSP do usuário pagador Quantidade de novas tentativas de agendamento pós vencimento excede o limite definido pela regra de negócio (mais de 3 tentativas em intervalo de 7 dias após o vencimento, considerando D0, a data do vencimento). - UDEI: PSP do usuário pagador CPF/CNPJ do devedor incorreto. - AB09: PSP do usuário recebedor Transação interrompida devido a erro no participante do usuário recebedor. - FBRD2: PSP do usuário pagador Mensagem de solicitação do cancelamento (camt.055) não recebida pelo participante do usuário pagador no prazo adequado para sua operacionalização (até 22H:00 do dia anterior a data de liquidação). - FF08: PSP do usuário pagador / PSP do usuário recebedor idFimAFim não corresponde ao originalmente informado. - PRJL: PSP do usuário pagador / PSP do usuário recebedor Cancelamento de agendamento (camt.055) inválido, pagamento recorrente já foi concluído com sucesso no fluxo de liquidação.

Default: AP03Example: AP03Possible values:

idSolicitacaoRecorrenciastring · max: 29Required

Identificador único da solicitação de confirmação de autorização dos pagamentos periódicos.

Example: RR111657562025041ABCD123456A

resultadoAutorizacaobooleanRequired

Resultado da análise realizada pelo Usuário Pagador, referente a solicitação de confirmação de autorização dos pagamentos periódicos. Domínio: true – Aceita false – Rejeitada

Example: true

jornadanumber · enumRequired

Código da Jornada. Domínio: JORNADA_1, JORNADA_2, JORNADA_3, JORNADA_4

Default: 1Example: 1Possible values:

tpFrequencianumber · enumRequiredDefault: 1Example: 0Possible values:

dtInicialRecorrenciastring · max: 10Required

Data prevista do primeiro pagamento. Formato: aaaa-mm-dd

Example: 2023-01-01

dtFinalRecorrenciastring | nullableRequired

Data prevista do último pagamento. Formato: aaaa-mm-dd

Example: 2025-01-01

valorstring | nullableRequired

Valor dos pagamentos.

Example: 100.00

pisoValorMaximostring | nullableRequired

Valor definido pelo usuário recebedor como piso.

Example: 150.00

vlrMaxPagadorstring | nullableRequired

Valor máximo de pagamento da autorização, definido pelo usuário pagador.

Example: 200.00

recebedorall ofRequired

Grupo de informações do Recebedor

pagadorall ofRequired

Grupo de informações do Pagador

devedorall ofRequired

Grupo de informações do Pagador

nrContratostringRequired

Número, identificador, ou código que representa o objeto da autorização (contrato, pedido, etc).

Example: 12345678901234567890123456789012345

descContratostring | nullableRequired

Campo de texto livre para informações referentes ao contrato que permitam ao usuário pagador reconhecer o objeto dos pagamentos periódicos por meio do Pix Automático.

Example: Contrato de Prestacao de Servicos

dtHrCriacaoRecorrenciastringRequired

Data e hora da criação da recorrência para os pagamentos periódicos. Formato: aaaa-mm-ddTHH:mm:ss.sssZ

Example: 2023-01-01T00:00:00.000Z

dtHrCriacaoSolicitacaostring | nullableRequired

Data e hora de criação da solicitação de confirmação da autorização da recorrência para os pagamentos periódicos. Formato: aaaa-mm-ddTHH:mm:ss.sssZ

Example: 2023-01-01T00:00:00.000Z

dtHrExpiracaoSolicitacaostringRequired

Data e hora de expiração da solicitação de confirmação da recorrência para os pagamentos periódicos. Formato: aaaa-mm-ddTHH:mm:ss.sssZ. Regra de preenchimento: Deve ser preenchida no máximo, 30 dias corridos a partir da "dtHrCriacaoSolicitacao".

Example: 2023-01-31T00:00:00.000Z

dtHrAtualizacaoRecorrenciastring | nullableRequired

Data e hora da última atualização de situação da recorrência para os pagamentos periódicos. Formato: aaaa-mm-ddTHH:mm:ss.sssZ

Example: 2023-01-01T00:00:00.000Z

dtHrAutorizacaoRecorrenciastring | nullableRequired

Data e hora de que o usuário Pagador autorizou (confirmou) a recorrência para os pagamentos periódicos. Formato: aaaa-mm-ddTHH:mm:ss.sssZ

Example: 2023-01-01T00:00:00.000Z

Responses

201Success

post

POST /psti/situacao-autorizacao HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1386

{
  "idRecorrencia": "RR0435879820240605njua7shf40o",
  "idReqJdPi": "RR0435879820240605njua7shf40o",
  "dtHrReqJdPi": "2022-05-17T14:30:00.000Z",
  "dtHrSituacao": "2022-05-17T14:30:00.000Z",
  "stJdPiProc": 9,
  "stJdPi": 9,
  "codigoErro": "100",
  "descCodigoErro": "Descrição do erro",
  "motivoRejeicao": "AP03",
  "idSolicitacaoRecorrencia": "RR111657562025041ABCD123456A",
  "resultadoAutorizacao": true,
  "jornada": 1,
  "tpFrequencia": 0,
  "dtInicialRecorrencia": "2023-01-01",
  "dtFinalRecorrencia": "2025-01-01",
  "valor": "100.00",
  "pisoValorMaximo": "150.00",
  "vlrMaxPagador": "200.00",
  "recebedor": {
    "ispb": 12345678,
    "cnpj": 61695227000193,
    "nome": "Enel"
  },
  "pagador": {
    "ispb": 12345678,
    "tpPessoa": 0,
    "cpfCnpj": 12345678901,
    "nrAgencia": "0001",
    "nrConta": "12345678901234567890",
    "codMunIbge": 1234567
  },
  "devedor": {
    "ispb": 12345678,
    "nome": "Enel",
    "tpPessoa": 0,
    "cpfCnpj": 12345678901
  },
  "nrContrato": "12345678901234567890123456789012345",
  "descContrato": "Contrato de Prestacao de Servicos",
  "dtHrCriacaoRecorrencia": "2023-01-01T00:00:00.000Z",
  "dtHrCriacaoSolicitacao": "2023-01-01T00:00:00.000Z",
  "dtHrExpiracaoSolicitacao": "2023-01-31T00:00:00.000Z",
  "dtHrAtualizacaoRecorrencia": "2023-01-01T00:00:00.000Z",
  "dtHrAutorizacaoRecorrencia": "2023-01-01T00:00:00.000Z",
  "cancelamentos": [
    {
      "idCancelamento": "IC12345678901234567890",
      "tpPessoaSol": 0,
      "cpfCnpjSolCanc": "12345678901",
      "dtHrCancelamento": "2022-09-15T14:30:00.000Z",
      "stCancelamento": 0,
      "motivoCancelamento": 4
    }
  ]
}

201Success

No content