Infopago API Docs
Primeiros PassosQRCodes API - Cash-In
API Contas - Cash-Out
Primeiros PassosQRCodes API - Cash-In
API Contas - Cash-Out
  1. Gerenciamento de Lotes de Cobrança com Vencimentos
  • Evolução da API
  • Tratamento de erros
  • Pix Automático
  • Manual API QR Codes
    • Autenticação
      • Obter token de acesso
    • Gerenciamento de cobranças para pagamento imediato
      • Criar cobrança imediata.
      • Consultar lista de cobranças imediatas.
      • Criar cobrança imediata.
      • Revisar cobrança imediata.
      • Consultar cobrança imediata.
    • Gerenciamento de cobranças com vencimento
      • Consultar lista de cobranças com vencimento.
      • Criar cobrança com vencimento.
      • Revisar cobrança com vencimento.
      • Consultar cobrança com vencimento.
    • Gerenciamento de Lotes de Cobrança com Vencimentos
      • Consultar lotes de cobranças com vencimento.
        GET
      • Criar/Alterar lote de cobranças com vencimento.
        PUT
      • Utilizado para revisar cobranças específicas dentro de um lote de cobranças com vencimento.
        PATCH
      • Consultar um lote específico de cobranças com vencimento.
        GET
    • Configuração de locations para payloads de recorrências
      • Criar location do payload.
      • Consultar locations cadastradas.
      • Recuperar location do payload.
      • Desvincular uma recorrência de uma location.
    • Configuração de locations para payloads
      • Criar location do payload.
      • Consultar locations cadastradas.
      • Recuperar location do payload.
      • Desvincular uma cobrança de uma location.
    • Gerenciamento de Pix recebidos
      • Consultar Pix.
      • Solicitar devolução.
      • Consultar devolução.
      • Consultar Pix recebidos.
    • Gerenciamento de notificações - Webhook
      • Consultar webhooks cadastrados.
      • Cancelar o webhook Pix.
      • Exibir informações acerca do Webhook Pix.
      • Configurar o Webhook Pix.
    • Gerenciamento de recorrências
      • Consultar lista de recorrências.
      • Criar recorrência.
      • Consultar recorrência.
      • Revisar recorrência.
    • Gerenciamento de solicitações de recorrências
      • Criar solicitação de confirmação de recorrência.
      • Consultar solicitação de confirmação de recorrência.
      • Revisar solicitação de confirmação de recorrência.
    • Gerenciamento de cobranças associadas a uma recorrência
      • Criar cobrança recorrente.
      • Consultar lista de cobranças recorrentes.
      • Criar cobrança recorrente.
      • Revisar cobrança recorrente.
      • Consultar cobrança recorrente.
      • Solicitar retentativa de cobrança.
    • Gerenciamento de notificações de recorrências - Webhook
      • Cancelar o Webhook.
      • Exibir informações acerca do Webhook.
      • Configurar Webhook.
    • Gerenciamento de notificações de cobranças recorrentes - Webhook
      • Cancelar o Webhook.
      • Exibir informações acerca do Webhook.
      • Configurar Webhook.
  • Esquemas
    • WebhookPayload
      • WebhookPixBody
    • RequestBodies
      • WebhookRecBody
      • WebhookCobRBody
      • LoteCobVBody
      • LoteCobVBodyRevisado
    • Id da Transação
    • Id fim a fim da transação
    • Id da Devolução
    • Id da location
    • Id da location
    • Revisão
    • ID Recorrência
    • Data de início
    • Data de fim
    • Natureza da Devolução Solicitada
    • Natureza da Devolução
    • Natureza da Devolução
    • Webhook Solicitado
    • Solicitação de Recorrência
    • Cobrança Recorrente Revisada
    • Status do registro da cobrança.
    • Location do Payload
    • Pessoa Física
    • Pessoa Jurídica
    • Pessoa Física
    • Pessoa Jurídica
    • Pessoa Física
    • Pessoa Jurídica
    • Webhook
    • Webhook Base
    • Webhook Base
    • Webhook Base
    • Informações de Agência e Conta
    • Webhook Base
    • Expiração
    • Data de Vencimento
    • Apresentação
    • Criação
    • Id da Solicitação de recorrência
    • Location do Payload Completa
    • Parâmetros de consulta de lotes de cobrança com vencimento.
    • DevolucaoSolicitada
    • Parâmetros de Consulta de Webhooks
    • DadosComplementaresPessoa
    • DadosBancarios
    • Webhook
    • Lote de cobranças com vencimento gerado
    • Paginação
    • Violações
    • Generated schema for Root
    • Valor da cobrança com vencimento calculada retornada pelo payload
    • Recorrência Notificada
    • Status da Recorrência
    • Configuração da Recorrência
    • Status da Solicitação de Recorrência
    • Solicitação de Recorrência
    • Solicitação de Recorrência Completa
    • Cobrança Recorrente Solicitada
    • Configuração da Cobrança Recorrente
    • Status da Cobrança Recorrente
    • Status da Cobrança Recorrente
    • Location do Payload Solicitada
    • Location do Payload Solicitada
    • Location do Payload Completa
    • Parâmetros de Consulta de Cobrança
    • Parâmetros de consulta de locations
    • Problema
    • DadosBancariosRecebedor
    • Location do Payload
    • Location do Payload Completa
    • Solicitação de Recorrência Base
    • Cobrança Base com Copia e Cola
    • Lotes de solicitações de cobranças com vencimento
    • Parâmetros de Consulta de Recorrências
    • Parâmetros de Consulta de Cobrança
    • Cobranças recorrentes consultadas
    • Recorrencias consultadas
    • PixValorOriginal
    • PixValorJuros
    • PixValorMulta
    • PixValorDesconto
    • PixValorAbatimento
    • Parâmetros de consulta de locations
    • Locations Consultadas
    • Locations Consultadas
    • Pix Consultados
    • Webhooks Consultados
    • Webhooks de Recorrências Consultados
    • Devolução
    • Devolução
    • Cobrança Recorrente Base
    • Cobrança Base
    • Pix
    • Pix
    • Parâmetros de Consulta Pix
    • Pessoa Física
    • Pessoa Jurídica
    • Cobrança com vencimento revisada
    • Cobrança com vencimento gerada
    • Payload JSON da cobrança imediata
    • PixValorSaque
    • PixValorTroco
    • DadosDevedor
    • DadosDevedorRecorrencia
    • Dados do Pagador
    • Recorrência Solicitada
    • Histórico de atualização da recorrência.
    • Recorrência Base
    • Histórico de Status da Solicitação de Recorrência
    • Cobrança Recorrente Gerada
    • Cobrança imediata revisada
    • Cobrança imediata gerada
    • Lote de solicitações de alteração ou criação de cobranças com vencimento
    • Payload JSON da cobrança com vencimento
    • Cobranças com vencimento consultadas
    • Cobranças imediatas consultadas
    • Dados relacionados à confirmação da ativação da recorrência.
    • Dados relacionados à confirmação da ativação da recorrência.
    • Cobrança imediata solicitada
    • Cobrança com vencimento solicitada
    • DadosRecebedor
    • Payload da Recorrência
    • Recorrência Completa Pesquisada
    • Recorrência Gerada
    • Valor da cobrança imediata
    • Valor da cobrança imediata retornada pelo payload
    • Recorrência Completa
    • Detalhamento do encerramento da recorrência.
    • Histórico de Atualização da Cobrança Recorrente
    • Histórico de Tentativas da Cobrança Recorrente
    • Recorrência Revisada
    • Valor da cobrança com vencimento
    • Cobrança Recorrente Completa
    • Cobrança Recorrente Notificada
    • Cobrança com vencimento completa
    • Cobrança imediata completa
  1. Gerenciamento de Lotes de Cobrança com Vencimentos

