---
title: "Retrieve a Payout Report"
method: GET
path: "/reporting/payouts/"
tags: ["Reports"]
---

# Retrieve a Payout Report

`GET /reporting/payouts/`

A `GET` request to `/reporting/payouts/` retrieves a [Payout Report](https://docs.joinforage.app/reference/reports#payout-summary-reports). A payout is a scheduled funds disbursement from Forage to a merchant. A payout accounts for all transactions, both purchases and refunds, during the scheduled time period.

On success, the API returns a list of payouts that occurred between the provided `start_date` and `end_date`.

## Response `200`

__OK__ - Success

- PayoutReportResponse
  - `next` string, nullable — A URL that you can send a `GET` to in order to retrieve the next set of results. Alternatively, you can retrieve the `cursor` value from the URL and pass it in the body of a new request. This value is `null` if there are no more results.
  - `previous` string, nullable — A URL that you can send a `GET` to in order to retrieve the previous set of results. Alternatively, you can retrieve the `cursor` value from the URL and pass it in the body of a new request. This value is `null` if the response includes the first set of results.
  - `results` object[]
    - `payout_id` string — A unique identifier for the payout that this transaction is associated with.
    - `merchant_id` string, nullable — A 10-character unique hash identifying the merchant associated with this transaction. Blank if the settlement reflects a platform instead of a merchant payout.
    - `fns_id` string, nullable — The FNS number of the merchant. Blank if the settlement reflects a platform instead of a merchant payout.
    - `payout_issued_date` string, date, nullable — A timestamp of when the payout was created.
    - `expected_deposit_date` string, date, nullable — A timestamp of when Forage expects the payout to be deposited. This is typically the payout_issued_date plus one business day, if the ACH method is next-day.
    - `total_purchases` string, decimal — The total amount in USD of all of the purchases included in this payout.
    - `total_refunds` string, decimal — The total amount in USD of all of the refunds included in this payout.
    - `total_void_purchases` string, decimal — The total amount in USD refunded to customers due to a voided purchase initiated by Forage or the server.
    - `total_void_refunds` string, decimal — The total amount in USD debited from customers due to a voided refund initiated by Forage or the server.
    - `total_chargebacks` string, decimal — The total amount in USD of refunds paid to customers as the result of dispute resolutions during this payout period. The `total_chargebacks` value is distinct and not included in the `total_refunds` value.
    - `forage_fee` string, decimal — The amount of Forage fees applied to the transaction
    - `total_positive_adjustments` string, decimal — If any, the total arbitrary amount in USD that has been added to the settlement. For example, this could happen in the rare case that Forage corrects a previous settlement.
    - `total_negative_adjustments` string, decimal — If any, the total arbitrary amount in USD that has been deducted from the settlement. For example, this could happen in the rare case that Forage corrects a previous settlement.
    - `merchant_net_settlement` string, decimal, nullable — The net amount sent to the merchant, equal to the sum of purchases minus refunds, chargebacks, fees, and any other deductions. This value is `null` if the settlement reflects a platform instead of a merchant payout.
    - `platform_net_settlement` string, decimal, nullable — The net amount sent to the platform, if applicable, equal to the sum of purchases minus refunds, chargebacks, fees, and any other deductions. This value is `null` if the settlement reflects a merchant payout and no platform was involved.
    - `merchant_destination_account_ref` string, nullable — A 10-character unique hash for the merchant's destination bank account. `null` if settled to a platform account.

## Other responses

- `400` — Bad Request
- `401` — __Unauthorized__
- `429` — __Too Many Requests__
- `500` — Internal Server Error

---

[API](https://skmtc.net/joinforage/apis/forage-payments-api.md) · [All operations](https://skmtc.net/joinforage/apis/forage-payments-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/joinforage/forage-payments-api/versions/4b7212706fae/schema)