HomeGuidesReference↗ Forage Dashboard
Log In
Reference

Retrieve all PaymentRefunds for a Payment

get
https://{environment}.joinforage.app/api/payments//refunds/

A GET request to /payments/{payment_ref}/refunds/ retrieves a list of all PaymentRefunds associated with a Payment.

To inspect a particular PaymentRefund, use /payments/{payment_ref}/refunds/{refund_ref}/.

Path Params
string
required
Defaults to cc3175bfea

A unique reference hash for the Forage Payment object, returned when the original Payment was created.

Headers
string
required

A unique merchant ID that Forage provides during onboarding, as in 123ab45c67. The Merchant ID can be found in the Forage sandbox or production dashboard.

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

Updated 2 months ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 months ago