---
agentTools:
  projectIndex: https://docs.mundipagg.com/llms.txt
---

# Listar saques

Rota para realizar  a consulta de saques para um determinado **recebedor**.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Mundipagg API",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.mundipagg.com/core/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/recipients/{recipient_id}/withdrawals": {
      "get": {
        "summary": "Listar saques",
        "description": "Rota para realizar  a consulta de saques para um determinado **recebedor**.",
        "operationId": "listar-saques",
        "parameters": [
          {
            "name": "recipient_id",
            "in": "path",
            "description": "Código do recebedor",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filtro para o status da transferência",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "created_since",
            "in": "query",
            "description": "Filtro para início do range da data de criação da transferência",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "created_until",
            "in": "query",
            "description": "Filtro para o fim do range da data de criação da transferência",
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "    {\n      \"id\": \"with_dADVpgxcmT0v5voP\",\n      \"amount\": 100,\n      \"status\": \"failed\",\n      \"created_at\": \"2020-01-16T17:04:33Z\",\n      \"updated_at\": \"2020-01-16T17:04:33Z\",\n      \"bank_account\": {\n        \"id\": \"ba_jGXwbQtNASZZrdpE\",\n        \"holder_name\": \"Second recipient\",\n        \"holder_type\": \"company\",\n        \"holder_document\": \"15313587000166\",\n        \"bank\": \"341\",\n        \"branch_number\": \"12345\",\n        \"branch_check_digit\": \"6\",\n        \"account_number\": \"12345\",\n        \"account_check_digit\": \"6\",\n        \"type\": \"checking\",\n        \"status\": \"active\",\n        \"created_at\": \"2020-01-02T20:23:17Z\",\n        \"updated_at\": \"2020-01-02T20:23:17Z\",\n        \"metadata\": {\n          \"meta_key\": \"meta_value\"\n        },\n        \"recipient\": {\n          \"id\": \"rp_yLnAyVpHbQIqZxwO\",\n          \"name\": \"Second recipient\",\n          \"email\": \"second_recipient@mundipagg.com\",\n          \"document\": \"15313587000166\",\n          \"description\": \"Descrição do recebedor 2\",\n          \"type\": \"company\",\n          \"status\": \"active\",\n          \"created_at\": \"2020-01-02T20:23:17Z\",\n          \"updated_at\": \"2020-01-02T20:23:17Z\"\n        }\n      }\n    },\n    {\n      \"id\": \"with_rax8WlIjeHXxwe6z\",\n      \"amount\": 100,\n      \"status\": \"failed\",\n      \"created_at\": \"2020-01-16T17:04:23Z\",\n      \"updated_at\": \"2020-01-16T17:04:23Z\",\n      \"bank_account\": {\n        \"id\": \"ba_jGXwbQtNASZZrdpE\",\n        \"holder_name\": \"Second recipient\",\n        \"holder_type\": \"company\",\n        \"holder_document\": \"15313587000166\",\n        \"bank\": \"341\",\n        \"branch_number\": \"12345\",\n        \"branch_check_digit\": \"6\",\n        \"account_number\": \"12345\",\n        \"account_check_digit\": \"6\",\n        \"type\": \"checking\",\n        \"status\": \"active\",\n        \"created_at\": \"2020-01-02T20:23:17Z\",\n        \"updated_at\": \"2020-01-02T20:23:17Z\",\n        \"metadata\": {\n          \"meta_key\": \"meta_value\"\n        },\n        \"recipient\": {\n          \"id\": \"rp_yLnAyVpHbQIqZxwO\",\n          \"name\": \"Second recipient\",\n          \"email\": \"second_recipient@mundipagg.com\",\n          \"document\": \"15313587000166\",\n          \"description\": \"Descrição do recebedor 2\",\n          \"type\": \"company\",\n          \"status\": \"active\",\n          \"created_at\": \"2020-01-02T20:23:17Z\",\n          \"updated_at\": \"2020-01-02T20:23:17Z\"\n        }\n      }\n    }    "
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true,
  "_id": "5aba89f6b169810058a71e9a:5e2097d56ba4370059bbe004"
}
```