HomeGuidesReference↗ Forage Dashboard
Log In
Reference

View or update Merchant-specific information

post
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 update Third Party API keys.

Body Params

Merchant specific information to be used internally.

string

Merchant instance unique identifier.

string

The display name of the Merchant, e.g. there is a 'Return to ' button that would read 'Return to Farmstead'

string

The USDA assigned number that identifies the merchant for EBT transactions. Always length 7

address
object

⚠️ Exception: If the purchase is made in-store via a POS Terminal, then a delivery_address is not required when creating a Payment.

The address for delivery or pickup of the Order. Per FNS regulations, this value must always be provided. If the Order is for pickup, then use the merchant address.

string

The URL of the merchant's logo, so it can be displayed in HTML img tags

string

The landing page of the merchant, which may be displayed in certain error cases.

third_party_api_keys
object

Two API keys needed to make Stripe transactions on behalf of a merchant.

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