Obs: A palavra urlServidor deve ser substituída pela url do servidor.
Nome Tipo Obrigatório Descrição integration-keystring Sim Chave de integração. x-token string Sim Token utilizado para autenticação. Pode ser encontrado no portal da API. AuthorizationAuth Type Bearer Token Sim Inserir o Bearer Token, gerado na rota Auth
CURL
curl--request GET \
--location '{{urlServidor}/v1/marketplace/transactions' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \Key Tipo Obrigatório Descrição filters string Não JSON com filtros. Campos filtráveis: created_at,type,status,gateway_authorization,establishment.id,representative.id,point_of_sale.type,point_of_sale.identification_number,original_amount search string Não Valor a ser pesquisado em vários campos. 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,original_amount
Filtro Tipo Obrigatório Exemplo JSON Descrição created_atobject Não { "created_at": { "min": "2025-04-01", "max": "2025-04-12" } }Filtra os registros por intervalo de datas de criação (min e max). statusstring Não { "status": "PAID" }Filtra pelo status. Valores possíveis: CREATED, PENDING, APPROVED, PAID, FAILED, REFUNDED, DISPUTED, CANCELED, CHARGEBACK. typestring Não { "type": "CREDIT" }Filtra pelo tipo de transação. Valores possíveis: CREDIT, DEBIT, PIX. gateway_authorizationstring Não { "gateway_authorization": "PAYTIME" }Filtra pela subadquirente ou gateway responsável pela autorização da transação. Ex.: PAYTIME, ZOOP, PAGSEGURO. establishment.idnumber Não { "establishment.id": 12345 }Filtra pelo ID do estabelecimento. representative.idnumber Não { "representative.id": 987 }Filtra pelo ID do representante. point_of_sale.typestring Não { "point_of_sale.type": "PHYSICAL" }Filtra pelo tipo de ponto de venda. Valores possíveis: PHYSICAL, ONLINE. point_of_sale.identification_numberstring Não { "point_of_sale.identification_number": "POS123" }Filtra pelo número de identificação do ponto de venda. original_amountnumber Não { "original_amount": 10000 }Filtra pelo valor original da transação em centavos.
A resposta será composta por um objeto contendo dados e paginação e um Array com os detalhes das transações.
JSON
{
"total": 1,
"perPage": 20,
"page": 1,
"lastPage": 1,
"data": [
{
"_id": "681259d37903c84441e0e85a",
"status": "PAID",
"amount": 1005,
"original_amount": 1017,
"fees": 12,
"type": "CREDIT",
"gateway_key": "5621785c-08e0-4f25-a022-d5fb94176829",
"gateway_authorization": "PAYTIME",
"card": {
"brand_name": "MASTERCARD",
"first4_digits": "5200",
"last4_digits": "1005",
"expiration_month": "12",
"expiration_year": "2026",
"holder_name": "JOÃO DA SILVA",
"_id": "681259d37903c84441e0e842"
},
"installments": 1,
"point_of_sale": {
"type": "ONLINE",
"identification_type": "API"
},
"acquirer": {
"name": "PAGSEGURO",
"acquirer_nsu": 123456789123,
"gateway_key": "20DDFAE5-F349-4645-8273-D72F94F52155",
"mid": "100000000000002",
"_id": "681259d37903c84441e0e859"
},
"antifraud": [
{
"analyse_status": "NO_ANALYSED",
"_id": "681259d37903c84441e0e857"
}
],
"split": {
"active": true,
"is_origin": true
},
"created_at": "2025-04-30T17:11:47.341Z"
}]Nome Tipo Descrição totalnumber Número total de registros encontrados. pagenumber Página atual da listagem. perPagenumber Quantidade de registros por página. lastPagenumber Número total de páginas. dataArray de objetos Lista de transações encontradas.
Nome Tipo Descrição _idstring Identificador único da transação. statusstring Status da transação. Valores possíveis: CREATED, PENDING, APPROVED, PAID, FAILED, REFUNDED, DISPUTED, CANCELED, CHARGEBACK. amountnumber Valor líquido da transação (em centavos). original_amountnumber Valor bruto da transação (em centavos). feesnumber Valor total de taxas aplicadas (em centavos). typestring Tipo da transação. Valores possíveis: CREDIT, DEBIT, PIX. gateway_authorizationstring Subadquirente responsável. Ex: PAYTIME, ZOOP, PAGSEGURO. installmentsnumber Número de parcelas da transação (caso seja crédito parcelado). created_atdate-time Data da criação da transação. emvstring Código EMV (copia e cola) utilizado em transações do tipo PIX. reference_idstring Identificador definido pelo cliente para controle e rastreamento interno da transação.
Nome Tipo Descrição brand_namestring Bandeira do cartão (ex: VISA, MASTERCARD). first4_digitsstring Quatro primeiros dígitos do cartão. last4_digitsstring Quatro últimos dígitos do cartão. expiration_monthstring Mês de expiração do cartão. expiration_yearstring Ano de expiração do cartão. holder_namestring Nome do portador do cartão.
Nome Tipo Descrição — object Informações do cliente que realizou a transação.
Nome Tipo Descrição typestring Tipo de venda. Valores possíveis: ONLINE, CHIP. identification_typestring Tipo de identificação da leitura. CHIP, CONTACTLESS, MAGNETIC, API. identification_numberstring Número de identificação do ponto de venda (se houver).
Nome Tipo Descrição namestring Nome do adquirente. acquirer_nsunumber Número Sequencial Único do adquirente. gateway_keystring Identificador da transação no gateway/acquirer. midstring Merchant ID (identificação do estabelecimento junto ao adquirente). _idstring Identificador na adquirente
Nome Tipo Descrição installmentnumber Número da parcela. datedate-time Data prevista de liquidação da parcela. amountnumber Valor da parcela (em centavos). statusstring Status da parcela. Ex: PENDING, PAID, CANCELED, REFUNDED, FAILED.
Nome Tipo Obrigatório Descrição analyse_requiredstring Sim Tipo de análise antifraude exigida. Valores: THREEDS, CLEARSALE. analyse_statusstring Sim Resultado da análise. Valores: APPROVED, PROCESSING, WAITING_AUTH, FAILED, NO_ANALYSED.
Nome Tipo Descrição codestring Código da adquirente que indica o motivo da resposta de autorização no pagamento, tanto para pagamento autorizado, quanto para negado messagestring Mensagem amigável descrevendo motivo da não aprovação ou autorização da cobrança. Compatível com o padrão ABECS - Normativo 21. referencestring NSU da autorização, caso o pagamento tenha sido autorizado pelo emissor. authorization_codestring Código de autorização emitido pelo banco emissor do cartão. nsustring O Número Sequencial Único (NSU) é um código de 12 digitos que identifica uma transação. reason_codestring Código do motivo de compra negada enviada pela bandeira do cartão, são ABECS compliance, seguindo normativa nº021. -> link da norma em Norma ABECS
Obs: O objeto split será exibido quando a transação for executada por meio de split.
Campo Tipo Obrigatório Descrição split.activeboolean Sim Indica se a transação possui um split ativo no momento da consulta. split.is_originboolean Sim Indica se a transação é a transação original que originou o split. split.processingboolean Sim Informa se a transação está em processamento de split ou de cancelamento de split . split.initial_amountNumber Condicional Valor original da transação principal. Informado apenas caso a transação seja a que originou o split.
Observação
Transações aguardando autenticação do antifraude, não irão aparecer na listagem e detalhe da transação.
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 .
