Skip to main content

Listar Saques

Utilize este endpoint para listar saques com filtros e paginação.

Ambientes Disponíveis​

https://api.unoip.com.br

Endpoint​

  • Método: GET
  • Endpoint: /withdrawal
  • 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, PROCESSING, PROCESSED, FAILED, CANCELED, REFUNDED, REJECTEDNãoLista de status para filtrarDeve ser um array não vazio e sem duplicados
idstring (UUID v4)NãoIdentificador do saqueDeve ser UUID v4 válido
pixKeystringNãoChave PIX do saqueDeve ser uma chave PIX válida (CPF, CNPJ, EMAIL, PHONE ou EVP)
endToEndstringNãoIdentificador end-to-end do saqueDeve 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
minAmountnumberNãoValor mínimo do saque (centavos)Deve ser inteiro em centavos; mínimo 10 (R$ 0,10) e máximo 10000000 (R$ 100.000,00)
maxAmountnumberNãoValor máximo do saque (centavos)Deve ser inteiro em centavos; mínimo 10 (R$ 0,10) e máximo 10000000 (R$ 100.000,00)

Exemplo de Requisição​

curl --request GET \
--url https://api.unoip.com..br/withdrawal?status=PENDING&status=PROCESSING&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 saques

Campos do item em data​

CampoTipoObrigatórioDescrição
idstring (UUID)SimIdentificador único do saque
acquirerstringSimAdquirente do saque
amountnumberSimValor do saque (inteiro em centavos)
methodstring (enum) - PIXSimMétodo do saque
webhookUrlstringNãoURL de webhook configurada
externalCodestringNãoSeu código de referência
createdAtstring (ISO)SimData de criação
statusstring (enum) - PENDING, PROCESSING, PROCESSED, FAILED, CANCELED, REFUNDED, REJECTEDSim
  • PENDING: Saque criado, aguardando processamento
  • PROCESSING: Saque em processamento
  • PROCESSED: Saque processado com sucesso
  • FAILED: Erro no processamento
  • CANCELED: Saque cancelado
  • REFUNDED: Saque estornado
  • REJECTED: Saque rejeitado pela gateway
statusHistoryarraySimHistórico de status (ver Sub-Objetos StatusHistory)
updatedAtstring (ISO)SimData da última atualização
amountWithdrawnnumberNãoValor efetivamente sacado
processedDatestring (ISO)NãoData de processamento
errorMessagestringNãoMensagem de erro
endToEndstringNãoIdentificador end-to-end do saque
payerobjectNãoDados do pagador (ver Sub-Objetos AccountHolder)
receiverobjectNãoDados do recebedor (ver Sub-Objetos AccountHolder)
pixKeyobjectNãoDados da chave PIX (ver Sub-Objetos PixKeyVo)
feeAmountnumberNãoValor da taxa

Sub-Objetos​

StatusHistory (item)​

CampoTipoObrigatórioDescrição
statusstring (enum) - PENDING, PROCESSING, PROCESSED, FAILED, CANCELED, REFUNDED, REJECTEDSimStatus do saque
datestring (ISO)SimData do status
durationInMillisecondsnumberSimDuração do status em milissegundos

AccountHolder​

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

BankAccount​

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

PixKeyVo​

CampoTipoObrigatórioDescrição
keystringSimChave PIX
typestring (enum) - CPF, CNPJ, EMAIL, PHONE, EVPSimTipo da chave PIX

Exemplo de Resposta​

{
  "total": 1,
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "acquirer": "UNOIP",
      "amount": 10000,
      "method": "PIX",
      "webhookUrl": "https://sua-api.com/webhooks/withdrawal",
      "externalCode": "SAQUE-123",
      "createdAt": "2026-03-06T12:49:04.681Z",
      "status": "PROCESSED",
      "statusHistory": [
        {
          "status": "PENDING",
          "date": "2026-03-06T12:49:04.681Z",
          "durationInMilliseconds": 1000
        },
        {
          "status": "PROCESSING",
          "date": "2026-03-06T12:49:04.681Z",
          "durationInMilliseconds": 10000
        },
        {
          "status": "PROCESSED",
          "date": "2026-03-06T12:49:04.681Z",
          "durationInMilliseconds": null
        }
      ],
      "updatedAt": "2026-03-06T12:49:04.681Z",
      "amountWithdrawn": 10000,
      "processedDate":  "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"
        }
      },
      "pixKey": {
        "key": "12345678910",
        "type": "CPF"
      },
      "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