HomeGuidesReference↗ Forage Dashboard
Log In
Reference

Retrieve a PaymentRefund for a Payment

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

A GET request to /payments/{payment_ref}/refunds/{refund_ref}/ retrieves a PaymentRefund associated with a Payment.

Use this endpoint to retrieve updated receipt and balance information for a PaymentRefund after the initial POST request creates the refund.

Path Params
string
required
Defaults to b873fe62dc

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

string
required
Defaults to 45e3f12a90

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

Headers
string
required

An OAuth 2.0 bearer token that validates the request. You can use either a short-lived session token if the request is coming from the front-end, or an authentication token for server-side requests. Pass the token in this header after the word Bearer and a whitespace, for example Bearer <api_key>.

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 4 months ago

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

Updated 4 months ago