Criar/Alterar lote de cobranças com vencimento.

PUT
/lotecobv/{id}
LoteCobV
Endpoint utilizado para criar ou alterar um lote de cobranças com vencimento.
Para o caso de uso de alteração de cobranças, o array a ser atribuído na requisicão
deve ser composto pelas exatas requisições de criação de cobranças que
constaram no array atribuído na requisição originária.
Não se pode utilizar este endpoint para alterar um lote de cobranças com vencimento
agregando ou removendo cobranças já existentes dentro do conjunto de cobranças
criadas na requisição originária do lote.
Em outras palavras, se originalmente criou-se um lote, por exemplo, com as cobranças
[a, b e c], não se pode alterar esse conjunto de cobranças original que o
lote representa para [a, b, c, d], ou para [a, b].
Por outro lado, pode-se alterar, em lote as cobranças [a, b, c],
conforme originalmente constam na requisição originária do lote.
Uma solicitação de criação de cobrança com status "EM_PROCESSAMENTO" ou "NEGADA"
está associada a uma cobrança não existe de fato, portanto não será
listada em GET /cobv ou GET /cobv/{txid}.
Uma cobrança, uma vez criada via PUT /cobv/{txid},
não pode ser associada a um lote posteriormente.
Uma cobrança, uma vez criada via PUT /lotecobv/{id},
não pode ser associada a um novo lote posteriormente.

