v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Payment

Consultar um pedido de pagamento cadastrado

O objetivo dessa rota é pesquisar um pedido de pagamento previamente cadastrado.

get/settlement/{settlementId}

Path parameters

settlementIdstring required

Identificador

Example:3382cc6f-1c59-4423-b364-c837deaf110d

Id da liquidação

Query parameters

agreementIdstring required

Identificador do convênio

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

Id do convênio

Response

Resultado da consulta de pedido de liquidação

idstring

Identificador da liquidação

Status da liquidação

Example response

{
  "id": "3382cc6f-1c59-4423-b364-c837deaf110e",
  "payment": {
    "method": "ted",
    "code": "c3357540-fa15-4dbf-844c-1ce70ddb0d6c",
    "maturityDate": "2023-02-01T18:00:00.000Z",
    "amount": 200.87
  },
  "contracts": [
    {
      "installments": [
        1
      ]
    }
  ]
}