Listar Depositos

Utilize este endpoint para listar depositos com filtros.

Ambientes Disponíveis

Produção

https://api.unoip.com.br

Endpoint

Método: GET
Endpoint: /deposit
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

Nome	Tipo	Obrigatório	Descrição	Validações
`startDate`	string	Não	Data inicial do filtro	Deve ser ISO date string com horário
`endDate`	string	Não	Data final do filtro	Deve ser ISO date string com horário
`status`	string[] (enum) - `PENDING`, `PIX_QRCODE_GENERATED`, `PAID`, `PROCESSING_REFUND`, `PROCESSING_INFRACTION`, `REFUNDED`, `INFRACTION`, `FAILED`, `BLOCKED`	Não	Lista de status para filtrar	Deve ser um array não vazio e sem duplicados
`customerEmail`	string	Não	E-mail do customer	Deve possuir formato de email válido
`customerName`	string	Não	Nome do customer	Deve ser alphanumerico internacional
`customerDocument`	string	Não	Documento do customer	Deve ser CPF ou CNPJ válido
`customerPhone`	string	Não	Documento do customer
`id`	string (UUID v4)	Não	Identificador do deposito	Deve ser UUID v4 válido
`endToEnd`	string	Não	Identificador end-to-end do deposito	Deve ter entre 8 e 255 caracteres
`endToEndRefund`	string	Não	Identificador end-to-end do estorno	Deve ter entre 8 e 255 caracteres
`externalCode`	string	Não	Seu código de referência	Deve ter entre 8 e 255 caracteres
`paymentMethod`	string[] (enum) - `PIX`	Não	Lista de métodos de pagamento para filtrar	Deve ser um array não vazio e sem duplicados
`minAmount`	number	Não	Valor mínimo do deposito (centavos)	Deve ser inteiro em centavos; mínimo `1` (R$ 0,01) e máximo `10000000` (R$ 100.000,00)
`maxAmount`	number	Não	Valor máximo do deposito (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
JavaScript

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

const params = new URLSearchParams({
  startDate: '2026-03-06T00:00:00.000Z',
  endDate: '2026-03-06T23:59:59.999Z'
});
params.append('status', 'PAID');

const response = await fetch(`https://api.unoip.com.br/deposit?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer seu-token-jwt'
  }
});
const data = await response.json();

Resposta de Sucesso

Campo	Tipo	Obrigatório	Descrição
`total`	number	Sim	Total de itens
`totalPages`	number	Sim	Total de páginas
`currentPage`	number	Sim	Página atual
`perPage`	number	Sim	Itens por página
`data`	array	Sim	Lista de depositos

Campos do item em `data`

Campo	Tipo	Obrigatório	Descrição
`id`	string (UUID)	Sim	Identificador único do deposito
`acquirer`	string	Sim	Adquirente do deposito
`amount`	number	Sim	Valor do deposito (inteiro em centavos)
`paymentMethod`	string (enum) - `PIX`	Sim	Método de pagamento
`webhookUrl`	string	Não	URL de webhook configurada
`externalCode`	string	Não	Seu código de referência
`createdAt`	string (ISO)	Sim	Data de criação
`status`	string (enum) - `PENDING`, `PIX_QRCODE_GENERATED`, `PAID`, `PROCESSING_REFUND`, `PROCESSING_INFRACTION`, `REFUNDED`, `INFRACTION`, `FAILED`, `BLOCKED`	Sim	PENDING: Deposito criada, aguardando processamento PIX_QRCODE_GENERATED: QRCode PIX gerada, aguardando pagamento PAID: Deposito paga PROCESSING_REFUND: Estorno em processamento PROCESSING_INFRACTION: Infração em processamento REFUNDED: Deposito estornada INFRACTION: Deposito estornada(MED) FAILED: Error no processamento BLOCKED: Bloqueado devido abertura de MED
`statusHistory`	array	Sim	Histórico de status (ver Sub-Objeto `StatusHistory`)
`updatedAt`	string (ISO)	Sim	Data da última atualização
`amountPaid`	number	Não	Valor efetivamente pago (inteiro em centavos)
`paymentDate`	string (ISO)	Não	Data de pagamento
`pixResponse`	object	Sim (se `paymentMethod` for `PIX`)	Dados do PIX (ver Sub-Objeto `PixResponse`)
`errorMessage`	string	Não	Mensagem de erro
`endToEnd`	string	Não	Identificador end-to-end do deposito
`payer`	object	Não	Dados do pagador (ver Sub-Objeto `AccountHolder`)
`receiver`	object	Não	Dados do recebedor (ver Sub-Objeto `AccountHolder`)
`feeAmount`	number	Não	Valor da taxa

Sub-Objetos

StatusHistory (item)

Campo	Tipo	Obrigatório	Descrição
`status`	string (enum) - `PENDING`, `PIX_QRCODE_GENERATED`, `PAID`, `PROCESSING_REFUND`, `PROCESSING_INFRACTION`, `REFUNDED`, `INFRACTION`, `FAILED`, `BLOCKED`	Sim	Status do deposito
`date`	string (ISO)	Sim	Data do status
`durationInMilliseconds`	number	Sim	Duração do status em milissegundos

PixResponse

Campo	Tipo	Obrigatório	Descrição
`uri`	string	Sim	Copia e cola do QRCode
`qrCodeBase64`	string	Sim	Imagem do QRCode
`expirationDate`	string	Sim	Data de expiração do QRCode

AccountHolder

Campo	Tipo	Obrigatório	Descrição
`type`	string (enum) - `PF`, `PJ`	Sim	Tipo do titular
`name`	string	Sim	Nome do titular
`document`	string	Sim	Documento do titular
`bankAccount`	object	Sim	Dados bancários (ver Sub-Objeto `BankAccount`)
`pix`	object	Sim	Chave PIX do titular (ver Sub-Objeto `PixKeyVo`)

BankAccount

Campo	Tipo	Obrigatório	Descrição
`type`	string	Sim	Tipo de conta
`branch`	string	Sim	Agência
`number`	string	Sim	Número da conta
`digit`	string	Sim	Dígito da conta
`ispb`	string	Sim	ISPB 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/deposit",
      "externalCode": "TRANSACTION-123",
      "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",
      "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ódigo	Descrição	Solução
401	Credenciais inválidas	Verifique suas credenciais
403	Sem permissão/autorização	Contate o suporte
422	Dados inválidos ou faltando	Verifique o formato dos dados
422	Validações	Contate o suporte
500	Erro interno	Contate o suporte

Ambientes Disponíveis​

Endpoint​

Query Params​

Exemplo de Requisição​

Resposta de Sucesso​

Campos do item em data​

Sub-Objetos​

StatusHistory (item)​

PixResponse​

AccountHolder​

BankAccount​

Exemplo de Resposta​

Possíveis Erros​

Ambientes Disponíveis

Endpoint

Query Params

Exemplo de Requisição

Resposta de Sucesso

Campos do item em `data`

Sub-Objetos

StatusHistory (item)

PixResponse

AccountHolder

BankAccount

Exemplo de Resposta

Possíveis Erros