Skip to main content

Listar Transações

Utilize este endpoint para listar transações com filtros.

Ambientes Disponíveis​

https://api.unoip.com.br

Endpoint​

  • Método: GET
  • Endpoint: /transaction
  • Autenticação: Bearer token

Query Params​

ℹ️ Datas em ISO

Os campos startDate e endDate devem ser enviados em ISO date string com horário.

Exemplo:

  • 2026-03-06T12:00:00.000Z
NomeTipoObrigatórioDescriçãoValidações
startDatestringNãoData inicial do filtroDeve ser ISO date string com horário
endDatestringNãoData final do filtroDeve ser ISO date string com horário
statusstring[] (enum) - PENDING, PIX_QRCODE_GENERATED, PAID, PROCESSING_REFUND, PROCESSING_INFRACTION, REFUNDED, INFRACTION, FAILED, BLOCKEDNãoLista de status para filtrarDeve ser um array não vazio e sem duplicados
customerEmailstringNãoE-mail do customerDeve possuir formato de email válido
customerNamestringNãoNome do customerDeve ser alphanumerico internacional
customerDocumentstringNãoDocumento do customerDeve ser CPF ou CNPJ válido
customerPhonestringNãoDocumento do customer
idstring (UUID v4)NãoIdentificador da transaçãoDeve ser UUID v4 válido
endToEndstringNãoIdentificador end-to-end da transaçãoDeve ter entre 8 e 255 caracteres
endToEndRefundstringNãoIdentificador end-to-end do estornoDeve ter entre 8 e 255 caracteres
externalCodestringNãoSeu código de referênciaDeve ter entre 8 e 255 caracteres
paymentMethodstring[] (enum) - PIXNãoLista de métodos de pagamento para filtrarDeve ser um array não vazio e sem duplicados
minAmountnumberNãoValor mínimo da transação (centavos)Deve ser inteiro em centavos; mínimo 1 (R$ 0,01) e máximo 10000000 (R$ 100.000,00)
maxAmountnumberNãoValor máximo da transação (centavos)Deve ser inteiro em centavos; mínimo 1 (R$ 0,01) e máximo 10000000 (R$ 100.000,00)

Exemplo de Requisição​

curl --request GET \
--url https://api.unoip.com.br/transaction?status=PAID&startDate=2026-03-06T00:00:00.000Z&endDate=2026-03-06T23:59:59.999Z \
--header 'Authorization: Bearer seu-token-jwt'

Resposta de Sucesso​

CampoTipoObrigatórioDescrição
totalnumberSimTotal de itens
totalPagesnumberSimTotal de páginas
currentPagenumberSimPágina atual
perPagenumberSimItens por página
dataarraySimLista de transações

Campos do item em data​

CampoTipoObrigatórioDescrição
idstring (UUID)SimIdentificador único da transação
acquirerstringSimAdquirente da transação
amountnumberSimValor da transação (inteiro em centavos)
paymentMethodstring (enum) - PIXSimMétodo de pagamento
webhookUrlstringNãoURL de webhook configurada
externalCodestringNãoSeu código de referência
customerobjectNãoDados do pagador (ver Sub-Objeto AccountHolder)
sellerobjectNãoDados do vendedor (ver Sub-Objeto Seller)
isInfoProductbooleanSimFlag para produtos digitais ou físicos
addressobjectNãoEndereço do cliente (ver Sub-Objeto Address)
itemsobject[]NãoLista de produtos (ver Sub-Objeto Item)
metadataobjectNãoMetadados
createdAtstring (ISO)SimData de criação
statusstring (enum) - PENDING, PIX_QRCODE_GENERATED, PAID, PROCESSING_REFUND, PROCESSING_INFRACTION, REFUNDED, INFRACTION, FAILED, BLOCKEDSim
  • PENDING: Transação criada, aguardando processamento
  • PIX_QRCODE_GENERATED: QRCode PIX gerada, aguardando pagamento
  • PAID: Transação paga
  • PROCESSING_REFUND: Estorno em processamento
  • PROCESSING_INFRACTION: Infração em processamento
  • REFUNDED: Transação estornada
  • INFRACTION: Transação estornada(MED)
  • FAILED: Error no processamento
  • BLOCKED: Bloqueado devido abertura de MED
statusHistoryarraySimHistórico de status (ver Sub-Objeto StatusHistory)
updatedAtstring (ISO)SimData da última atualização
amountPaidnumberNãoValor efetivamente pago (inteiro em centavos)
paymentDatestring (ISO)NãoData de pagamento
infractionDatestring (ISO)NãoData da infração
pixResponseobjectSim (se paymentMethod for PIX)Dados do PIX (ver Sub-Objeto PixResponse)
errorMessagestringNãoMensagem de erro
endToEndstringNãoIdentificador end-to-end da transação
payerobjectNãoDados do pagador (ver Sub-Objeto AccountHolder)
receiverobjectNãoDados do recebedor (ver Sub-Objeto AccountHolder)
feeAmountnumberNãoValor da taxa

Sub-Objetos​

Customer​

CampoTipoObrigatórioDescrição
ipstringNãoIP
namestringSimNome
emailobjectSimE-mail
documentstringSimDocumento
landlineobjectNãoTelefone fixo
mobilePhoneobjectNãoTelefone celular

Seller​

CampoTipoObrigatórioDescrição
namestringSimNome
documentstringSimDocumento

