Realize o pagamento de um boleto ou QR Code em ambiente de Stage através desta API, podendo auxiliar em testes no fluxo de gestão de faturas.

Casos de uso
Os casos de uso mais comuns que a API de pagamento de boleto poderá auxiliar são:
- Inserir saldo nas contas de teste
Quando é iniciada a integração, enviamos um e-mail com duas contas de teste.
Para inserir saldo em suas contas de teste, será preciso emitir um boleto por uma das contas e fazer o pagamento pela outra. - Receber evento do Webhook
Caso já tenha registrado o evento com o recurso invoice e o gatilho paid logo após a solicitação de pagamento, a Cora irá disparar o evento com as informações do boleto pago. - Visualização do item no extrato
Após a emissão do boleto, será possível solicitar o pagamento para poder visualizar no extrato esse item com o novo estado.
Quais são 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.
- Boleto: para que a resposta da API seja preenchida, é recomendável que um boleto tenha sido gerado anteriormente.
- Idempotency-Key: UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidades no pagamento.
Headers
Content-Type | application/json |
---|---|
Authorization | Bearer {{access_token}} |
Idempotency-Key | e6371a9c-714f-4e79-955c-58a7755eed15 |
Parâmetros da requisição
Parâmetro | Tipo | Descrição |
---|---|---|
id obrigatório | String | Identificador do boleto a ser pago. |
Parâmetros da resposta
Parâmetro | Tipo | Descrição |
---|---|---|
id obrigatório | String | ID do boleto na Cora. Esse ID precisará ser usado para consultar os detalhes do boleto. |
amountTotal\ obrigatório | Int | Valor total do boleto em centavos. Esse valor é a soma dos valores informados no tributo |
status\ obrigatório | Indica qual é o estado do boleto. Os status possíveis estão na Tabela de status da fatura Tabela de status da fatura. | |
documentUrl\ obrigatório | String | URL do PDF do boleto (os boletos são disponibilizados apenas em PDF, não há versão HTML). |
buyer\ obrigatório | Objeto Buyer | |
seller\ obrigatório | Objeto Seller | |
bankslip\ obrigatório | Objeto BankSlip | |
pix\ opcional | Objeto Pix | |
services\ obrigatório | Array de Objetos Services | |
paymentTerms\ obrigatório | Objeto PaymentTerms | |
fine\ opcional | Objeto Fine | |
discount\ obrigatório | Objeto Discount | |
payments\ obrigatório | Array de Payments. Caso o pagamento ainda não tenha sido fetio o array será vazio [ ]. | |
paymentForms\ obrigatório | String | Informa se o pagamento foi realizado através do código de barras ou QR-code Pix. |
createdAt\ obrigatório | String | Data de criação do boleto. |
authenticationId\ obrigatório | String | Id de autenticação. |
notification\ obrigatório | Objeto Notifications |
Tipos de Objetos
Objeto PaymentStageStatus
Código | Descrição |
---|---|
IN_PAYMENT | Pagamento do boleto em processo de liquidação. |
Objeto Buyer
Parâmetro | Tipo | Descrição |
---|---|---|
name obrigatório | String | Nome do seu cliente (máximo 60 caracteres). |
document\ obrigatório | String | Documento do pagador (CPF ou CNPJ). |
email\ obrigatório | String | E-mail do seu cliente (máximo 60 caracteres). |
type\ obrigatório | String | Identificador de conta PJ. |
address\ obrigatório | Objeto Address |
Objeto Seller
Parâmetro | Tipo | Descrição |
---|---|---|
businessId obrigatório | String | Id da empresa. |
name\ obrigatório | String | Nome da empresa. |
document\ obrigatório | String | Documento do beneficiário (CPF ou CNPJ). |
type\ obrigatório | String | Identificador de conta PJ. |
Erros Comuns
- Caso a tentativa de pagamento seja realizada pelo próprio emissor da fatura, o seguinte erro será retornado:
{ "code": "REC-0007", "message": "Payment attempt of self issued BankSlip" }
