Retrieve a Payout Transaction Report

get

https://{environment}.joinforage.app/reporting/payouts/{payout_id}/transactions/

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.

Path Params

payout_id

string

required

The unique identifier for the payout, retrieved from a Payout Report.

Query Params

limit

integer

Defaults to 100

The maximum number of objects to include in the results array. Not to exceed 1000. If the limit exceeds 1000, then Forage returns a 400 error response.

Defaults to 100.

cursor

string

The starting point for the results, as returned in a previous /reporting/ request. Find a cursor in the URL returned in the next and/or previous response values.

Headers

Authorization

string

required

An OAuth 2.0 authentication token that validates the request. Send a POST to the /o/token/ endpoint to generate an authentication token. Pass the token in this header after the word Bearer and a whitespace, for example Bearer <api_key>.

Merchant-Account

string

A unique merchant ID that Forage provides during onboarding, as in 123ab45c67.

If querying on behalf of a platform that supports multiple merchants, then omitting this header returns platform-wide results. You must indicate a Merchant-Account header to retrieve results for a specific merchant on a platform.

API-Version

string

The Forage version, represented as a string with the format of a YYYY-MM-DD date.

If not specified in the request header, then the version defaults to the value set in the Forage dashboard.

Responses

200OK - Success

400Bad Request

401Unauthorized

404Not Found

429Too Many Requests

500Internal Server Error