--- title: "Retrieve all OrderRefunds for an Order" method: GET path: "/api/orders/{order_ref}/refunds/" tags: ["Order Refunds"] --- # Retrieve all OrderRefunds for an Order `GET /api/orders/{order_ref}/refunds/` A `GET` request to `/orders/{order_ref}/refunds/` retrieves all `OrderRefunds` associated with the provided `order_ref`. On success, the API responds with an array of [`OrderRefunds`](https://docs.joinforage.app/reference/order-refunds#orderrefund-object). ## Headers - `Authorization` string, required - `Merchant-Account` string, required - `API-Version` string ## Response `200` __OK__ - Success - OrderRefundResponse[] - `payment` string, required — A unique reference hash for the Forage `OrderPayment` to be refunded, returned when the [`OrderPayment` was created](https://docs.joinforage.app/reference/create-order-payment). - `amount` number, required — The amount to be refunded in USD. Does not need to equal the `amount` field of the `OrderPayment`, if a partial refund. Precision is supported to the penny. The minimum amount that can be refunded is `0.01`. - `reason` string, required — A string that describes why the refund is happening. - `metadata` MetadataObject, required — A required object containing merchant-defined key-value pairs to provide additional context for the payment. Merchants should use this field to store **reference information** relevant to the transaction (for example, order details, system identifiers, or tracking data). This helps link the payment to records within their system. Pass an empty object (`{}`) if no additional information is available. > ⚠️ Personally Identifiable Information > > **Do not include personally identifiable information (PII)** such as names, emails, or payment details. - `merchant_fixed_settlement` number — The fixed amount in USD that should be restored to the merchant from EBT Cash payments prior to splitting by the `platform_fee`. Precision is supported to the penny. - `platform_fixed_settlement` number — The fixed amount in USD that should be restored to the platform from EBT Cash payments prior to splitting by the `platform_fee`. Precision is supported to the penny. - `external_order_id` string — A unique identifier for the order as created by the merchant or platform (not Forage). When a merchant or platform passes this order ID to Forage, it persists in each Forage transaction related to the `Order`. This field enables merchants to map order IDs in their system to corresponding Forage `Order` IDs. **You must build with Forage Version `2023-05-15` or later to use `external_order_id`.** Either pass `2023-05-15` as the `API-Version` header on a per request basis, or set the version for all requests in the Forage dashboard. - `ref` string — A unique reference hash for the `OrderRefund`. - `order` string — The unique reference hash for the parent Forage `Order`. - `funding_type` 'benefit' | 'credit_tpp' | 'ebt_snap' | 'ebt_cash' — A string that represents the type of tender. One of: - `benefit` - `credit_tpp` - `ebt_snap` - `ebt_cash` - `status` 'canceled' | 'failed' | 'processing' | 'succeeded' — The status of the `OrderRefund`. One of: - `canceled`: The `OrderRefund` has been voided and can't be changed. - `failed`: The `OrderRefund` failed to process. Check the `receipt.message` field for a description of the error. - `processing`: The outcome of the `OrderRefund` is pending, and the refund can't be modified. _This status is not returned if you’re using Forage version `2024-01-08` or higher._ - `succeeded`: The `OrderRefund` has been successfully processed and will be included in settlement. - `last_processing_error` object, nullable — The `code` and `message` values corresponding to the most recent [Payments API error](https://docs.joinforage.app/reference/errors#payments-api-errors). Always `null` when the `Payment` is created. - `created` string, date-time — A UTC timestamp that indicates when this object was created, represented as an [ISO 8601 date-time](https://www.iso.org/iso-8601-date-and-time-format.html) string. - `updated` string, date-time — A UTC timestamp that indicates when this object was last modified, represented as an [ISO 8601 date-time](https://www.iso.org/iso-8601-date-and-time-format.html) string. - `receipt` ReceiptData — Most of the information that you're required to display to the customer, according to FNS regulations. This field is `null` if the data that populates the receipt is not yet available. The total amount paid by the customer is `snap_amount` + `ebt_cash_amount` + `other_amount`. This amount will be settled with the merchant after applying Forage's fees. - `ref_number` string — A unique reference hash for the Forage `Order`, `Payment`, or `Refund` associated with this receipt. Note: `receipt.ref_number` equals `ref`. - `is_voided` boolean — Whether the transaction associated with this receipt has been voided. If `false`, then the transaction finished processing as expected. If `true`, then the transaction was reversed. - `snap_amount` string — The USD amount charged/refunded to the SNAP balance of the EBT Card, represented as a numeric string. - `ebt_cash_amount` string, currency — The USD amount charged/refunded to the EBT Cash balance of the EBT Card, represented as a numeric string. - `cash_back_amount` string, currency, nullable — The USD amount of cash back given to the customer, represented as a numeric string. - `other_amount` string, currency — The USD amount charged/refunded to any payment method that is not an EBT Card, represented as a numeric string. - `sales_tax_applied` string, currency — The USD amount of taxes charged to the customer’s non-EBT payment instrument, represented as a numeric string. - `balance` BalanceResponse — An object that represents an EBT cardholder's account balance. - `id` integer — The unique identifier for the balance record. - `snap` string, currency — The available SNAP balance in USD on the customer’s EBT Card, represented as a numeric string. - `non_snap` string, currency — The available EBT Cash balance in USD on the customer's EBT Card, represented as a numeric string. - `updated` string, date-time — A UTC timestamp that indicates when the funds in the account last changed, represented as an [ISO 8601 date-time](https://www.iso.org/iso-8601-date-and-time-format.html) string. - `sequence_number` string — A transaction number for this `PaymentMethod`'s most recent balance check. Returned only for POS Terminal transactions; omitted from online merchant balance checks. - `last_4` string — The last four digits of the EBT Card number. - `message` string — A message from the EBT payment network that must be displayed to the EBT cardholder. - `transaction_type` 'Order' | 'Refund' | 'Payment' — A constant string that is used to identify the transaction type associated with the receipt. - `created` string, date-time — A UTC timestamp of when the Forage transaction object was created, represented as an [ISO 8601 date-time](https://www.iso.org/iso-8601-date-and-time-format.html) string. - `sequence_number` string, nullable — The terminal transaction sequence number for POS transactions. `null` for online (non-POS) transactions. - `tpp_lookup_id` string — The unique identifier from the relevant credit TPP or null for EBT refunds. For Stripe integrations, this is the id of the Refund object on Stripe's backend. ## Other responses - `400` — __Bad request__ - The request was not accepted because of an error in the request body or path. - `401` — Unauthorized - `404` — __Not Found__ - The requested resource was not found. - `429` — Too Many Requests - `500` — Internal Server Error --- [API](https://skmtc.dev/joinforage/apis/forage-payments-api.md) · [All operations](https://skmtc.dev/joinforage/apis/forage-payments-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/joinforage/forage-payments-api/revisions/4b7212706fae/schema)