Listar liquidações completas

🔽
GET urlServidor/v1/marketplace/liquidations

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": 350000,
        "total_transactions": 8,
        "total_payments": 0
    },
    "total": 2,
    "perPage": 20,
    "page": 1,
    "lastPage": 1,
    "data": [
        {
            "_id": "6720c0e72b1f2399b8e00000",
            "amount": 100000,
            "transactions": 3,
            "status": "PAID",
            "liquidation": "2025-07-22T22:10:38.308Z",
            "establishment": {
                "id": 1,
                "name1": "Estabelecimento Um",
                "name2": "Loja 1",
                "document": "12345678900",
                "status": "PAID",
                "active": true,
                "block": 10,
                "type": "store"
            },
            "marketplace": {
                "id": 1,
                "name1": "Marketplace Teste",
                "name2": "MKT",
                "document": "0099887766",
                "nickname": "mkt_teste"
            },
            "plans": [
                {
                    "id": 1,
                    "name": "Plano Físico",
                    "allow_anticipation": true,
                    "modality": "PHYSICAL",
                    "pivot": {
                        "plan_id": 1,
                        "establishment_id": 1,
                        "active": true
                    }
                }
            ],
            "payments": [],
            "reprocessing": false,
            "history": [],
            "created_at": "2025-07-22T22:10:38.308Z",
            "updated_at": "2025-07-22T22:10:38.308Z",
            "__v": 0
        },
        {
            "_id": "6720c0e72b1f2399b8e11111",
            "amount": 250000,
            "transactions": 5,
            "status": "PENDING",
            "liquidation": "2025-07-22T22:10:38.308Z",
            "establishment": {
                "id": 2,
                "name1": "Estabelecimento Dois",
                "name2": "Loja 2",
                "document": "11223344556",
                "status": "PENDING",
                "active": false,
                "block": 20,
                "type": "restaurant"
            },
            "marketplace": {
                "id": 1,
                "name1": "Marketplace Teste",
                "name2": "MKT",
                "document": "0099887766",
                "nickname": "mkt_teste"
            },
            "plans": [],
            "payments": [],
            "reprocessing": true,
            "history": [],
            "created_at": "2025-07-22T22:10:38.308Z",
            "updated_at": "2025-07-22T22:10:38.308Z",
            "__v": 0
        }
    ]
}

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.
`page`	number	Sim	Página atual.
`perPage`	number	Sim	Quantidade de registros por página.
`lastPage`	number	Sim	Número final de páginas.
`data[]`	array	Sim	Lista de liquidações.
`data[]. _id`	string	Sim	ID da liquidação.
`data[].amount`	number	Sim	Valor total da liquidação, em centavos.
`data[].transactions`	number	Sim	Quantidade de transações associadas à liquidação.
`data[].status`	string	Sim	Status da liquidação. Enum: `[PAID, PENDING, PROCESSING, ERROR]`
`data[].liquidation`	string (date-time)	Sim	Data em que a liquidação foi realizada.
`data[].establishment.id`	number	Sim	ID do estabelecimento participante.
`data[].establishment.name1`	string	Sim	Nome/Razão Social do estabelecimento.
`data[].establishment.name2`	string (nullable)	Não	Nome fantasia ou nome complementar do estabelecimento.
`data[].establishment.document`	string	Sim	Documento do estabelecimento (CNPJ/CPF).
`data[].establishment.status`	string	Sim	Status do estabelecimento na liquidação. Enum: `[PAID, PENDING, PROCESSING, ERROR]`
`data[].establishment.active`	boolean	Sim	Indica se o estabelecimento está ativo.
`data[].establishment.block`	number	Sim	Código do bloco do estabelecimento.
`data[].establishment.type`	string	Sim	Tipo do estabelecimento.
`data[].marketplace.id`	number	Sim	ID do marketplace participante.
`data[].marketplace.name1`	string	Sim	Nome/Razão Social do marketplace.
`data[].marketplace.name2`	string	Sim	Nome fantasia do marketplace.
`data[].marketplace.document`	string	Sim	Documento do marketplace (CNPJ/CPF).
`data[].marketplace.nickname`	string	Sim	Apelido ou nome curto do marketplace.
`data[].plans[]`	array	Sim	Lista de planos vinculados à liquidação.
`data[].plans[].id`	number	Sim	ID do plano.
`data[].plans[].name`	string	Sim	Nome do plano.
`data[].plans[].allow_anticipation`	boolean	Sim	Indica se o plano permite antecipação de recebíveis.
`data[].plans[].modality`	string	Sim	Modalidade do plano. Enum: `[ONLINE, PHYSICAL]`
`data[].plans[].pivot.plan_id`	number	Sim	ID do plano vinculado.
`data[].plans[].pivot.establishment_id`	number	Sim	ID do estabelecimento vinculado ao plano.
`data[].plans[].pivot.active`	boolean	Sim	Indica se o vínculo do plano com o estabelecimento está ativo.
`data[].payments[]`	array	Sim	Lista de pagamentos realizados na liquidação.
`data[].payments[]. _id`	string	Sim	ID do pagamento.
`data[].payments[].amount`	number	Sim	Valor líquido do pagamento, em centavos.
`data[].payments[].status`	string	Sim	Status do pagamento. Enum: `[PAID, PENDING, PROCESSING, ERROR]`
`data[].payments[].original_amount`	number	Sim	Valor original antes de reduções.
`data[].payments[].transfer_id`	string	Sim	ID da transferência associada a este pagamento.
`data[].payments[].send_to_establishment`	boolean	Sim	Indica se o valor será enviado ao estabelecimento.
`data[].payments[].receipt.document`	string	Sim	Documento do titular da conta de recebimento.
`data[].payments[].receipt.form_receipt`	string	Sim	Forma de recebimento. Enum: `[BANKACCOUNT, PAYTIME, PAGBANK, ZOOPBANK]`
`data[].payments[].receipt.type`	string	Sim	Tipo da conta.
`data[].payments[].receipt.routing_number`	string	Sim	Número da agência.
`data[].payments[].receipt.account_check_digit`	string	Sim	Dígito verificador da conta bancária.
`data[].payments[].receipt.routing_check_digit`	string	Sim	Dígito verificador da agência.
`data[].payments[].receipt.account_number`	string	Sim	Número da conta bancária.
`data[].payments[].receipt.bank.id`	number	Sim	ID do banco do destinatário.
`data[].payments[].receipt.bank.name`	string	Sim	Nome do banco do destinatário.
`data[].payments[].receipt.bank.code`	string	Sim	Código do banco.
`data[].payments[].receipt.bank.ispb`	string	Sim	Código ISPB do banco.
`data[].payments[].effect[]`	array	Sim	Lista de efeitos aplicados ao pagamento
`data[].payments[].reductions[]`	array	Sim	Lista de reduções aplicadas ao pagamento.
`data[].payments[].reductions[].amount`	number	Sim	Valor da redução, em centavos.
`data[].payments[].reductions[].motive`	string	Sim	Motivo da redução.
`data[].payments[].reductions[].description`	string	Sim	Descrição adicional da redução.
`data[].payments[].reductions[].file_url`	string	Sim	URL do arquivo da redução.
`data[].payments[].reductions[].status`	string	Sim	Status da redução. Enum: `[CREATED, DELETED]`
`data[].payments[].reductions[].history[]`	array	Sim	Histórico da redução.
`data[].payments[].reductions[].history[].status`	string	Sim	Status no histórico.
`data[].payments[].reductions[].history[].user_id`	number	Sim	ID do usuário responsável.
`data[].payments[].reductions[].history[].created_at`	string	Sim	Data de criação.
`data[].reprocessing`	boolean	Sim	Indica se está em reprocessamento.
`data[].history[]`	array	Sim	Histórico de status da liquidação.
`data[].history[].status`	string	Sim	Status do histórico. Enum: `[PAID, PENDING, PROCESSING, ERROR]`
`data[].history[].created_at`	string	Sim	Data do histórico.
`data[].history[].user.id`	number	Sim	ID do usuário da alteração.
`data[].history[].user.first_name`	string	Sim	Primeiro nome do usuário.
`data[].history[].user.last_name`	string	Sim	Sobrenome do usuário.
`data[].created_at`	string (date-time)	Sim	Data de criação do registro da liquidação.
`data[].updated_at`	string (date-time)	Sim	Data da última atualizaçã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.