Inicie o pagamento de uma DARF em nome de um cliente através desta API. Assim como outras operações de saída de dinheiro, os pagamento iniciados por API devem ser aprovados no aplicativo.
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.
- DARF: é necessário ter informações essenciais, como o código da receita, período de apuração e data de vencimento. Essas informações, entre outras descritas abaixo, 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. Nós iremos retornar esse código sempre que você consultar uma fatura. |
data\ obrigatório | Objeto Data |
Objeto Data
Parâmetro | Tipo | Descrição |
|---|---|---|
name obrigatório | String | Nome completo. |
code\ obrigatório | String | Código da receita. Aceita 4 ou 5 dígitos. |
identity\ obrigatório | String | Número do CPF ou CNPJ. |
type\ obrigatório | String | Tipo do documento. Valor: "DARF". |
reference_date\ obrigatório | String | Período de apuração. Esta informação pode estar descrita na Guia como Competência. |
due_date\ obrigatório | String | Data de Vencimento da DARF Ex: "2023-05-30" |
scheduled_at\ opcional | String | Campo para agendar um pagamento. Ex: "2023-05-30" |
amount\ obrigatório | Objeto DarfAmount |
Objeto DarfAmount
Parâmetro | Tipo | Descrição |
|---|---|---|
main obrigatório | Int | Valor da Guia. |
fine\ opcional | Int | Multa a ser paga. |
interest\ opcional | Int | Juros a serem pagos. |
Parâmetros da resposta
Objeto PaymentDARF
Parâmetro | Tipo | Descrição |
|---|---|---|
code obrigatório | String | Código definido por você, pode ser um id do recurso no seu sistema. Nós iremos retornar esse código sempre que você consultar uma fatura. |
id\ obrigatório | String | ID do pagamento iniciado. |
status\ obrigatório | String | Objeto PaymentStatus |
amount\ obrigatório | Int | Valor do pagamento em centavos. |
services\ obrigatório | Objeto Services | Objeto Services |
payment_terms\ obrigatório | Objeto PaymentTerms | Objeto PaymentTerms |
created_at\ obrigatório | String | Dia da criação da iniciação de pagamento. Ex: "2023-04-30T13:58:21" |
scheduled_at\ obrigatório | String | Dia que o pagamento foi agendado. Ex: "2023-05-30" |