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 escopo	Descrição
`payment`	APIs 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.

Parâmetros da requisição

Parâmetro	Tipo	Descrição
status obrigatório	String	Status do pagamento. Possui o valor padrão initiated
start\ obrigatório	String	Data inicial do intervalo de consulta, no formato YYYY-MM-DD
end\ obrigatório	String	Data final do intervalo de consulta, no formato YYYY-MM-DD
page\ opcional	Int	Número da página. Possui valor padrão 0, simbolizando a página inicial
size\ opcional	Int	Número de itens por página. Possui o valor padrão 10

Estados dos pagamentos

Parâmetro	Descrição
INITIATED	Pagamentos iniciados, aguardando a aprovação ou reprovação via aplicativo

Parâmetros da resposta

Parâmetro	Tipo	Descrição
totalItems obrigatório	Int	Número total de pagamentos identificados na consulta
has_more\ obrigatório	Boolean	Indica se existem ou não objetos de pagamento além dos informados na página atual
content\ obrigatório	Lista de Content	Lista de Objetos Content

Dicas de implementação

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 erro

Descriçã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âmetro	Tipo	Descrição
id obrigatório	String	Identificador do pagamento iniciado
status\ obrigatório	String	Status do pagamento. Neste momento inicial, será definido como "INITIATED"
amount\ obrigatório	Int	Valor total do pagamento em centavos, incluindo juros e multas, ou considerando o desconto do boleto
creditor\ obrigatório	Creditor	Objeto Creditor
services\ obrigatório	Services	Objeto Services
bank_slip\ obrigatório	BankSlipResponse	Objeto BankSlipResponse
payment_terms\ obrigatório	PaymentTermsRespose	Objeto PaymentTermsRespose
created_at\ obrigatório	String	Data na qual o pagamento foi iniciado via API
scheduled_at\ opcional	String	Data para a qual o pagamento foi agendado, no formato "YYYY-MM-DD"
code\ opcional	String	Código definido por você, pode ser um id do recurso no seu sistema.