Pagamentos Automáticos

Os endpoints a seguir são responsáveis pela iniciação e gestão de Pagamentos Automáticos

Solicitar criação de uma adesão para um pagamento automático

Este endpoint é utilizado para receber uma requisição do integrador para criar o consentimento do pagamento automático e receber uma URL de redirecionamento.

POST /v1/pagamentos-automaticos/adesao

Requer autorização para o escopo: gn.opb.automatic.consent.write

Requisição

Exemplo

{
  "pagador": {
    "cpf": "10134280059",
    "cnpj": "34836879000128",
    "nome": "Josué Villa Real",
    "idParticipante": "64c189e5-9d4a-4319-aa5e-d02c36e1815d"
  },
  "favorecido": {
    "contaBanco": {
      "nome": "Lucas Silva",
      "documento": "17558266300",
      "codigoBanco": "09089356",
      "agencia": "0001",
      "conta": "654984",
      "tipoConta": "TRAN"
    }
  },
  "assinatura": {
    "expiracao": "2026-08-27",
    "descricao": "Mensalidades do curso XYZ",
    "idProprio": "6236574863254",
    "configuracao": {
      "automatico": {
        "valorFixo": "500.00",
        "valorMinimo": "450.00",
        "valorMaximo": "750.00",
        "intervalo": "SEMANAL",
        "dataInicio": "2025-06-06",
        "permiteRetentativa": false,
        "primeiroPagamento": {
          "data": "2024-06-08",
          "valor": "9.99",
          "infoPagador": "Parcela 1"
        }
      }
    }
  }
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "identificadorAdesao": "urn:efi:ae71713f-875b-4af3-9d85-0bcb43288847",
  "redirectURI": "https://open-finance.banco.com.br/authorize?request=eyJjd"
}

Nesse ponto, o fluxo continua da seguinte forma:
1. A url é clicada pelo usuário final, que é redirecionado para a instituição pagadora.
2. O usuário final entra na sua conta e aprova o consentimento.
3. A instituição pagadora redireciona de volta para a Gerencianet, que redireciona de volta para a aplicação, através da redirectURI cadastrada no sistema.

{
  "nome": "parametro_ausente",
  "mensagem": "O parâmetro '{PARAM}' está ausente"
}

{
  "nome": "nao_autorizado",
  "mensagem": "Credenciais inválidas ou permissão insuficiente"
}

{
  "nome": "recurso_nao_encontrado",
  "mensagem": "O recurso solicitado não foi encontrado"
}

{
  "nome": "entidade_nao_processavel",
  "mensagem": "Não foi possível processar a solicitação"
}

{
  "nome": "erro_aplicacao",
  "mensagem": "Erro interno do servidor"
}

Consultar os parâmetros de uma adesão

Este endpoint é utilizado para receber uma requisição do integrador para consultar os parâmetros de um pagamento automático.

GET /v1/pagamentos-automaticos/adesao

Requer autorização para o escopo: gn.opb.automatic.consent.read

Requisição

Para obter o resultado da consulta é necessário informar os parâmetros inicio e fim, como exibido no trecho de código abaixo. Esses parâmetros representam o intervalo de datas em que as cobranças consultadas devem estar compreendidas.
/v1/pagamentos-automaticos/adesao?inicio=2022-05-01&fim=2022-12-30

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "adesoes": [
    {
      "identificadorAdesao": "urn:efi:49315a93-d39c-4564-9edb-9a73678dbdb1",
      "status": "autorizado",
      "dataCriacao": "2022-06-09T11:55:03.000Z",
      "favorecido": {
        "contaBanco": {
          "nome": "Lucas Silva",
          "documento": "17558266300",
          "codigoBanco": "09089356",
          "agencia": "0001",
          "conta": "654984",
          "tipoConta": "TRAN"
        }
      },
      "assinatura": {
        "expiracao": "2026-08-27",
        "descricao": "Mensalidades do curso XYZ",
        "idProprio": "6236574863254",
        "configuracao": {
          "automatico": {
            "valorFixo": "500.00",
            "valorMinimo": "450.00",
            "valorMaximo": "750.00",
            "intervalo": "SEMANAL",
            "dataInicio": "2025-06-06",
            "permiteRetentativa": false,
            "primeiroPagamento": {
              "data": "2024-06-08",
              "valor": "9.99",
              "infoPagador": "Parcela 1"
            }
          }
        }
      }
    }
  ],
  "total": 1,
  "porPagina": 1,
  "ultimo": "/pagamentos/pix?inicio=2022-04-29&fim=2022-04-29&quantidade=1&pagina=3",
  "proximo": "/pagamentos/pix?inicio=2022-04-29&fim=2022-04-29&quantidade=1&pagina=2",
  "anterior": null,
  "atual": "/pagamentos/pix?inicio=2022-04-29&fim=2022-04-29&quantidade=1&pagina=1"
}

