Acesse o histórico de pagamentos iniciados via API

154
Importante para Integração Direta Para você conseguir efetuar essa integração é obrigatória a leitura sobre "Utilização das APIs" e recomendada a leitura sobre "Instruções Iniciais" e "Client Credentials e Client ID"

Quais são os requisitos para a utilização desta API?

  • Token: possuir um token de acesso válido é essencial. Caso ainda não tenha gerado um, temos um guia detalhado disponível no tópico Fluxos de Autorização e Autenticação.
  • Pagamento: para que a resposta da API seja preenchida, é recomendável que o pagamento de um boleto tenha sido iniciado ou agendado anteriormente.
  • Escopo: para a modalidade Parceria Cora, é necessário ter ativado o escopo correto ao solicitar autorização e gerar token de acesso para que sua aplicação possa acessar e interagir com as informações da conta de forma segura e autorizada. É possível consultar mais detalhes sobre o escopo e autorização no tópico Redirecionamento.
Nome do escopoDescrição
paymentAPIs de iniciação de pagamento

Que tipo de pagamento poderá ser consultado através desta API?

É possível obter informações sobre pagamentos que foram iniciados, mas ainda não foram aprovados ou reprovados. Durante a iniciação de um pagamento via API, é possível agendar o pagamento para uma data futura ou torná-lo imediato após a aprovação no aplicativo. Independentemente da escolha, é possível verificar todas as iniciações pendentes, além de obter detalhes como o valor que será pago e outras informações relevantes sobre a transação.

Bora pro código?

383

Parâmetros da requisição

ParâmetroTipoDescrição
status
obrigatório
StringStatus do pagamento. Possui o valor padrão initiated
start
obrigatório
StringData inicial do intervalo de consulta, no formato YYYY-MM-DD
end
obrigatório
StringData final do intervalo de consulta, no formato YYYY-MM-DD
page
opcional
IntNúmero da página. Possui valor padrão 0, simbolizando a página inicial
size
opcional
IntNúmero de itens por página. Possui o valor padrão 10

Estados dos pagamentos

ParâmetroDescrição
INITIATEDPagamentos iniciados, aguardando a aprovação ou reprovação via aplicativo

Parâmetros da resposta

ParâmetroTipoDescrição
totalItems
obrigatório
IntNúmero total de pagamentos identificados na consulta
has_more
obrigatório
BooleanIndica se existem ou não objetos de pagamento além dos informados na página atual
content
obrigatório
Lista de ContentLista de Objetos Content

Dicas de implementação

188

Premissas

O parâmetro start e o parâmetro end são usados para especificar o intervalo de tempo desejado na consulta. É importante notar que as datas inseridas no parâmetro end devem ser maiores que as datas informadas no parâmetro start

Problemas conhecidos

  • Quando status de pagamento são informados na requisição
  • Quando a data de início ou a data de fim não são informadas

Erros Comuns

Código de erroDescrição
401 (Unauthorized)O token de acesso está inválido ou expirado. Erro comum no momento de trocas de ambientes (Stage/Production)
400 (Bad Request)Requisição mal formatada. Alguns exemplos comuns:

- Status que não está entre os estados descritos em estados do boleto

- O Start e/ou End está com o formato errado. Para garantir que as informações sejam interpretadas e processadas corretamente pelo sistema, é essencial inseri-las no formato YYYY-MM-DD. Um exemplo prático pode ajudar a entender melhor: suponha que você deseja consultar os boletos a partir do dia 15 de janeiro de 2023. Neste caso, a data deve ser informada como 2023-01-15

Tipos de Objetos

Objeto Content

ParâmetroTipoDescrição
id
obrigatório
StringIdentificador do pagamento iniciado
status
obrigatório
StringStatus do pagamento. Neste momento inicial, será definido como "INITIATED"
amount
obrigatório
IntValor total do pagamento em centavos, incluindo juros e multas, ou considerando o desconto do boleto
creditor
obrigatório
CreditorObjeto Creditor
services
obrigatório
ServicesObjeto Services
bank_slip
obrigatório
BankSlipResponseObjeto BankSlipResponse
payment_terms
obrigatório
PaymentTermsResposeObjeto PaymentTermsRespose
created_at
obrigatório
StringData na qual o pagamento foi iniciado via API
scheduled_at
opcional
StringData para a qual o pagamento foi agendado, no formato "YYYY-MM-DD"
code
opcional
StringCódigo definido por você, pode ser um id do recurso no seu sistema.

Integração Direta e Testes

Esta plataforma de documentação, atualmente, não permite o upload de informações importantes como certificados e private keys. Por isso, não recomendamos o uso dela para testes da modalidade de Integração Direta.

Para fazer os testes que incluam essas informações sensíveis pedimos que use um sistema de sua escolha.
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!