v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB
Transferências

Listar transferências

get/v1/marketplace/transfers

Query parameters

filtersstring
Example:{ "status": "CREATED" }

JSON com filtros. Campos filtráveis: status,type,payer.establishment.document,recipient.establishment.document,payer.document,recipient.document,description,created_at,amount,method

searchstring
Example:Dado a se buscar

Texto de busca. Campos pesquisáveis: _id,description,gateway_authorization,pix_protocol,end_to_end,payer.establishment.document,recipient.establishment.document,payer.first_name,recipient.first_name,payer.last_name,recipient.last_name

perPagenumber

Quantidade de registros por página.

pagenumber

Página.

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

JSON com lista de ordenadores. Campos ordenáveis: created_at,amount

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": [
    {
      "recipient": {
        "type": "CHECKING"
      },
      "payer": {
        "type": "CHECKING"
      }
    }
  ]
}