{
  "nome": "parametro_ausente",
  "mensagem": "O parâmetro '{PARAM}' está ausente"
}

{
  "nome": "nao_autorizado",
  "mensagem": "Credenciais inválidas ou permissão insuficiente"
}

{
  "nome": "recurso_nao_encontrado",
  "mensagem": "O recurso solicitado não foi encontrado"
}

{
  "nome": "entidade_nao_processavel",
  "mensagem": "Não foi possível processar a solicitação"
}

{
  "nome": "erro_aplicacao",
  "mensagem": "Erro interno do servidor"
}

Editar uma adesão

Este endpoint é utilizado para receber uma requisição do integrador para alterar os parâmetros de um pagamento automático.

Informação

Atualmente, apenas o status de uma adesão poderá ser alterado.

PATCH /v1/pagamentos-automaticos/adesao

Requer autorização para o escopo: gn.opb.automatic.consent.write

Requisição

Exemplo

{
  "identificador": "urn:efi:19ba4105-9ae2-4637-89f2-96506d3c8770",
  "nomeFavorecido": "Marco Antonio de Brito",
  "status": "revogado",
  "dataExpiracao": "2021-05-21",
  "valorMaximo": "500.00"
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "identificadorAdesao": "urn:efi:49315a93-d39c-4564-9edb-9a73678dbdb1",
  "status": "revogado",
  "motivo": "O usuário pagador revogou a recorrência da adesão",
  "favorecido": {
    "contaBanco": {
      "nome": "Lucas Silva",
      "documento": "17558266300",
      "codigoBanco": "09089356",
      "agencia": "0001",
      "conta": "654984",
      "tipoConta": "TRAN"
    }
  },
  "assinatura": {
    "expiracao": "2026-08-27",
    "descricao": "Mensalidades do curso XYZ",
    "idProprio": "6236574863254",
    "configuracao": {
      "automatico": {
        "valorFixo": "500.00",
        "valorMinimo": "450.00",
        "valorMaximo": "750.00",
        "intervalo": "SEMANAL",
        "dataInicio": "2025-06-06",
        "permiteRetentativa": false,
        "primeiroPagamento": {
          "data": "2024-06-08",
          "valor": "9.99",
          "infoPagador": "Parcela 1"
        }
      }
    }
  }
}

{
  "nome": "parametro_ausente",
  "mensagem": "O parâmetro '{PARAM}' está ausente"
}

{
  "nome": "nao_autorizado",
  "mensagem": "Credenciais inválidas ou permissão insuficiente"
}

{
  "nome": "recurso_nao_encontrado",
  "mensagem": "O recurso solicitado não foi encontrado"
}

{
  "nome": "entidade_nao_processavel",
  "mensagem": "Não foi possível processar a solicitação"
}

{
  "nome": "erro_aplicacao",
  "mensagem": "Erro interno do servidor"
}

Solicitar criação de um pagamento automatico

Este endpoint é utilizado para receber uma requisição do integrador para o envio de um pagamento.

POST /v1/pagamentos-automaticos/pix

Requer autorização para o escopo: gn.opb.automatic.payment.write

Requisição

Exemplo

{
  "identificadorAdesao": "urn:efi:19ba4105-9ae2-4637-89f2-96506d3c8770",
  "pagamento": {
    "valor": "9.99",
    "data": "2024-06-08",
    "codigoCidadeIBGE": "5300108",
    "infoPagador": "Parcela 2x20"
  }
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "identificadorAdesao": "urn:efi:ae71713f-875b-4af3-9d85-0bcb43288847",
  "endToEndId": "E00038166201907261559y6j5",
  "status": "pendente",
  "data": "2024-06-08"
}

