Iniciação de pagamento

Inicie ou agende pagamentos através desta 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.
  • Boleto: é necessário ter informações essenciais, como a linha digitável de um boleto que se deseja pagar. Essas informações são necessárias para que a API possa processar e validar a transação de forma correta e eficiente. Além disso, é importante garantir que as informações inseridas estejam corretas para evitar erros ou atrasos no processo de pagamento.
  • 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

Bora pro código?

383

Parâmetros da requisição

ParâmetroTipoDescrição
code
opcional
StringCódigo definido por você, pode ser um id do recurso no seu sistema.
digitable_line
obrigatório
StringCódigo de barras da fatura a ser paga
scheduled_at
opcional
StringCampo para agendar um pagamento, no formato "YYYY-MM-DD"

Parâmetros da resposta

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.

Dicas de implementação

188

Premissas

Os pagamentos iniciados por API são processados pelo banco, mas, assim como outras operações de saída de dinheiro, exigem aprovação no aplicativo para garantir que a transação seja segura e autêntica. Isso adiciona uma camada extra de segurança ao processo de pagamento e ajuda a evitar transações indesejadas

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:

- Digitable_line de um boleto gerado pelo proprietário do token utilizado, ou seja, pelo próprio cliente que está tentando iniciar o pagamento

Tipos de Objetos

Objeto Creditor

ParâmetroTipoDescrição
name
obrigatório
StringNome da pessoa/entidade a quem se deve dinheiro ou outra obrigação financeira
document
obrigatório
StringNúmero do documento do seu cliente (apenas números, sem traços e pontos)
type
obrigatório
StringTipo de documento, os valores possíveis são "CPF" e "CNPJ"

Objeto BankSlipResponse

ParâmetroTipoDescrição
barcode
obrigatório
StringCódigo de barras do boleto
digitable
obrigatório
StringLinha digitável do boleto. Número que deverá ser utilizado para pagamento
registered
obrigatório
booleanInforma se o boleto foi registrado ou não
url
opcional
StringURL do PDF do boleto
fine
obrigatório
IntValor do pagamento iniciado correspondente à multa aplicada
interest
obrigatório
IntValor do pagamento iniciado correspondente ao juros aplicado
interest_monthly_percent
obrigatório
IntTaxa percentual de juros a ser cobrada
fine_percent
obrigatório
IntPorcentagem do valor total a ser cobrada quando o pagamento é atrasado ou não realizado dentro do prazo estipulado
fine_value
obrigatório
IntValor fixo a ser cobrado quando o pagamento não é realizado dentro do prazo estipulado
discount_percent
obrigatório
IntPorcentagem do valor total a ser reduzido em forma de desconto caso o pagamento seja realizado um dia antes da data de vencimento definida
discount_value
obrigatório
IntValor fixo a ser reduzido em forma de desconto caso o pagamento seja realizado um dia antes da data de vencimento definida

Objeto PaymentTermsResponse

ParâmetroTipoDescrição
due_date
obrigatório
StringData de vencimento da iniciação de pagamento (prazo limite para aprovação)

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!