v1

latestOpenAPI 3.0.02026-07-244352379.2 KB

Reports

Retrieve a Payout Report

A GET request to /reporting/payouts/ retrieves a Payout Report. 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.

get/reporting/payouts/

Response

OK - Success

nextstring 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.

previousstring 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.

Example response

{
  "next": "https://api.sandbox.joinforage.app/reporting/payouts/?cursor=cD0yMDIzLTAxLTMxKzIxJTNBMzElM0ExNC40NTUxNjMlMkIwMCUzQTAw&end_date=2021-02-28&start_date=2021-01-31",
  "results": [
    {
      "payout_id": "f73a3abc01",
      "merchant_id": "gxe37pc24y",
      "fns_id": "1234567",
      "total_purchases": "99.99",
      "total_refunds": "15.11",
      "total_void_purchases": "1.12",
      "total_void_refunds": "0.22",
      "total_chargebacks": "0.00",
      "forage_fee": "2.31",
      "merchant_net_settlement": "21.29",
      "platform_net_settlement": "2.37",
      "merchant_destination_account_ref": "c45b20e98a"
    }
  ]
}