Requisição

Authorization
OAuth 2.0
Client Credentials
Adicionar o parâmetro
Authorization
a Cabeçalhos
, cujo valor é concatenar o Token após o Bearer.
Exemplo:
Authorization: Bearer ********************
Token URL: /oauth/token
Scopes:
lotecobv.write-Permissão para alteração de lotes de cobranças com vencimento
or
Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢202
Lote de cobranças com vencimento solicitado para criação.
Esta resposta não possui corpo.
🟠400
🟠403AcessoNegado
🟠404NaoEncontrado
🔴503ServicoIndisponivel
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/lotecobv/' \
--header 'Content-Type: application/json' \
--data '{
    "descricao": "Cobranças dos alunos do turno vespertino",
    "cobsv": [
        {
            "txid": "fb2761260e554ad593c7226beb5cb650",
            "chave": "7c084cd4-54af-4172-a516-a7d1a12b75cc",
            "solicitacaoPagador": "Informar matrícula",
            "calendario": {
                "dataDeVencimento": "2020-12-31",
                "validadeAposVencimento": 30
            },
            "loc": {
                "id": 789
            },
            "devedor": {
                "logradouro": "Alameda Souza, Numero 80, Bairro Braz",
                "cidade": "Recife",
                "uf": "PE",
                "cep": "70011750",
                "cpf": "08577095428",
                "nome": "João Souza"
            },
            "valor": {
                "original": "100.00"
            }
        },
        {
            "txid": "7978c0c97ea847e78e8849634473c1f1",
            "chave": "7c084cd4-54af-4172-a516-a7d1a12b75cc",
            "solicitacaoPagador": "Informar matrícula",
            "calendario": {
                "dataDeVencimento": "2020-12-31",
                "validadeAposVencimento": 30
            },
            "loc": {
                "id": 57221
            },
            "devedor": {
                "logradouro": "Rua 15, Numero 1, Bairro Campo Grande",
                "cidade": "Recife",
                "uf": "PE",
                "cep": "70055751",
                "cpf": "15311295449",
                "nome": "Manoel Silva"
            },
            "valor": {
                "original": "100.00"
            }
        }
    ]
}'
Response Response Example
400 - Exemplo de erro da requisição 1
{
    "type": "https://pix.bcb.gov.br/api/v2/error/LoteCobVOperacaoInvalida",
    "title": "Lote de cobranças inválido.",
    "status": 400,
    "detail": "A requisição que busca alterar ou criar um lote de cobranças com vencimento não respeita o _schema_ ou está semanticamente errada.",
    "violacoes": [
        {
            "razao": "O objeto loteCobV.cobsV não respeita o _schema_.",
            "propriedade": "loteCobV.cobsV"
        },
        {
            "razao": "O campo loteCobV.descricao não respeita o _schema_.",
            "propriedade": "loteCobV.descricao"
        }
    ]
}
Página anterior
Consultar lotes de cobranças com vencimento.
Próxima página
Utilizado para revisar cobranças específicas dentro de um lote de cobranças com vencimento.
Built with