Export - Listar exportações de transações

Permite listar os arquivos de exportação de transações gerados na plataforma. Essas exportações podem ser utilizadas para conciliação, auditoria e integração externa, contendo dados consolidados das transações.


🔽

GET urlServidor/v1/marketplace/transactions/exports

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

Parâmetros da Requisição

Headers

NomeTipoObrigatórioDescrição
integration-keystringSimChave de integração.
x-tokenstringSimToken de autenticação. Pode ser encontrado em nosso portal na guia de integração.
AuthorizationAuth Type Bearer TokenSimInserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl --request GET \
  --location 'urlServidor/v1/marketplace/transactions/exports?perPage=10&page=1' \
  --header 'integration-key: your_integration_key' \
  --header 'x-token: your_x_token' \
  --header 'Authorization: Bearer {{bearer_token}}'

📤 Modelo de resposta

{
  "total":2,
  "page": 1,
  "perPage": 20,
  "lastPage": 1,
  "data": [
    {
      "_id": "6a329c462744ea229e4c70",
      "module": "Transações do Gestor",
      "name": "transacoes-gestor - 1781701702731",
      "marketplace_id": "26",
      "status": "READY",
      "created_at": "2026-06-17T13:08:22.732Z",
      "updated_at": "2026-06-17T13:08:22.732Z",
      "size": 1.786,
      "url": "https://catatau-paytime.s3.sa-east-1.amazonaws.com/exports/marketplace/3b0610cf-c20b-4110-a95d-84a3e49a51.csv"
    },
    {
      "_id": "6a31acf22744ea229e4c45",
      "module": "Transações do Gestor",
      "name": "transacoes-gestor - 1781640434288",
      "marketplace_id": "26",
      "status": "READY",
      "created_at": "2026-06-16T20:07:14.289Z",
      "updated_at": "2026-06-16T20:07:14.289Z",
      "size": 1.023,
      "url": "https://catatau-paytime.s3.sa-east-1.amazonaws.com/exports/marketplace/3b0610cf-c20b-4110-a95d-84a3e49a51.csv"
    }
]
}

📎 Query Parameters

NomeTipoObrigatórioDescrição
filtersstring (JSON)NãoJSON com filtros. Campos filtráveis: created_at,status,module
searchstringNãoTexto livre para busca
perPagenumberNãoQuantidade de registros por página
pagenumberNãoPágina atual
sortersstring (JSON)NãoJSON com lista de ordenadores. Campos ordenáveis: created_at

📊 Campos da resposta

CampoTipoDescrição
totalnumberTotal de registros
pagenumberPágina atual
perPagenumberRegistros por página
lastPagenumberTotal de páginas
dataarrayLista de exportações

📄 Objeto data

CampoTipoDescrição
_idstringIdentificador da exportação
modulestringMódulo de origem
namestringNome do arquivo
marketplace_idnumberID do marketplace
statusstringStatus da exportação
deletedstringData de exclusão
createdstringData de criação
updatedstringData de atualização
sizenumberTamanho do arquivo (KB)
urlstringURL de download do arquivo

📌 Status da exportação

StatusDescrição
PROCESSINGArquivo em processamento
READYArquivo disponível para download
ERRORErro na geração do arquivo

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.


Did this page help you?