Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Payment

Criar um pedido de pagamento de crédito

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

post/settlement

Query parameters

agreementIdstring required

Identificador do convênio

Example:75dc01b7-6b7d-439d-85bb-7ed0038a9b21

Id do convênio

Request body

payerTaxIdstring

Identificação do pagador

Example request

{
  "payment": {
    "method": "ted"
  },
  "contracts": [
    {
      "contractId": "6764459321/EP",
      "installments": [
        {
          "InstallmentNumber": 1,
          "Amount": 200
        }
      ]
    }
  ]
}

Response

Pedido de liquidação criado com sucesso

idstring

Identificador da liquidação

status'CREATED' | 'VALIDATING' | 'INVALID' | 'WAITING_FOR_PAYMENT' | 'PROCESSED' | 'EXPIRED'

Status da liquidação

Example response

{
  "id": "3382cc6f-1c59-4423-b364-c837deaf110e",
  "payment": {
    "method": "ted",
    "maturityDate": "2023-02-01T18:00:00.000Z"
  },
  "contracts": [
    {
      "installments": [
        1
      ]
    }
  ]
}