---
updatedAt: 2025-06-12T21:08:31.000Z
agentTools:
  projectIndex: https://docs.beeteller.com/llms.txt
---

# Get all payouts

Returns a list of the last generated payout orders, paginated. If you don't submit, page 1 will default.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "merchant-api-v30",
    "version": "3.0-latam"
  },
  "servers": [
    {
      "url": "https://api-test.beeteller.com/gtw/3.0"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/payout/": {
      "get": {
        "summary": "Get all payouts",
        "description": "Returns a list of the last generated payout orders, paginated. If you don't submit, page 1 will default.",
        "operationId": "retrieve-all-payouts",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page index",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "merchantReference",
            "in": "query",
            "description": "Filter by your merchantReference",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "Filter by currency",
            "schema": {
              "type": "string",
              "enum": [
                "BRL",
                "USD_EC",
                "UYU",
                "CLP",
                "MXN",
                "COP",
                "PEN"
              ]
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filter by status",
            "schema": {
              "type": "string",
              "enum": [
                "PENDING",
                "FINISHED",
                "CANCELED"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Retrieve all payouts": {
                    "value": "[\n  {\n    \"id\": \"9f77243a-afba-4987-8331-b519a84da766\",\n    \"currency\": \"BRL\",\n    \"value\": 1000.85,\n    \"feeValue\": 55.04,\n    \"status\": \"PENDING\",\n    \"createdAt\": \"2023-08-18T13:42:49.378647-03:00\",\n    \"paidAt\": null,\n    \"merchantReference\": \"your-reference\",\n    \"cancellationReason\": \"\"\n  },\n  {\n    \"id\": \"9f77243a-afba-4987-8331-b519a84da766\",\n    \"currency\": \"BRL\",\n    \"value\": 1000.85,\n    \"feeValue\": 55.04,\n    \"status\": \"PENDING\",\n    \"createdAt\": \"2023-08-18T13:42:49.378647-03:00\",\n    \"paidAt\": null,\n    \"merchantReference\": \"your-reference\",\n    \"cancellationReason\": \"\"\n  }\n]"
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "example": "9f77243a-afba-4987-8331-b519a84da766"
                      },
                      "currency": {
                        "type": "string",
                        "example": "BRL"
                      },
                      "value": {
                        "type": "number",
                        "example": 1000.85,
                        "default": 0
                      },
                      "feeValue": {
                        "type": "number",
                        "example": 55.04,
                        "default": 0
                      },
                      "status": {
                        "type": "string",
                        "example": "PENDING"
                      },
                      "createdAt": {
                        "type": "string",
                        "example": "2023-08-18T13:42:49.378647-03:00"
                      },
                      "paidAt": {},
                      "merchantReference": {
                        "type": "string",
                        "example": "your-reference"
                      },
                      "cancellationReason": {
                        "type": "string",
                        "example": ""
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"detail\": \"Você não tem permissão para executar essa ação.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "detail": {
                      "type": "string",
                      "example": "Você não tem permissão para executar essa ação."
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```