Listar liquidações sumarizadas

🔽
GET urlServidor/v1/marketplace/liquidations/extract

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token utilizado para autenticação. Pode ser encontrado no portal da API.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request GET \
--location '{{urlServidor}/v1/marketplace/liquidations/extract' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros de Query

Nome	Tipo	Descrição
`filters`	string	JSON com filtros. Campos filtráveis: amount,transactions,status,establishment.id,establishment.status,establishment.block,establishment.type
`search`	string	Texto de busca.
`perPage`	number	Limitado ao máximo de 100 por página.
`page`	number	Página atual.
`sorters`	string	JSON com lista de ordenadores. Exemplo: `[ { "column": "created_at", "direction": "DESC" } ]`

Exemplo de Response de sucesso.

{
    "meta": {
        "total_amount": 100000,
        "total_transactions": 1,
        "total_payments": 0
    },
    "total": 1,
    "perPage": 20,
    "page": 1,
    "lastPage": 1,
    "data": [
        {
            "_id": "6720c0e72b1f2399b8e00000",
            "amount": 100000,
            "liquidation": "2025-07-22T22:10:38.308Z",
            "receipt": {
                "form_receipt": "BANKACCOUNT",
                "type": "CHECKING",
                "bank": {
                    "name": "Banco Teste",
                    "code": "001"
                }
            },
            "marketplace": {
                "id": 1,
                "document": "0099887766",
                "name1": "Marketplace Teste",
                "name2": "MKT",
                "nickname": "mkt_teste"
            },
            "establishment": {
                "id": 1,
                "document": "12345678900",
                "name1": "Estabelecimento Um",
                "name2": "Loja 1"
            },
            "modality": "PHYSICAL",
            "transfer_id": "0000c0e72b1f2399b8e00000",
            "payment_id": "1110c0e72b1f2399b8e00000"
        }
    ]
}

Obs: Em ambiente SANDBOX os dados da resposta serão sempre os mesmos, pois não é executado liquidações em SANDBOX.

📋 Explicação de Atributos da Resposta

Campo	Tipo	Obrigatório	Descrição
`total`	number	Sim	Número total de registros encontrados.
`page`	number	Sim	Página atual da listagem.
`perPage`	number	Sim	Quantidade de registros por página.
`lastPage`	number	Sim	Número da última página.
`data[]`	array	Sim	Lista das liquidações sumarizadas.
`data[]. _id`	string	Sim	Identificador único da liquidação.
`data[].amount`	number	Sim	Valor total da liquidação em centavos.
`data[].liquidation`	string (date-time)	Sim	Data em que a liquidação foi realizada.
`data[].receipt.form_receipt`	string	Sim	Forma de recebimento da liquidação. Enum: `[ BANKACCOUNT, PAYTIME, PAGBANK, ZOOPBANK ]`
`data[].receipt.type`	string	Sim	Tipo da conta bancária. Enum: `[ CHECKING, SAVING ]`
`data[].receipt.bank.name`	string	Sim	Nome da instituição financeira onde o valor será creditado.
`data[].receipt.bank.code`	string	Sim	Código do banco de destino.
`data[].marketplace.id`	number	Sim	Identificador do marketplace relacionado à liquidação.
`data[].marketplace.document`	string	Sim	Documento do marketplace (CNPJ ou CPF).
`data[].marketplace.name1`	string	Sim	Razão Social ou Nome principal do marketplace.
`data[].marketplace.name2`	string	Sim	Nome fantasia ou nome complementar do marketplace.
`data[].marketplace.nickname`	string	Sim	Apelido ou nome curto do marketplace.
`data[].establishment.id`	number	Sim	ID do estabelecimento participante da liquidação.
`data[].establishment.document`	string	Sim	Documento do estabelecimento (CNPJ ou CPF).
`data[].establishment.name1`	string	Sim	Razão Social ou Nome principal do estabelecimento.
`data[].establishment.name2`	string (nullable)	Não	Nome fantasia ou nome complementar do estabelecimento (se houver).
`data[].modality`	string	Sim	Modalidade da transferência. Enum: `[ ONLINE, PHYSICAL ]`
`data[].transfer_id`	string	Sim	ID da transferência vinculada a esta liquidação.
`data[].payment_id`	string	Sim	ID do pagamento associado a esta liquidação.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.