Listar Saques

Use esta rota para listar os saques da sua conta ou de um parceiro específico, filtrados por intervalo de datas.

Diferente de Consultar Saque, esta rota não retorna as transações que compõem cada saque.

Importante

Esta rota depende de habilitação prévia pela Marlim. Entre em contato com o nosso time de suporte para mais informações.

GETv3/financial/withdrawals

Request Query Params

Atributo	Tipo	Descrição
sub_seller_id	string	ID do parceiro cujos saques serão listados. Quando omitido, a consulta retorna os saques da conta do seller.
date_start	date	Início do intervalo no formato YYYY-MM-DD. Padrão: 7 dias antes de date_end (hoje, horário de Brasília).
date_end	date	Fim do intervalo no formato YYYY-MM-DD. Padrão: hoje (horário de Brasília). Deve ser maior ou igual a date_start.
page	int32	Página da consulta. Padrão: 1. Mínimo: 1.
page_size	int32	Quantidade de itens por página. Padrão: 20. Mínimo: 1. Máximo: 100.

Intervalo máximo

O intervalo entre date_start e date_end não pode ultrapassar 180 dias.

Response Object

Atributo	Tipo	Descrição
withdrawals	array	Lista de saques do intervalo solicitado.
withdrawals[][withdrawal_id]	string	ID do saque.
withdrawals[][amount]	int32	Valor do saque em centavos.
withdrawals[][status]	string	Status atual. Valores possíveis: processing, transferred.
withdrawals[][date_created]	dateTime	Data de criação do saque no formato ISODateTime.
withdrawals[][date_updated]	dateTime	Data da última atualização do saque no formato ISODateTime.

Exemplo de Response

{
  "withdrawals": [
    {
      "withdrawal_id": "withdrawal_1234567890",
      "amount": 10000,
      "status": "processing",
      "date_created": "2026-08-20T14:30:00.000Z",
      "date_updated": "2026-08-20T14:30:00.000Z"
    }
  ]
}

Error Object

Atributo	Tipo	Descrição
errors	array	Array com todos os erros encontrados ao processar a requisição.
errors[][type]	string	Tipo de erro ocorrido.
errors[][message]	string	Mensagem detalhada do erro ocorrido.

Exemplo de erro

{
  "errors": [
    {
      "type": "not_found",
      "message": "Sub Seller with id [sub_123456789] was not found"
    }
  ]
}

Exemplos

ATENÇÃO

Os valores utilizados nos exemplos abaixo são apenas para ilustração e não devem ser usados para fazer requests nas APIs da Marlim.

Saques da conta

Request

curl -X GET -G "https://api.marlim.co/v3/financial/withdrawals" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_start="2026-08-14" \ 
-d date_end="2026-08-20"

Response200

{
  "withdrawals": [
    {
      "withdrawal_id": "withdrawal_1234567890",
      "amount": 10000,
      "status": "processing",
      "date_created": "2026-08-20T14:30:00.000Z",
      "date_updated": "2026-08-20T14:30:00.000Z"
    }
  ]
}

Saques do parceiro

Request

curl -X GET -G "https://api.marlim.co/v3/financial/withdrawals" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d sub_seller_id="sub_k4m6Rw5rlQszEY7fiuRe" \ 
-d date_start="2026-08-14" \ 
-d date_end="2026-08-20" \ 
-d page="1" \ 
-d page_size="20"

Response200

{
  "withdrawals": [
    {
      "withdrawal_id": "withdrawal_9876543210",
      "amount": 5000,
      "status": "transferred",
      "date_created": "2026-08-18T10:00:00.000Z",
      "date_updated": "2026-08-19T09:15:00.000Z"
    }
  ]
}

Intervalo inválido

Request

curl -X GET -G "https://api.marlim.co/v3/financial/withdrawals" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_start="2026-08-20" \ 
-d date_end="2026-08-10"

Response400

{
  "errors": [
    {
      "type": "date_end",
      "message": "The parameter [ date_end ] must be greater than or equal to date_start."
    }
  ]
}

Parceiro não encontrado

Request

curl -X GET -G "https://api.marlim.co/v3/financial/withdrawals" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d sub_seller_id="sub_123456789"

Response404

{
  "errors": [
    {
      "type": "not_found",
      "message": "Sub Seller with id [sub_123456789] was not found"
    }
  ]
}