HomeGuidesReference
Log In
Reference

Changelog

This page details every change introduced with every supported version of the Forage API. Each version is named after its release date, following the YYYY-MM-DD convention.

2024-08-30

  • Payout Summary API now shows ACH information instead of daily aggregations. This means each result in the API corresponds to an ACH made to the customer’s bank account. The API response has been restructured.
    • The contents of the response is semantically the same for most as they are disbursed on a daily schedule.
    • Each entry in the old reports corresponded to an ACH for customers that receive daily settlements. For other merchants where disbursements are made on a monthly aggregated amount, in the old Payout Report, they would see a result for each day’s aggregation, but the one ACH they receive that month is a sum of that month’s daily aggregations. In the new report, they will only see one entry per ACH meaning they will only see one entry for a month (with the amount equal to the sum of that month’s transactions) because it's only disbursed once that month.
  • Payout Transaction Report:
    • “Payout” in this case is now referring to an ACH rather than a daily aggregation
    • The meaning of the query parameter “payout_id” represents an ACH (Forage PayoutGroup) rather than a daily aggregation (Forage PlannedDisbursement): https://{environment}.joinforage.app/reporting/payouts/{payout_id}/transactions/
    • API response fields naming has changed for a few fields. merchant_payout_id and platform_payout_id now refer to a single ACH.
  • Transaction Report Response
    • API response field names have changed

2024-05-07

  • Updated all timestamp values in API response objects to UTC.

2024-03-05

  • Updated the Create a Custom Payment Capture Session endpoint to accept a payment_details object instead of separate snap_total or ebt_cash_total request body parameters.
    • With this change, Forage automatically creates associated OrderPayments for the Capture Session.
  • Added a PATCH endpoint to Update an OrderPayment.

2024-02-15

2024-01-08

2023-05-15

Original unversioned release

  • Introduced split tender over SNAP, EBT Cash, and credit/debit cards.