---
title: "Criar um pedido de pagamento de crédito"
method: POST
path: "/settlement"
tags: ["Payment"]
---

# Criar um pedido de pagamento de crédito

`POST /settlement`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/settlement`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://id.btgpactual.com/oauth2/token` scopes: `empresas.btgpactual.com/loans`

O objetivo desta rota é cadastrar um pedido de pagamento de crédito.

## Query parameters

- `agreementId` string, required: Identificador do convênio

## Request body

- object
  - `payerTaxId` string: Identificação do pagador
  - `payment` object
    - `method` string: Método de pagamento para a transferência, Pix ou Ted
  - `contracts` object[]
    - `contractId` string: Idenfiticador do contrato
    - `installments` object[]
      - `InstallmentNumber` number: Número da parcela
      - `Amount` number: Valor

## Response `200`

Pedido de liquidação criado com sucesso

- SettlementSchema
  - `id` string: Identificador da liquidação
  - `payment` object
    - `method` 'pix' | 'ted'
    - `maturityDate` string: Timestamp (ISO 8601) da data e hora limite para expiração do pagamento. O pagamento deve ser realizado até essa hora, caso contrário, a liquidação será cancelada.
    - `amount` string: Valor de pagamento da transação
  - `contracts` object[]
    - `contractId` string: Identificador do contrato
    - `installments` number[]
    - `status` 'PROCESSING' | 'PROCESSED' | 'CANCELLED' | 'INVALID': Status do contrato
  - `status` 'CREATED' | 'VALIDATING' | 'INVALID' | 'WAITING_FOR_PAYMENT' | 'PROCESSED' | 'EXPIRED': Status da liquidação

## Other responses

- `400`: Erro de validação
- `401`: Não autorizado
- `500`: Erro

---

[API](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos.md) - [All operations](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/llms.txt) - [OpenAPI document](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/revisions/2a24d3da114c?raw)
