---
title: "GET /api/Payout/getreport"
method: GET
path: "/api/Payout/getreport"
tags: ["Payout"]
---

# GET /api/Payout/getreport

`GET /api/Payout/getreport`

## Request

- Base URL: `https://payout-api.stage.bamboopayment.com`
- URL: `https://payout-api.stage.bamboopayment.com/api/Payout/getreport`
- Auth: API key in header `Authorization`

## Query parameters

- `merchantAccount` integer
- `from` string, date-time
- `to` string, date-time
- `page` integer
- `pageSize` integer
- `columns` string[]

## Response `200`

Success

- PayoutReport
  - `data` PayoutData[], nullable
    - `payoutId` integer, nullable
    - `created` string, date-time, nullable
    - `lastUpdate` string, date-time, nullable
    - `status` string, nullable
    - `merchantId` integer, nullable
    - `merchantName` string, nullable
    - `merchantAccountId` integer, nullable
    - `merchantAccountName` string, nullable
    - `inputCurrency` string, nullable
    - `inputAmount` number, double, nullable
    - `exchangeRate` number, double, nullable
    - `currency` string, nullable
    - `amount` number, double, nullable
    - `merchantReference` string, nullable
    - `customerFirstName` string, nullable
    - `customerLastName` string, nullable
    - `customerDocumentType` string, nullable
    - `customerDocumentNumber` string, nullable
    - `customerEmail` string, nullable
    - `customerPhone` string, nullable
    - `customerAddress` string, nullable
    - `bankCode` string, nullable
    - `bankName` string, nullable
    - `bankType` string, nullable
    - `bankBranch` string, nullable
    - `bankNumber` string, nullable
    - `bankCountry` string, nullable
    - `errorCode` string, nullable
    - `errorDescription` string, nullable
    - `paymentMethodType` string, nullable
    - `paymentMethod` string, nullable
    - `pixRandom` string, nullable
    - `pixPhone` string, nullable
    - `pixDocument` string, nullable
    - `pixEmail` string, nullable
    - `description` string, nullable
  - `total` integer
  - `page` integer
  - `pageSize` integer
  - `errors` string[], nullable

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

---

[API](https://skmtc.dev/bamboopayment/apis/payoutapi-public.md) - [All operations](https://skmtc.dev/bamboopayment/apis/payoutapi-public/llms.txt) - [OpenAPI document](https://skmtc.dev/bamboopayment/apis/payoutapi-public/revisions/4434fe6b3fa6?raw)