Address​

CampoTipoObrigatórioDescrição
zipCodestringSimCEP do Brasil
numberstringSimNúmero da casa
streetstringSimNome da rua
neighborhoodstringSimNome do bairro
citystringSimNome da cidade
statestringSimNome ou Sigla do estado
countrystringSimNome do país
complementstringNãoInformações adicionais

Item​

CampoTipoObrigatórioDescrição
titlestringSimTítulo
unitPricenumberSimValor do item (inteiro em centavos)
quantitynumberSimQuantidade deste item
descriptionstringNãoInformações adicionais

StatusHistory (item)​

CampoTipoObrigatórioDescrição
statusstring (enum) - PENDING, PIX_QRCODE_GENERATED, PAID, PROCESSING_REFUND, PROCESSING_INFRACTION, REFUNDED, INFRACTION, FAILED, BLOCKEDSimStatus da transação
datestring (ISO)SimData do status
durationInMillisecondsnumberSimDuração do status em milissegundos

PixResponse​

CampoTipoObrigatórioDescrição
uristringSimCopia e cola do QRCode
qrCodeBase64stringSimImagem do QRCode
expirationDatestringSimData de expiração do QRCode

AccountHolder​

CampoTipoObrigatórioDescrição
typestring (enum) - PF, PJSimTipo do titular
namestringSimNome do titular
documentstringSimDocumento do titular
bankAccountobjectSimDados bancários (ver Sub-Objeto BankAccount)
pixobjectSimChave PIX do titular (ver Sub-Objeto PixKeyVo)

BankAccount​

CampoTipoObrigatórioDescrição
typestringSimTipo de conta
branchstringSimAgência
numberstringSimNúmero da conta
digitstringSimDígito da conta
ispbstringSimISPB do banco

Exemplo de Resposta​

{
  "total": 1,
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "acquirer": "UNOIP",
      "amount": 500,
      "paymentMethod": "PIX",
      "webhookUrl": "https://sua-api.com/webhooks/transaction",
      "externalCode": "TRANSACTION-123",
      "customer": {
        "ip": "123123123123",
        "name": "Customer",
        "email": "customer@gmail.com",
        "document": {
          "value": "12312312312",
          "type": "CPF"
        },
        "landline": "12123451234",
        "mobilePhone": "12123451234"
      },
      "seller": {
        "name": "Seller",
        "document": {
          "value": "12312312312",
          "type": "CPF"
        }
      },
      "isInfoProduct": false,
      "address": {
        "zipCode": "54753-800",
        "number": "155",
        "street": "Rua Santa Mariana",
        "neighborhood": "São Pedro",
        "city": "Camaragibe",
        "state": "Pernambuco",
        "country": "Brazil",
        "complement": "Casa Azul"
      },
      "items": [
        {
          "title": "Fone Bluetooth PulseWave X200",
          "unitPrice": 500,
          "quantity": 1,
          "description": "Fone de ouvido sem fio com cancelamento ativo de ruído, bateria de 30h e microfone embutido. Compatível com Android e iOS."
        }
      ],
      "metadata": {
        "moeda": "BRL",
        "autorizacao": "A1B2C3",
        "status": "aprovada"
      },
      "createdAt": "2026-03-06T12:49:04.681Z",
      "status": "PAID",
      "statusHistory": [
        {
          "status": "PENDING",
          "date": "2026-03-06T12:49:04.681Z",
          "durationInMilliseconds": 1000
        },
        {
          "status": "PIX_QRCODE_GENERATED",
          "date": "2026-03-06T12:49:04.681Z",
          "durationInMilliseconds": 10000
        },
        {
          "status": "PAID",
          "date": "2026-03-06T12:49:04.681Z",
          "durationInMilliseconds": null
        }
      ],
      "updatedAt": "2026-03-06T12:49:04.681Z",
      "amountPaid": 500,
      "paymentDate":  "2026-03-06T12:49:04.681Z",
      "infractionDate": null,
      "pixResponse": {
        "uri": "00020126580014br.gov.bcb.pix0136123e4567-e89b-12d3-a456-426614174000",
        "qrCodeBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
        "expirationDate": "2026-03-06T12:49:04.681Z"
      },
      "errorMessage": null,
      "endToEnd": "0123456789",
      "payer": {
        "type": "PF",
        "name": "Fulano de Tal",
        "document": "12345678910",
        "bankAccount": {
          "type": "CHECKING",
          "branch": "0001",
          "number": "123456",
          "digit": "7",
          "ispb": "12345678"
        },
        "pix": {
          "key": "12345678910",
          "type": "CPF"
        }
      },
      "receiver": {
        "type": "PJ",
        "name": "Empresa Exemplo LTDA",
        "document": "12345678000199",
        "bankAccount": {
          "type": "CHECKING",
          "branch": "0001",
          "number": "654321",
          "digit": "0",
          "ispb": "12345678"
        },
        "pix": {
          "key": "contato@exemplo.com",
          "type": "EMAIL"
        }
      },
      "feeAmount": 150,
    }
  ]
}

Possíveis Erros​

CódigoDescriçãoSolução
401Credenciais inválidasVerifique suas credenciais
403Sem permissão/autorizaçãoContate o suporte
422Dados inválidos ou faltandoVerifique o formato dos dados
422ValidaçõesContate o suporte
500Erro internoContate o suporte