Listar extrato do estabelecimento

🔽
GET urlServidor/v1/marketplace/establishments/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 de autenticação. Pode ser encontrado em nosso portal na guia de integração.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth
`establishment\_id`	string	Sim	ID do estabelecimento ao qual os lançamentos estão vinculados.

Exemplo de header da requisição

curl --request GET \
  --url '{{urlServidor}}/v1/marketplace/establishments/balance' \
  --header 'integration-key: sua_integration_key' \
  --header 'x-token: seu_x_token' \
  --header 'establishment_id: 0000' \
  --header 'Accept: application/jso

Exemplo do response

{
    "total": 2,
    "perPage": 200,
    "page": 1,
    "lastPage": 1,
    "data": [
        {
            "type": "OTHERS",
            "modality": "IN",
            "created_at": "2025-08-20T23:08:23.000Z",
            "description": "Deposito",
            "gateway_key": "42cfba69-49c6-41db-890f-75e888093e7e",
            "amount": 5000000,
            "status": "Saldo Liberado",
            "additionalInformation": {
                "old_balance": 0,
                "current_balance": 5000000
            }
        },
        {
            "type": "P2P",
            "modality": "OUT",
            "created_at": "2025-08-20T23:48:13.000Z",
            "description": "TRANSFERNCIA P2P",
            "gateway_key": "14992f6c-ac1c-494c-8a72-2f8260e1bdfd",
            "amount": -50000,
            "status": "Saldo Liberado",
            "additionalInformation": {
                "old_balance": 5000000,
                "current_balance": 4950000
            }
        }
    ]
}

Explicação response

Campo	Tipo	Obrigatório	Descrição
`total`	number	Sim	Total de registros encontrados.
`perPage`	number	Sim	Quantidade de registros por página.
`page`	number	Sim	Página atual retornada.
`lastPage`	number	Sim	Última página disponível.
`data`	array	Sim	Lista de movimentações do extrato.
`type`	string	Sim	Tipo da transferência. Valores: `FEES`, `PIX`, `TED`, `BILLET`, `P2P`.
`modality`	string	Sim	Modalidade da transferência. Valores: `OUT` (saída) ou `IN` (entrada).
`created_at`	string	Sim	Data e hora de criação da transferência.
`description`	string	Sim	Descrição detalhada da transferência. PAGAMENTO DE CONTAS, RECEBIMENTO DE PAGAMENTO, TRANSFERÊNCIA PIX, RECEBIMENTO PIX, DEPOSITO, TRANSFERÊNCIA ENVIADA, TRANSFERÊNCIA RECEBIDA, TRANSFERÊNCIA ENTRE CONTAS (P2P)
`gateway_key`	string	Sim	Chave identificadora da transferência no gateway.
`amount`	number	Sim	Valor da transferência em centavos.
`status`	string	Sim	Status atual da transferência.
`additionalInformation.old_balance`	number	Sim	Saldo anterior do estabelecimento (em centavos).
`additionalInformation.current_balance`	number	Sim	Saldo atual do estabelecimento (em centavos).

Para mais informações, consulte a documentação oficial da Paytime.

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.