Documentação API
  • Introdução
  • Registro para services
  • Atualizar senha para services
  • Credenciais de Acesso
  • Teste de Conexão
  • Gestão de contas
    • Conta PJ
    • Conta PF
    • Adicionar Sub Conta PJ
    • Adicionar Sub Conta PF
    • Listar Contas
    • Onboarding - envio de arquivos
  • Pix
    • Diretório de chaves - DICT
      • Criar chave Pix - INDIRETOS
      • Editar chave Pix - INDIRETOS
      • Criar chave Pix
      • Excluir Chaves Pix de uma Conta
      • Consultar uma chave Pix de uma conta
      • Consultar todas as chaves Pix de uma conta
    • Cash-out Agendado (Pagamento)
      • Criar agendamento de PIX
      • Buscar agendamentos de PIX
      • Excluir agendamento de PIX
      • Editar Agendamento de PIX
      • Consultar unico agendamento de PIX
    • Cash-in (Receber)
      • Receber um Pix Cash-in por Agência e Conta
      • Validação de recebimento de PIX
      • Receber um Pix Cash-in por Chave
      • Receber um Pix Cash-in por Cobrança estática
      • Receber um Pix Cash-in por QR Code dinâmico
      • Verifica o Status de uma transação Pix
      • Verifica o Status de uma transação Pix Pelo TxID
    • Cash-out (Pagamento)
      • Realizar um Pix por Chaves Pix (Indiretos)
      • Realizar um Pix por Chaves Pix
      • Realizar a devolução de um Pix
      • Realizar um Pix Agência e Conta
      • Realizar um Pix por QR Code Estático
      • Realizar um Pix por QR Code Dinâmico
      • Realizar um Pix por QR Code Dinâmico com Vencimento
      • Decodificar QRCode
      • Verifica o Status de uma transação Pix
    • Verifica o Status de uma transação Pix
    • Relato Infração
      • Incluir Notificação de Infração
      • Listar Notificações de Infração em Processamento
      • Listar Infrações Com paginacao
      • Consultar Notificação de Infração
      • Cancelar Notificação de Infração
      • Analisar Notificação de Infração
      • INDIRETOS E DIRETOS - Analisar Notificação de Infração
    • Solicitação de Devolução MED
      • Incluir Solicitação de Devolução MED
    • Reivindicação
      • Incluir Reivindicação de Chave de Endereçamento
      • Listar Reivindicações em Processamento
      • Listar Reivindicações em Processamento INDIRETOS
      • Confirmar Reivindicação de Chave de Endereçamento
      • Cancelar Reivindicação de Chave de Endereçamento
      • Concluir Reivindicação de Chave de Endereçamento
    • Marcacao de Fraude
      • Incluir Marcacao de Fraude
      • Listar Marcacao de fraude
      • Cancelar marcacao de fraude
      • Consultar Marcacao de fraude
  • Relatórios
    • Saldo
    • Extrato
    • Transações
  • Webhooks
    • Cadastrar Webhook - Cash In (Receber)
    • Reenvio de webhooks de transações
    • Envio de webhook das transações
    • Cadastrar Webhook - Cash Out (Pagamento)
    • Consultar Webhooks cadastrados
  • Pix Automático
    • Agendamentos
      • Page
      • Cancelamento agendamento
      • Bloquear saldo no agendamento
      • Efetivar débito
      • Estornar débito
      • Notificar Agendamento
    • Responder autorização de recorrencia
    • Fluxos
      • Jornada 1 - Pagador
    • Documentação
      • Page 1
    • Integração
      • Webhooks
        • Situação de autorização
        • Validar autorizacao
        • Registrar Solicitação de Autorização no PSP Pagador
        • Webhooks
      • Criar Integração
      • Buscar todos
      • Atualizar
      • Deletar
      • Criar sub-integracao
      • buscar todos sub
      • Atualizar sub
      • Delete sub
    • Login
  • SPB
    • STR
      • Envio transação STR
      • Consulta transações STR
Powered by GitBook
On this page
  1. Pix Automático

Responder autorização de recorrencia

PreviousNotificar AgendamentoNextFluxos

Last updated 18 days ago

Responder Autorização

post
Header parameters
Chave-IdempotenciastringRequired
Body
idRecorrenciastringRequired

dentificador único da recorrência para os pagamentos periódicos. Regras do formato: - R ou C – fixo (1 caractere). “R” caso a recorrência tenha sido criada dentro do Pix, ou "C" caso tenha sido criada pela trilha do Open Finance; - R ou N – fixo (1 caractere). “R” caso a recorrência permita novas tentativas de pagamento pós vencimento, ou “N” caso não permita novas tentativas. - xxxxxxxx – identificação do agente que presta serviço para o usuário recebedor que gerou o , podendo ser: o ISPB do participante direto, o ISPB do participante indireto ou os 8 primeiros dígitos do CNPJ do prestador de serviço de iniciação (8 caracteres numéricos [0-9]); - yyyyMMdd – data (8 caracteres) de criação da recorrência; - kkkkkkkkkkk – sequencial criado pelo agente que gerou o (11 caracteres alfanuméricos [a-z|A-Z|0-9]). Deve ser único dentro de cada “yyyyMMdd”.

Example: RR0435879820240605njua7shf40oPattern: /^([RC])([RN])([0-9]{8})([a-zA-Z0-9]{11})$/
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
vlrMaxPagadorstring | nullableOptional

Valor definido pelo usuário pagador como Máximo.

Example: 150.00
motivoRejeicaostring · enum | nullableOptional

Código do Motivo da Rejeição. Domínio: AP13, AP14, AP15. Deve ser preenchido obrigatoriamente quando resultadoAutorizacao=false (Rejeitada).

Example: AP13Possible values:
dtHrAutorizacaoRecorrenciastring | nullableOptional

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: 2024-06-06T09:11:27.453Z
Responses
200
Requisição Respondida com sucesso
application/json
post
POST /autorizacao/responder/{idRecorrencia} HTTP/1.1
Host: 
Chave-Idempotencia: text
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "idRecorrencia": "RR0435879820240605njua7shf40o",
  "resultadoAutorizacao": true,
  "vlrMaxPagador": "150.00",
  "motivoRejeicao": "AP13",
  "dtHrAutorizacaoRecorrencia": "2024-06-06T09:11:27.453Z"
}
200

Requisição Respondida com sucesso

{
  "idReqJdPi": "69F963C6-7487-4363-9406-A1DE2A9636D4",
  "idRecorrencia": "RR0435879820240605njua7shf40o",
  "dtHrReqJdPi": "2023-01-01T00:00:00.000Z"
}