Listar Transferências

🔽
GET urlServidor/v1/marketplace/establishments/transfers

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/establishments/transfers' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

📑 Parâmetros de Query

Nome	Tipo	Obrigatório	Descrição
`filters`	string	Não	JSON com filtros. Campos filtráveis: `status`, `type`, `payer.establishment.document`, `recipient.establishment.document`, `payer.document`, `recipient.document`, `description`, `created_at`,`amount`, `method`. Exemplo: `{ "created_at": { "min": "2025-04-01", "max": "2025-04-12", }`
`search`	string	Não	Texto de busca nos campos: `_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`.
`perPage`	number	Não	Limitado ao máximo de 100 por página.
`page`	number	Não	Página atual.
`sorters`	string	Não	JSON com lista de ordenadores. Campos ordenáveis: `created_at`, `amount`. <br>Exemplo: `[ \{ "column": "created_at", "direction": "DESC" } ]`

✅ Exemplo de Resposta - 200 OK

{
    "total": 1,
    "perPage": 20,
    "page": 1,
    "lastPage": 1,
    "data": [
        {
            "_id": "68a65eba69af539aa8ac9faf",
            "type": "P2P",
            "status": "PENDING",
            "amount": 50000,
            "recipient": {
                "account_number": "300543394162",
                "account_check_digit": "8",
                "establishment": {
                    "id": 155085,
                    "first_name": "EC Cobranças",
                    "last_name": null,
                    "document": "10068114001"
                },
                "marketplace": {
                    "id": 26,
                    "first_name": "Webhooks Integrações",
                    "last_name": "API Integrações",
                    "document": "60274849000185"
                },
                "representative": {
                    "id": 63,
                    "first_name": "EC Cobranças",
                    "last_name": null,
                    "document": "10068114001"
                },
                "type": "CHECKING"
            },
            "payer": {
                "account_number": "416947",
                "account_check_digit": "0",
                "establishment": {
                    "id": 155100,
                    "first_name": "Teste Sandbox",
                    "last_name": "Solucoes",
                    "document": "11299221000129"
                },
                "marketplace": {
                    "id": 26,
                    "first_name": "Webhooks Integrações",
                    "last_name": "API Integrações",
                    "document": "60274849000185"
                },
                "type": "CHECKING"
            },
            "method": "OUT",
            "created_at": "2025-08-20T23:48:10.945Z"
        }
    ]
}

📤 Resposta de Sucesso (200)

Campo	Tipo	Obrigatório	Descrição
`total`	number	Sim	Número total de registros.
`page`	number	Sim	Página atual.
`perPage`	number	Sim	Número de registros por página.
`lastPage`	number	Sim	Total de páginas.
`data`	array	Sim	Lista de transferências.

Estrutura do Objeto Data

Campo	Tipo	Obrigatório	Descrição
`_id`	string	Sim	ID da transferência.
`type`	string	Sim	Tipo da transferência (`TED`, `P2P`, `PIX`, `WITHDRAW`).
`status`	string	Sim	Status atual da transferência (`CREATED`, `PENDING`, `PAID`, `FAILED`, `REFUNDED`, `CANCELED`, `PROCESSING`).
`amount`	number	Sim	Valor transferido (em centavos).
`original_amount`	number	Não	Valor original antes de descontos ou taxas.
`establishment_id`	string	Sim	ID do estabelecimento.
`gateway_key`	string	Não	Código do gateway.
`gateway_authorization`	string	Não	Código de autorização do gateway.
`expected_at`	string	Não	Data prevista para conclusão.
`recipient`	object	Sim	Dados da conta recebedora.
`payer`	object	Sim	Dados da conta pagadora.
`history`	array	Não	Histórico de status da transferência.
`method`	string	Sim	Direção da transferência (`IN` ou `OUT`).
`pixKey`	string	Não	Chave Pix utilizada.
`end_to_end`	string	Não	Identificador único da transação Pix.
`description`	string	Não	Descrição da transferência.
`reprocessed`	boolean	Não	Indica se a transferência foi reprocessada.
`created_at`	string	Sim	Data de criação da transferência.
`updated_at`	string	Não	Data da última atualização.
`fees`	number	Não	Valor total de taxas (em centavos).
`user`	object	Não	Dados do usuário que originou a transferência.

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.