v1

latestOpenAPI 3.0.02026-07-244352379.2 KB

Reports

Retrieve a Payout Transaction Report

A GET request to /reporting/payouts/{payout_id}/transactions/ retrieves a Payout Transaction Report.

A Payout Transaction Report includes a list of all transactions associated with the provided payout_id.

Forage defines a transaction as any financial operation that triggers a flow of funds, including both EBT purchases and EBT refunds.

⚠️ Credit/Debit Settlement Handled By PSP

Credit and debit card transactions are included in the report if the transaction occurred via a Fully Hosted integration, but Forage is never involved in the settlement flow for credit/debit. That falls to the credit/debit PSP, so balance your credit/debit accounting against the PSP’s ledger.

get/reporting/payouts/{payout_id}/transactions/

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/{payout_id}/transactions/?cursor=cD0yMDIzLTAxLTMxKzIxJTNBMzElM0ExNC40NTUxNjMlMkIwMCUzQTAw&end_date=2021-02-28&start_date=2021-01-31",
  "results": [
    {
      "merchant_id": "gxe37pc24y",
      "merchant_group_id": "3hsk173gs8",
      "corporation_id": "6sjqk816dj",
      "fns_id": "1234567",
      "recorded_date": "2024-11-04T14:00:00Z",
      "transaction_type": "Purchase",
      "payment_method": "SNAP",
      "transaction_amount": "24.15",
      "forage_fee": "0.34",
      "merchant_net_settlement": "21.29",
      "platform_net_settlement": "2.37",
      "order_id": "a9a7226jm8",
      "external_order_id": "abc123456",
      "payment_id": "mn0yo1orjw",
      "refund_id": "56us47lbpo",
      "chargeback_id": "luw8sozitr",
      "merchant_payout_id": "jakqbi64tv",
      "platform_payout_id": "atn1ulwziv",
      "merchant_destination_account_ref": "c45b20e98a",
      "external_location_id": "6e3b2ff7-51c8-4c64-befa-2eac90f7c3e9"
    }
  ]
}