--- updatedAt: 2026-05-07T18:17:26.000Z agentTools: projectIndex: https://docs.joinforage.app/llms.txt --- # Retrieve a Payout Report A `GET` request to `/reporting/payouts/` retrieves a [Payout Report](ref: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`. # OpenAPI definition ```json { "openapi": "3.0.0", "x-readme": { "explorer-enabled": false, "proxy-enabled": false }, "info": { "title": "Forage Payments API", "description": "The Forage Payments API is a REST API for processing Electronic Benefits Transfer (EBT) payments (SNAP and EBT Cash) in your e-commerce or in-store application.\n\nProcessing any EBT payment, or checking an EBT card's balance, requires the cardholder's PIN. Federal regulations require all PIN entry to happen through a PCI-compliant, USDA-approved interface. Forage provides that interface, so EBT PIN collection always happens through a Forage-hosted surface (Forage Checkout or a Forage SDK), never directly in your own form. Some endpoints (for example, capture and balance) are only reachable through that surface because they require PIN data in the request.\n\nEBT rarely covers an entire order: items like delivery fees and non-eligible products can't be paid with SNAP or EBT Cash. You decide how to handle the remaining balance (split tender) and any credit or debit processing alongside the EBT portion.\n\nForage offers four integration options. Pick the one that fits your platform and engineering resources:\n\n1. **Fully Hosted Checkout.** Forage processes EBT and credit/debit through a Forage-hosted Checkout UI. Lowest engineering effort, and Forage absorbs most error handling. See the [Fully Hosted Checkout guide](https://docs.joinforage.app/docs/fully-hosted).\n2. **Custom Checkout.** Forage processes EBT; you handle split tender, taxes, and credit/debit in your own checkout flow. Best when you want minimal changes to your existing UX. See the [Custom Checkout guide](https://docs.joinforage.app/docs/custom).\n3. **Online SDKs.** Client-side SDKs for [web](https://docs.joinforage.app/docs/forage-js), [iOS](https://docs.joinforage.app/docs/ios), and [Android](https://docs.joinforage.app/docs/android) that collect EBT PINs in your app while keeping you out of PCI scope.\n4. **POS Terminal SDK.** Accept in-person EBT payments on an Android POS device. See the [POS Terminal guide](https://docs.joinforage.app/docs/forage-terminal-android).\n\nAs a general principle, any data created by your requests, or by your customers on a Forage-hosted surface, is retrievable through GET requests to the appropriate resource.\n\nHave more questions? Use our [contact form](https://www.joinforage.com/get-in-touch) to reach our sales and engineering support teams.\n", "contact": { "name": "API Support", "email": "engineering@joinforage.com" }, "version": "2025-08-04" }, "externalDocs": { "description": "Forage documentation", "url": "https://docs.joinforage.app/" }, "servers": [ { "url": "https://{environment}.joinforage.app", "variables": { "environment": { "default": "api.sandbox", "enum": [ "api", "api.sandbox" ] } } } ], "security": [], "paths": { "/reporting/payouts/": { "parameters": [ { "$ref": "#/components/parameters/AuthenticationBearerTokenHeader" }, { "name": "Merchant-Account", "in": "header", "description": "A unique merchant ID that Forage provides during onboarding, as in `123ab45c67`.\n\nIf querying on behalf of a platform that supports multiple merchants, then omitting this header returns the platform payouts (payouts issued to the platform directly). You must indicate a `Merchant-Account` header to retrieve results for a specific merchant on a platform.\n", "schema": { "type": "string" }, "required": false }, { "$ref": "#/components/parameters/APIVersionHeader" }, { "$ref": "#/components/parameters/StartDateQueryParam" }, { "$ref": "#/components/parameters/EndDateQueryParam" }, { "$ref": "#/components/parameters/LimitQueryParam" }, { "$ref": "#/components/parameters/CursorQueryParam" } ], "get": { "tags": [ "Reports" ], "summary": "Retrieve a Payout Report", "x-readme": { "code-samples": [ { "language": "curl", "code": "curl --request GET \\\n --url 'https://api.sandbox.joinforage.app/reporting/payouts/?start_date=2021-01-31&end_date=2021-02-28&limit=1&cursor=cJ0xMDIzLZAxLTMxKzIxLTNBMzElM0ExNC40NTUxNjMlMkIwMCUzQTAp' \\\n --header 'Authorization: Bearer ' \\\n --header 'Merchant-Account: ' \\\n --header 'accept: application/json'\n" } ] }, "description": "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.\n\nOn success, the API returns a list of payouts that occurred between the provided `start_date` and `end_date`.\n", "operationId": "reporting:payouts", "security": [ { "OAuth2": [ "reporting", "internal" ] } ], "responses": { "200": { "$ref": "#/components/responses/PayoutReport200" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseObject" }, "examples": { "invalid_filters": { "summary": "Invalid Filter", "value": { "path": "/reporting/payouts/", "errors": [ { "code": "invalid_filters", "message": "{filter}: required filter is missing", "source": { "resource": "Reports", "ref": "" } } ] } }, "invalid_input_data": { "summary": "Invalid Input Data", "value": { "path": "/reporting/payouts/", "errors": [ { "code": "invalid_input_data", "message": "Query parameter missing or incomplete.", "source": { "resource": "Reports", "ref": "" } } ] } }, "invalid_merchant_account": { "summary": "Invalid Merchant Account", "value": { "path": "/reporting/payouts/", "errors": [ { "code": "invalid_merchant_account", "message": "Merchant account Merchant ID not valid.", "source": { "resource": "Merchants" } } ] } } } } } }, "401": { "description": "__Unauthorized__", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseObject" }, "examples": { "invalid_token": { "summary": "Invalid Token", "value": { "path": "/reporting/payouts/", "errors": [ { "code": "invalid_token", "message": "Incorrect authentication credentials.", "source": { "resource": "Accounts", "ref": "" } } ] } } } } } }, "429": { "description": "__Too Many Requests__", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseObject" }, "examples": { "too_many_requests": { "summary": "Too Many Requests", "value": { "path": "/reporting/payouts/", "errors": [ { "code": "too_many_requests", "message": "Request was throttled, please try again later.", "source": { "resource": "Reports", "ref": "" } } ] } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseObject" }, "examples": { "secure_storage_inaccessible": { "summary": "Secure Storage Inaccessible", "value": { "path": "/reporting/payouts/", "errors": [ { "code": "secure_storage_inaccessible", "message": "Temporarily unable to access data in secure storage. Please try again.", "source": { "resource": "Reports", "ref": "" } } ] } }, "unknown_server_error": { "summary": "Unknown Server Error", "value": { "path": "/reporting/payouts/", "errors": [ { "code": "unknown_server_error", "message": "Unable to continue", "source": { "resource": "Reports", "ref": "" } } ] } } } } } } } } } }, "components": { "schemas": { "ErrorsArray": { "type": "array", "description": "An array with information about the error.", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "A short string that represents the error." }, "message": { "type": "string", "description": "A developer-facing message with more details about the error, not to be displayed to customers." }, "source": { "type": "object", "properties": { "resource": { "type": "string", "description": "The type of the Forage resource involved in the error." }, "ref": { "type": "string", "description": "If applicable, the ten character reference hash of the Forage resource that caused the error. An empty string if no specific individual resource was involved." } } }, "details": { "type": "object", "description": "Additional details about the error, if applicable." } } }, "example": [] }, "ErrorResponseObject": { "type": "object", "description": "An object that includes details about the error.", "properties": { "path": { "type": "string", "description": "The requested endpoint." }, "errors": { "$ref": "#/components/schemas/ErrorsArray" } } }, "PaginatedReportCommonFields": { "properties": { "next": { "type": "string", "nullable": true, "description": "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.\n\nThis value is `null` if there are no more results.\n" }, "previous": { "type": "string", "nullable": true, "description": "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.\n\nThis value is `null` if the response includes the first set of results.\n" } } }, "PayoutReportResponse": { "allOf": [ { "$ref": "#/components/schemas/PaginatedReportCommonFields" }, { "type": "object", "properties": { "next": { "example": "https://api.sandbox.joinforage.app/reporting/payouts/?cursor=cD0yMDIzLTAxLTMxKzIxJTNBMzElM0ExNC40NTUxNjMlMkIwMCUzQTAw&end_date=2021-02-28&start_date=2021-01-31" }, "previous": { "example": null }, "results": { "type": "array", "items": { "type": "object", "properties": { "payout_id": { "type": "string", "description": "A unique identifier for the payout that this transaction is associated with.\n", "example": "f73a3abc01" }, "merchant_id": { "type": "string", "nullable": true, "description": "A 10-character unique hash identifying the merchant associated with this transaction. Blank if the settlement reflects a platform instead of a merchant payout.\n", "example": "gxe37pc24y" }, "fns_id": { "type": "string", "nullable": true, "description": "The FNS number of the merchant. Blank if the settlement reflects a platform instead of a merchant payout.", "example": "1234567" }, "payout_issued_date": { "type": "string", "format": "date", "nullable": true, "description": "A timestamp of when the payout was created." }, "expected_deposit_date": { "type": "string", "format": "date", "nullable": true, "description": "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": { "type": "string", "format": "decimal", "description": "The total amount in USD of all of the purchases included in this payout.", "example": "99.99" }, "total_refunds": { "type": "string", "format": "decimal", "description": "The total amount in USD of all of the refunds included in this payout.", "example": "15.11" }, "total_void_purchases": { "type": "string", "format": "decimal", "description": "The total amount in USD refunded to customers due to a voided purchase initiated by Forage or the server.", "example": "1.12" }, "total_void_refunds": { "type": "string", "format": "decimal", "description": "The total amount in USD debited from customers due to a voided refund initiated by Forage or the server.", "example": "0.22" }, "total_chargebacks": { "type": "string", "format": "decimal", "description": "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.", "example": "0.00" }, "forage_fee": { "type": "string", "format": "decimal", "description": "The amount of Forage fees applied to the transaction", "example": "2.31" }, "total_positive_adjustments": { "type": "string", "format": "decimal", "description": "If any, the total arbitrary amount in USD that has been added to the settlement.\nFor example, this could happen in the rare case that Forage corrects a previous settlement.\n" }, "total_negative_adjustments": { "type": "string", "format": "decimal", "description": "If any, the total arbitrary amount in USD that has been deducted from the settlement.\n\nFor example, this could happen in the rare case that Forage corrects a previous settlement.\n" }, "merchant_net_settlement": { "type": "string", "format": "decimal", "nullable": true, "description": "The net amount sent to the merchant, equal to the sum of purchases minus refunds, chargebacks, fees, and any other deductions.\n\nThis value is `null` if the settlement reflects a platform instead of a merchant payout.\n", "example": "21.29" }, "platform_net_settlement": { "type": "string", "format": "decimal", "nullable": true, "description": "The net amount sent to the platform, if applicable, equal to the sum of purchases minus refunds, chargebacks, fees, and any other deductions.\n\nThis value is `null` if the settlement reflects a merchant payout and no platform was involved.\n", "example": "2.37" }, "merchant_destination_account_ref": { "type": "string", "nullable": true, "description": "A 10-character unique hash for the merchant's destination bank account. `null` if settled to a platform account.\n", "example": "c45b20e98a" } } } } } } ] } }, "responses": { "PayoutReport200": { "description": "__OK__ - Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutReportResponse" } } } } }, "parameters": { "AuthenticationBearerTokenHeader": { "name": "Authorization", "in": "header", "description": "An OAuth 2.0 [authentication token](https://docs.joinforage.app/docs/authentication#authentication-tokens) that validates the request. Send a `POST` to the [`/o/token/`](https://docs.joinforage.app/reference/create-authentication-token) endpoint to generate an authentication token. Pass the token in this header after the word `Bearer` and a whitespace, for example `Bearer `.", "schema": { "type": "string" }, "required": true }, "StartDateQueryParam": { "name": "start_date", "in": "query", "description": "The date that the reporting period starts, represented as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) UTC date string, inclusive. The result set includes all reported items that occurred on the date.\n", "required": true, "schema": { "type": "string", "format": "date" } }, "EndDateQueryParam": { "name": "end_date", "in": "query", "description": "The date that the reporting period ends, represented as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) UTC date string, inclusive. The result set includes all reported items that occurred on the date.\n", "required": true, "schema": { "type": "string", "format": "date" } }, "CursorQueryParam": { "name": "cursor", "in": "query", "description": "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.", "schema": { "type": "string" } }, "LimitQueryParam": { "name": "limit", "in": "query", "description": "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.\n\nDefaults to `100`.\n", "required": false, "schema": { "type": "integer", "default": 100 } }, "APIVersionHeader": { "name": "API-Version", "in": "header", "description": "The [Forage version](https://docs.joinforage.app/reference/version-history), represented as a string with the format of a `YYYY-MM-DD` date.\n\nIf not specified in the request header, then the version defaults to the value set in the Forage dashboard.\n", "schema": { "type": "string" }, "required": false } }, "securitySchemes": { "OAuth2": { "type": "oauth2", "description": "Pass the access token in the 'Authorization' header with the format \"Bearer ${token}\", i.e. the word \"Bearer\" and your access token from the /o/token/ API, separated by whitespace.\n", "flows": { "password": { "tokenUrl": "/o/token/", "scopes": { "hosted_checkout": "Scope for tokens used by merchant applications which allow Forage to manage split tender processing (i.e. EBT + Credit/Debit).\n", "pinpad_only": "Scope for tokens used by merchant applications which manage their own split tender (i.e. Forage Checkout is used only for EBT processing).\n" } }, "clientCredentials": { "tokenUrl": "/o/token/", "scopes": { "internal": "Scope for tokens used by Forage internal applications.\n", "pin-protected": "Scope for tokens which can access secure storage.\n", "disbursement": "Scope for tokens which can disburse money to merchants.\n" } } } } } } } ``` # Sibling pages * [Retrieve an Order Report](https://docs.joinforage.app/reference/get-order-report.md) * [Retrieve a Payout Transaction Report](https://docs.joinforage.app/reference/get-payout-transaction-report.md) * [Retrieve a Transaction Report](https://docs.joinforage.app/reference/get-transaction-report.md)