v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB

Pagamentos de boletos

Listar pagamentos

get/v1/marketplace/payments

Query parameters

filtersstring

Example:{ "status": "CREATED" }

JSON com filtros. Campos filtráveis: status,amount,expected_on,payment_details.card,payment_details.balance,payment_details.fees,payment_details.total,created_at,establishment.id,establishment.type,establishment.access_type,establishment.active,establishment.first_name,establishment.last_name,establishment.risk,marketplace.type,marketplace.nickname,marketplace.active,marketplace.first_name,marketplace.last_name

searchstring

Example:Dado a se buscar

Texto de busca. Campos pesquisáveis: _id,establishment.first_name,establishment.last_name,establishment.document,marketplace.first_name,marketplace.last_name,marketplace.document

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": [
    {
      "status": "PAID",
      "establishment": {
        "active": 1
      }
    }
  ]
}