{
  "nome": "parametro_ausente",
  "mensagem": "O parâmetro '{PARAM}' está ausente"
}

{
  "nome": "nao_autorizado",
  "mensagem": "Credenciais inválidas ou permissão insuficiente"
}

{
  "nome": "recurso_nao_encontrado",
  "mensagem": "O recurso solicitado não foi encontrado"
}

{
  "nome": "entidade_nao_processavel",
  "mensagem": "Não foi possível processar a solicitação"
}

{
  "nome": "erro_aplicacao",
  "mensagem": "Erro interno do servidor"
}

Consultar pagamentos automaticos

Esse endpoint em questão é uma ferramenta de pesquisa. Ele permite que o usuário busque por um pagamento específico, por pagamentos que possuem um status especifico ou por pagamentos que atendem um critério dentro de um determinado período.

GET /v1/pagamentos-automaticos/pix

Requer autorização para o escopo: gn.opb.automatic.payment.read

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "identificadorAdesao": "urn:efi:49315a93-d39c-4564-9edb-9a73678dbdb1",
  "idProprio": "6236574863254",
  "status": "autorizado",
  "descricao": "Parcelas da faculdade",
  "pagamentos": [
    {
      "endToEndId": "E00038166201907261559y6j6",
      "valor": "1.99",
      "status": "aceito",
      "dataCriacao": "2022-04-29T11:55:03.000Z",
      "infoPagador": "Mensalidade 1x18",
      "devolucoes": [
        {
          "identificadorDevolucao": "D09089356202211111429d82ecc2ecde",
          "valor": "1.99",
          "status": "aceito",
          "dataCriacao": "2022-04-29T11:59:03.000Z"
        }
      ]
    }
  ]
}

{
  "nome": "parametro_ausente",
  "mensagem": "O parâmetro '{PARAM}' está ausente"
}

{
  "nome": "nao_autorizado",
  "mensagem": "Credenciais inválidas ou permissão insuficiente"
}

{
  "nome": "recurso_nao_encontrado",
  "mensagem": "O recurso solicitado não foi encontrado"
}

{
  "nome": "entidade_nao_processavel",
  "mensagem": "Não foi possível processar a solicitação"
}

{
  "nome": "erro_aplicacao",
  "mensagem": "Erro interno do servidor"
}

Solicitar o cancelamento de um pagamento automatico

Este endpoint é utilizado para receber uma requisição do integrador para cancelar um pagamento automatico.

PATCH /v1/pagamentos-automaticos/pix

Requer autorização para o escopo: gn.opb.automatic.payment.write

Requisição

Exemplo

{
  "identificadorAdesao": "urn:efi:19ba4105-9ae2-4637-89f2-96506d3c8770",
  "endToEndId": "E00038166201907261559y6j5"
}

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

{
  "identificadorAdesao": "urn:efi:ae71713f-875b-4af3-9d85-0bcb43288847",
  "idProprio": "6236574863254",
  "endToEndId": "E00038166201907261559y6j5",
  "valor": "9.99",
  "status": "cancelado",
  "motivo": "Cancelado pelo integrador",
  "dataCriacao": "2022-04-29T11:55:03.000Z"
}

{
  "nome": "parametro_ausente",
  "mensagem": "O parâmetro '{PARAM}' está ausente"
}

{
  "nome": "nao_autorizado",
  "mensagem": "Credenciais inválidas ou permissão insuficiente"
}

{
  "nome": "recurso_nao_encontrado",
  "mensagem": "O recurso solicitado não foi encontrado"
}

{
  "nome": "entidade_nao_processavel",
  "mensagem": "Não foi possível processar a solicitação"
}

{
  "nome": "erro_aplicacao",
  "mensagem": "Erro interno do servidor"
}

Pagamentos Automáticos

Solicitar criação de uma adesão para um pagamento automático​

Consultar os parâmetros de uma adesão​

Editar uma adesão​

Solicitar criação de um pagamento automatico​

Consultar pagamentos automaticos​

Solicitar o cancelamento de um pagamento automatico​

Solicitar criação de uma adesão para um pagamento automático

Consultar os parâmetros de uma adesão

Editar uma adesão

Solicitar criação de um pagamento automatico

Consultar pagamentos automaticos

Solicitar o cancelamento de um pagamento automatico