🔼
GET urlServidor/v1/marketplace/banking/payments

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

Query Params

Parâmetro	Tipo	Obrigatório	Descrição
`filters`	string (JSON)	Não	JSON com filtros.
`search`	string	Não	Texto de busca livre.
`perPage`	number	Não	Quantidade de registros por página.
`page`	number	Não	Página desejada.
`sorters`	string (JSON)	Não	JSON com critérios de ordenação.

Campos disponíveis em filters

Os seguintes campos podem ser utilizados para filtragem:

status
amount
expected_on
payment_details.card
payment_details.balance
payment_details.fees
payment_details.total
created_at
establishment.id
establishment.type
establishment.access_type
establishment.active
establishment.first_name
establishment.last_name
marketplace.type
marketplace.nickname
marketplace.active
marketplace.first_name
marketplace.last_name

Exemplo de aplicação de filtro.

filters={ "status": "PAID" }

Campos disponíveis em search

A busca textual pesquisa nos seguintes campos:

_id
establishment.first_name
establishment.last_name
establishment.document
marketplace.first_name
marketplace.last_name
marketplace.document

Exemplo de aplicação de filtro.

search=12345678900

Ordenação (sorters)

Permite ordenar o retorno por uma ou mais colunas.

Exemplo de aplicação de ordenação

sorters=[{ "column": "created_at", "direction": "DESC" }]

Exemplo de requisição

GET /v1/marketplace/payments?perPage=20&page=1&filters={ "status":"PROCESSING" }&sorters=[{ "column":"created_at","direction":"DESC" }]

Modelo response

 {
    "total": 6,
    "page": 1,
    "perPage": 20,
    "lastPage": 1,
    "data": [
					{
            "_id": "68fa6717335fe7e377c83322",
            "status": "PROCESSING",
            "expected_on": "2025-10-23T12:00:00.000Z",
            "amount": 150000,
            "payment_details": {
                "balance": 150000,
                "card": 0,
                "total": 150000,
                "fees": 0
            },
            "establishment": {
                "id": 155100,
                "type": "BUSINESS",
                "access_type": "ACQUIRER",
                "active": 1,
                "first_name": "Teste Sandbox",
                "last_name": "Solucoes",
                "document": "11299221000129"
            },
            "marketplace": {
                "id": 26,
                "type": "LICENSED",
                "nickname": "Parceiro Integrações",
                "active": 1,
                "first_name": "Webhooks Integrações",
                "last_name": "API Integrações",
                "document": "60274849000185"
            },
            "created_at": "2025-10-23T17:34:15.554Z"
          } 
	]
}

Detalhe do response

Paginação

Campo	Tipo	Obrigatório	Descrição
`total`	number	Sim	Quantidade total de registros encontrados.
`page`	number	Sim	Página atual.
`perPage`	number	Sim	Quantidade de registros por página.
`lastPage`	number	Sim	Número da última página

Array data[]

Lista de pagamentos encontrados.

Campo	Tipo	Obrigatório	Descrição
`_id`	string	Sim	ID do pagamento.
`status`	string	Sim	Status atual do pagamento.
`expected_on`	date-time	Sim	Data prevista para pagamento.
`amount`	number	Sim	Valor do pagamento.
`payment_details`	object	Sim	Informações detalhadas do pagamento.
`establishment`	object	Sim	Dados do estabelecimento.
`marketplace`	object	Sim	Dados do marketplace.
`created_at`	date-time	Sim	Data de criação do pagamento.
`payment_date`	date-time	Sim	Data de liquidação do pagamento.

payment_details

Campo	Tipo	Obrigatório	Descrição
`balance`	number	Sim	Valor pago com saldo.
`card`	number	Sim	Valor pago com cartão.
`total`	number	Sim	Valor total pago.
`fees`	number	Sim	Taxa aplicada quando pago com cartão.

establishment

Campo	Tipo	Obrigatório	Descrição
`id`	number	Sim	ID do estabelecimento.
`type`	string	Sim	Tipo do estabelecimento: `INDIVIDUAL` ou `BUSINESS`.
`access_type`	string	Sim	Tipo de acesso do estabelecimento.
`active`	number	Sim	Indica se está ativo.
`first_name`	string	Sim	Nome ou razão social.
`last_name`	string	Sim	Nome fantasia.
`document`	string	Sim	CPF ou CNPJ.

marketplace

Campo	Tipo	Obrigatório	Descrição
`id`	number	Sim	ID do marketplace.
`type`	string	Sim	Tipo do marketplace: `WHITELABEL`, `LICENSED`, `REPRESENTATIVE`.
`nickname`	string	Sim	Apelido do marketplace.
`active`	number	Sim	Indica se está ativo.
`first_name`	string	Sim	Nome ou razão social.
`last_name`	string	Sim	Nome fantasia.
`document`	string	Sim	CPF ou CNPJ.

Status possíveis

Status	Descrição
`PENDING`	Pagamento aguardando processamento.
`PROCESSING`	Pagamento em processamento.
`PAID`	Pagamento confirmado.
`REFUNDED`	Pagamento estornado.
`CANCELED`	Pagamento cancelado.

Observações importantes

O endpoint retorna uma visão paginada dos pagamentos.
Recomenda-se o uso de filters em integrações de conciliação.
Para alto volume transacional, é recomendável utilizar created_at, payment_date e status como filtros principais.
O campo payment_daterepresenta a liquidação efetiva do pagamento.

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.