List Withdrawals

Use this route to list withdrawals for your account or a specific partner, filtered by a date range.

Unlike Get Withdrawal, this route does not return the transactions that compose each withdrawal.

Important

This route requires prior enablement by Marlim. Contact our support team for more information.

GETv3/financial/withdrawals

Request Query Params

Attribute	Type	Description
sub_seller_id	string	Partner ID whose withdrawals will be listed. When omitted, the query returns withdrawals for the seller account.
date_start	date	Start of the range in YYYY-MM-DD. Default: 7 days before date_end (today, Brasília time).
date_end	date	End of the range in YYYY-MM-DD. Default: today (Brasília time). Must be greater than or equal to date_start.
page	int32	Page number. Default: 1. Minimum: 1.
page_size	int32	Items per page. Default: 20. Minimum: 1. Maximum: 100.

Maximum range

The interval between date_start and date_end cannot exceed 180 days.

Response Object

Attribute	Type	Description
withdrawals	array	Withdrawals in the requested range.
withdrawals[][withdrawal_id]	string	Withdrawal ID.
withdrawals[][amount]	int32	Withdrawal amount in cents.
withdrawals[][status]	string	Current status. Possible values: processing, transferred.
withdrawals[][date_created]	dateTime	Withdrawal creation date in ISODateTime format.
withdrawals[][date_updated]	dateTime	Last update date in ISODateTime format.

Example 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

Attribute	Type	Description
errors	array	Array with all errors found while processing the request.
errors[][type]	string	Type of error that occurred.
errors[][message]	string	Detailed message of the error that occurred.

Example error

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

Examples

ATTENTION

The values used in the examples below are for illustration only and must not be used to make requests to Marlim APIs.

Account withdrawals

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"
    }
  ]
}

Partner withdrawals

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"
    }
  ]
}

Invalid range

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."
    }
  ]
}

Partner not found

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"
    }
  ]
}