post https://api.stage.cora.com.br/payments/initiate
Inicie ou agende pagamentos através desta API
![Group 913.png 154](https://files.readme.io/e92482c-Group_913.png)
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 escopo | Descrição |
---|---|
payment | APIs de iniciação de pagamento |
Parâmetros da requisição
Parâmetro | Tipo | Descrição |
---|---|---|
code opcional | String | Código definido por você, pode ser um id do recurso no seu sistema. |
digitable_line obrigatório | String | Código de barras da fatura a ser paga |
scheduled_at opcional | String | Campo para agendar um pagamento, no formato "YYYY-MM-DD" |
Parâmetros da resposta
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. |
Dicas de implementação
![188](https://files.readme.io/b95e2f5-Frame_911.png)
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 indesejadasErros 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: - 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âmetro | Tipo | Descrição |
---|---|---|
name obrigatório | String | Nome da pessoa/entidade a quem se deve dinheiro ou outra obrigação financeira |
document obrigatório | String | Número do documento do seu cliente (apenas números, sem traços e pontos) |
type obrigatório | String | Tipo de documento, os valores possíveis são "CPF" e "CNPJ" |
Objeto BankSlipResponse
Parâmetro | Tipo | Descrição |
---|---|---|
barcode obrigatório | String | Código de barras do boleto |
digitable obrigatório | String | Linha digitável do boleto. Número que deverá ser utilizado para pagamento |
registered obrigatório | boolean | Informa se o boleto foi registrado ou não |
url opcional | String | URL do PDF do boleto |
fine obrigatório | Int | Valor do pagamento iniciado correspondente à multa aplicada |
interest obrigatório | Int | Valor do pagamento iniciado correspondente ao juros aplicado |
interest_monthly_percent obrigatório | Int | Taxa percentual de juros a ser cobrada |
fine_percent obrigatório | Int | Porcentagem do valor total a ser cobrada quando o pagamento é atrasado ou não realizado dentro do prazo estipulado |
fine_value obrigatório | Int | Valor fixo a ser cobrado quando o pagamento não é realizado dentro do prazo estipulado |
discount_percent obrigatório | Int | Porcentagem 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 | Int | Valor fixo a ser reduzido em forma de desconto caso o pagamento seja realizado um dia antes da data de vencimento definida |
Objeto PaymentTermsResponse
Parâmetro | Tipo | Descrição |
---|---|---|
due_date obrigatório | String | Data de vencimento da iniciação de pagamento (prazo limite para aprovação) |