v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB

Liquidações

Listar liquidações sumarizadas

get/v1/marketplace/liquidations/extract

Query parameters

filtersstring

Example:{ "status": "CREATED" }

JSON com filtros. Campos filtráveis: amount,transactions,status,establishment.id,establishment.status,establishment.block,establishment.type

searchstring

Example:Dado a se buscar

Texto de busca.

perPagenumber

Quantidade de registros por página.

pagenumber

Página.

sortersstring

Example:[ { "column": "created_at", "direction": "DESC" } ]

JSON com lista de ordenadores.

Headers

integration-keystring required

Chave de integração.

x-tokenstring required

x-token utilizado para autenticação. Pode ser encontrado em nosso portal, na guia de integração com a api pública.

Response

totalnumber required

Número total de registros.

pagenumber required

Página atual.

perPagenumber required

Número de registros por página.

lastPagenumber required

Número total de páginas.

Example response

{
  "data": [
    {
      "receipt": {
        "form_receipt": "BANKACCOUNT",
        "type": "CHECKING"
      },
      "modality": "PHYSICAL"
    }
  ]
}