HomeGuidesReference↗ Forage Dashboard
Log In
Reference

Get a merchant's details

get
https://{environment}.joinforage.app/api/merchants/

Note that Merchant objects are identified by the Merchant-Account header and not in the path, as with other endpoints.

Primarily, this endpoint is used to pass merchant details from Forage's internal backend to our frontend, e.g. the Merchant display name, logo, and API keys for credit/debit processing.

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

500

Server Errors Something went wrong on Forage's servers. Try again.

Updated 6 months ago

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

Updated 6 months ago