HomeGuidesReferenceChangelog↗ 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

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

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 months ago

Did this page help you?