Infopago API Docs
Primeiros PassosQRCodes API - Cash-In
API Contas - Cash-Out
Primeiros PassosQRCodes API - Cash-In
API Contas - Cash-Out
  1. Gerenciamento de cobranças para pagamento imediato
  • 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.
        POST
      • Consultar lista de cobranças imediatas.
        GET
      • Criar cobrança imediata.
        PUT
      • Revisar cobrança imediata.
        PATCH
      • Consultar cobrança imediata.
        GET
    • 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.
      • Criar/Alterar lote de cobranças com vencimento.
      • Utilizado para revisar cobranças específicas dentro de um lote de cobranças com vencimento.
      • Consultar um lote específico de cobranças com vencimento.
    • 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 cobranças para pagamento imediato

Revisar cobrança imediata.

PATCH
/cob/{txid}
Cob

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:
cob.write-Permissão para alteração de cobranças imediatas
or
Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200
application/json
Cobrança imediata revisada. A revisão deve ser incrementada em 1.
Bodyapplication/json

🟠400
🟠403AcessoNegado
🟠404NaoEncontrado
🔴503ServicoIndisponivel
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request PATCH '/cob/' \
--header 'Content-Type: application/json' \
--data '{
    "solicitacaoPagador": "Cobrança dos serviços prestados.",
    "loc": {
        "id": 7768
    },
    "devedor": {
        "cpf": "12345678909",
        "nome": "Francisco da Silva"
    },
    "valor": {
        "original": "123.45"
    }
}'
Response Response Example
200 - Exemplo de cobrança revisada 1
{
    "txid": "7978c0c97ea847e78e8849634473c1f1",
    "revisao": 1,
    "location": "pix.example.com/qr/v1/9d36b84fc70b478fb95c12729b90ca25",
    "status": "ATIVA",
    "chave": "a1f4102e-a446-4a57-bcce-6fa48899c1d1",
    "solicitacaoPagador": "Cobrança dos serviços prestados.",
    "calendario": {
        "criacao": "2020-09-09T20:15:00.358Z",
        "expiracao": 3600
    },
    "loc": {
        "id": 7768,
        "location": "pix.example.com/qr/b1/9d36b84fc70b478fb95c12729b90ca25",
        "tipoCob": "cob"
    },
    "devedor": {
        "cpf": "12345678909",
        "nome": "Francisco da Silva"
    },
    "valor": {
        "original": "123.45",
        "modalidadeAlteracao": 0
    }
}
Página anterior
Criar cobrança imediata.
Próxima página
Consultar cobrança imediata.
Built with