---
updatedAt: 2026-10-16T20:45:13.000Z
agentTools:
  projectIndex: https://developers.cora.com.br/llms.txt
---

# Iniciação de Pagamento DARF

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.

<HTMLBlock>{`
<div class="important-section">
	<img src="https://files.readme.io/e92482c-Group_913.png" alt="154" title="Group 913.png" height="auto" width="auto" loading="lazy">
  
  <div class="important-section__card">
    <span class="important-section__card-title">Importante para Integração Direta</span>
    
    <span class="important-section__card-text">Para você conseguir efetuar essa integração é <b>obrigatória a leitura sobre</b> <a href="https://developers.cora.com.br/docs/utiliza%C3%A7%C3%A3o-das-apis" target="_blank" rel="noreferrer,noopener">"Utilização das APIs"</a> e recomendada a leitura sobre <a href="https://developers.cora.com.br/docs/instrucoes-iniciais" target="_blank" rel="noreferrer,noopener">"Instruções Iniciais"</a> e <a href="https://developers.cora.com.br/docs/client-credentials-int-direta" target="_blank" rel="noreferrer,noopener">"Client Credentials e Client ID"</a></span>
  </div>
</div>

<style></style>
`}</HTMLBlock>

### 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](https://cora-api.readme.io/docs/fluxos-de-autorizacao-e-autenticacao).
* **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](https://cora-api.readme.io/docs/fluxos-de-autorizacao-e-autenticacao#1-redirecionamento).

| Nome do escopo | Descrição                      |
| :------------- | :----------------------------- |
| `payment`      | APIs de iniciação de pagamento |

<HTMLBlock>{`
<div class="code-session">
   <div class="header header-scroll">
      <h3 class="heading heading-2 header-scroll" id="bora-pro-codigo">
        <div class="heading-anchor anchor waypoint" id="bora-pro-codigo"></div>
    
        <div class="heading-text">
          <div id="bora-pro-codigo-section" class="heading-anchor_backwardsCompatibility"></div>
      
	        Bora pro código?
        </div>
    
        <a aria-label="Skip link to Bora pro código?" class="heading-anchor-icon fa fa-anchor" href="#bora-pro-codigo" target="_self">
       </a>
      </h3>
    </div>
  
   <img src="https://files.readme.io/dc19792-Frame_914.png" alt="383" height="auto" width="auto" loading="lazy">
  
</div>

<style></style>
`}</HTMLBlock>

## Parâmetros da requisição

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Parâmetro
      </th>

      <th>
        Tipo
      </th>

      <th>
        Descrição
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        code <span class="tag tag-inline background-light-info">opcional</span>
      </td>

      <td>
        String
      </td>

      <td>
        Código definido por você, pode ser um id do recurso no seu sistema. Aceita até 64 caracteres. O código fica salvo no pagamento e volta na resposta e nas consultas. Não confundir com o code do Objeto Data, que é o código da receita.
      </td>
    </tr>

    <tr>
      <td>
        data\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        [Objeto Data](https://cora-api.readme.io/reference/inicia%C3%A7%C3%A3o-de-pagamento-darf#objeto-data)
      </td>

      <td>
        Objeto [Data](https://cora-api.readme.io/reference/inicia%C3%A7%C3%A3o-de-pagamento-darf#objeto-data)
      </td>
    </tr>
  </tbody>
</Table>

### Objeto Data

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Parâmetro
      </th>

      <th>
        Tipo
      </th>

      <th>
        Descrição
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        name <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        String
      </td>

      <td>
        Nome completo.
      </td>
    </tr>

    <tr>
      <td>
        code\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        String
      </td>

      <td>
        Código da receita. Aceita 4 ou 5 dígitos.
      </td>
    </tr>

    <tr>
      <td>
        identity\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        String
      </td>

      <td>
        Número do CPF ou CNPJ.
      </td>
    </tr>

    <tr>
      <td>
        type\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        String
      </td>

      <td>
        Tipo do documento. Valor: "DARF".
      </td>
    </tr>

    <tr>
      <td>
        reference\_date\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        String
      </td>

      <td>
        Período de apuração. Esta informação pode estar descrita na Guia como Competência.
      </td>
    </tr>

    <tr>
      <td>
        due\_date\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        String
      </td>

      <td>
        Data de Vencimento da DARF Ex: "2023-05-30"
      </td>
    </tr>

    <tr>
      <td>
        scheduled\_at\ <span class="tag tag-inline background-light-info">opcional</span>
      </td>

      <td>
        String
      </td>

      <td>
        Campo para agendar um pagamento. Ex: "2023-05-30". Se a data cair em fim de semana ou feriado nacional, o pagamento é agendado para o próximo dia útil. Se for a data de hoje e a requisição chegar dentro do horário de processamento, o pagamento é feito no mesmo dia, sem agendamento.
      </td>
    </tr>

    <tr>
      <td>
        amount\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        [Objeto DarfAmount](https://cora-api.readme.io/reference/inicia%C3%A7%C3%A3o-de-pagamento-darf#objeto-darfamount)
      </td>

      <td>
        Objeto [DarfAmount](https://cora-api.readme.io/reference/inicia%C3%A7%C3%A3o-de-pagamento-darf#objeto-darfamount)
      </td>
    </tr>
  </tbody>
</Table>

### Objeto DarfAmount

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Parâmetro
      </th>

      <th>
        Tipo
      </th>

      <th>
        Descrição
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        main <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        Int
      </td>

      <td>
        Valor da Guia.
      </td>
    </tr>

    <tr>
      <td>
        fine\ <span class="tag tag-inline background-light-info">opcional</span>
      </td>

      <td>
        Int
      </td>

      <td>
        Multa a ser paga.
      </td>
    </tr>

    <tr>
      <td>
        interest\ <span class="tag tag-inline background-light-info">opcional</span>
      </td>

      <td>
        Int
      </td>

      <td>
        Juros a serem pagos.
      </td>
    </tr>
  </tbody>
</Table>

## Parâmetros da resposta

### Objeto PaymentDARF

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Parâmetro
      </th>

      <th>
        Tipo
      </th>

      <th>
        Descrição
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        code <span class="tag tag-inline background-light-info">opcional</span>
      </td>

      <td>
        String
      </td>

      <td>
        Código definido por você na iniciação, como foi salvo no pagamento. Vem nulo quando a iniciação não informa code.
      </td>
    </tr>

    <tr>
      <td>
        id\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        String
      </td>

      <td>
        ID do pagamento iniciado.
      </td>
    </tr>

    <tr>
      <td>
        status\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        String
      </td>

      <td>
        Objeto PaymentStatus
      </td>
    </tr>

    <tr>
      <td>
        amount\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        Int
      </td>

      <td>
        Valor do pagamento em centavos.
      </td>
    </tr>

    <tr>
      <td>
        services\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        Objeto Services
      </td>

      <td>
        Objeto Services
      </td>
    </tr>

    <tr>
      <td>
        payment\_terms\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        Objeto PaymentTerms
      </td>

      <td>
        Objeto PaymentTerms
      </td>
    </tr>

    <tr>
      <td>
        created\_at\ <span class="tag tag-inline background-light-negative">obrigatório</span>
      </td>

      <td>
        String
      </td>

      <td>
        Dia da criação da iniciação de pagamento. Ex: "2023-04-30T13:58:21"
      </td>
    </tr>

    <tr>
      <td>
        scheduled\_at\ <span class="tag tag-inline background-light-info">opcional</span>
      </td>

      <td>
        String
      </td>

      <td>
        Data efetiva do agendamento, já ajustada para dia útil. Ex: "2023-05-30". Pode ser diferente da data enviada na requisição. Vem nula quando o pagamento é feito no mesmo dia.
      </td>
    </tr>
  </tbody>
</Table>

***

<HTMLBlock>{`
<div class="implementation-tips">
  <h2 class="heading heading-2 header-scroll">Integração Direta e Testes</h2>
      
      <span class="implementation-tips_info-text">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 <b> Integração Direta. </b> </br></br> Para fazer os testes que incluam essas informações sensíveis pedimos que use um sistema de sua escolha. </span>
    </div>
</div>

<style></style>
`}</HTMLBlock>

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "pagamento-de-impostos",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.stage.cora.com.br/payments"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/darf/initiate": {
      "post": {
        "summary": "Iniciação de Pagamento DARF",
        "description": "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.",
        "operationId": "iniciação-de-pagamento-darf",
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "7e30dad7-e0bf-4fb4-a2e4-4ae7c605b523"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "data"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "default": "meu_id"
                  },
                  "data": {
                    "type": "object",
                    "required": [
                      "name",
                      "code",
                      "identity",
                      "type",
                      "reference_date",
                      "due_date"
                    ],
                    "properties": {
                      "name": {
                        "type": "string",
                        "default": "Fulano Ciclano"
                      },
                      "code": {
                        "type": "string",
                        "default": "6015"
                      },
                      "identity": {
                        "type": "string",
                        "default": "06576723350"
                      },
                      "type": {
                        "type": "string",
                        "default": "DARF"
                      },
                      "reference_date": {
                        "type": "string",
                        "default": "2023-04-30",
                        "format": "date"
                      },
                      "due_date": {
                        "type": "string",
                        "default": "2023-05-30",
                        "format": "date"
                      },
                      "scheduled_at": {
                        "type": "string",
                        "default": "2023-05-30",
                        "format": "date"
                      },
                      "amount": {
                        "type": "object",
                        "properties": {
                          "main": {
                            "type": "integer",
                            "default": 1500,
                            "format": "int32"
                          },
                          "fine": {
                            "type": "integer",
                            "default": 0,
                            "format": "int32"
                          },
                          "interest": {
                            "type": "integer",
                            "default": 0,
                            "format": "int32"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "201",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"code\": \"meu_id\",\n  \"data\": {\n    \"id\": \"pay_27mv1KFhHRm0ShCNcKHkjG\",\n    \"status\": \"INITIATED\",\n    \"amount\": 1500,\n    \"services\": [\n      {\n        \"name\": \"Fulano Ciclano\",\n        \"description\": \"Darf - Sem Código De Barras\",\n        \"amount\": 1500\n      }\n    ],\n    \"payment_terms\": {\n      \"due_date\": \"2022-12-30\",\n      \"available_date\": null\n    },\n    \"created_at\": \"2022-05-25T19:32:32\",\n    \"scheduled_at\": \"2022-12-30\"\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "example": "meu_id"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "pay_27mv1KFhHRm0ShCNcKHkjG"
                        },
                        "status": {
                          "type": "string",
                          "example": "INITIATED"
                        },
                        "amount": {
                          "type": "integer",
                          "example": 1500,
                          "default": 0
                        },
                        "services": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "example": "Fulano Ciclano"
                              },
                              "description": {
                                "type": "string",
                                "example": "Darf - Sem Código De Barras"
                              },
                              "amount": {
                                "type": "integer",
                                "example": 1500,
                                "default": 0
                              }
                            }
                          }
                        },
                        "payment_terms": {
                          "type": "object",
                          "properties": {
                            "due_date": {
                              "type": "string",
                              "example": "2022-12-30"
                            },
                            "available_date": {}
                          }
                        },
                        "created_at": {
                          "type": "string",
                          "example": "2022-05-25T19:32:32"
                        },
                        "scheduled_at": {
                          "type": "string",
                          "example": "2022-12-30"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```