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.

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"

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-Typeapplication/json
AuthorizationBearer {{access_token}}
Idempotency-Keye6371a9c-714f-4e79-955c-58a7755eed15

Bora pro código?

383

Parâmetros da requisição

ParâmetroTipoDescrição
id
obrigatório
StringIdentificador do boleto a ser pago.

Parâmetros da resposta

ParâmetroTipoDescrição
id
obrigatório
StringID do boleto na Cora. Esse ID precisará ser usado para consultar os detalhes do boleto.
amountTotal
obrigatório
IntValor total do boleto em centavos. Esse valor é a soma dos valores informados no tributo services.
status
obrigatório
Objeto PaymentStageStatusIndica 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
StringURL do PDF do boleto (os boletos são disponibilizados apenas em PDF, não há versão HTML).
buyer
obrigatório
Objeto BuyerObjeto Buyer
seller
obrigatório
Objeto SellerObjeto Seller
bankslip
obrigatório
Objeto BankSlipObjeto BankSlip
pix
opcional
Objeto PixObjeto Pix
services
obrigatório
Objeto ServicesArray de Objetos Services
paymentTerms
obrigatório
Objeto PaymentTermsObjeto PaymentTerms
fine
opcional
Objeto FineObjeto Fine
discount
obrigatório
Objeto DiscountObjeto Discount
payments
obrigatório
Objeto PaymentsArray de Payments. Caso o pagamento ainda não tenha sido fetio o array será vazio [ ].
paymentForms
obrigatório
StringInforma se o pagamento foi realizado através do código de barras ou QR-code Pix.
createdAt
obrigatório
StringData de criação do boleto.
authenticationId
obrigatório
StringId de autenticação.
notification
obrigatório
Objeto NotificationsObjeto Notifications

Tipos de Objetos

Objeto PaymentStageStatus

CódigoDescrição
IN_PAYMENTPagamento do boleto em processo de liquidação.

Objeto Buyer

ParâmetroTipoDescrição
name
obrigatório
StringNome do seu cliente (máximo 60 caracteres).
document
obrigatório
StringDocumento do pagador (CPF ou CNPJ).
email
obrigatório
StringE-mail do seu cliente (máximo 60 caracteres).
type
obrigatório
StringIdentificador de conta PJ.
address
obrigatório
Objeto AddressObjeto Address

Objeto Seller

ParâmetroTipoDescrição
businessId
obrigatório
StringId da empresa.
name
obrigatório
StringNome da empresa.
document
obrigatório
StringDocumento do beneficiário (CPF ou CNPJ).
type
obrigatório
StringIdentificador 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" }


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.
Imagem
Opa, agora é hora do lanche! Sim, aprendemos a pagar boletos em stage
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!