Sign up for Forage

To start using the Forage API, you need a Forage account and API credentials.

📘

Account creation

Forage creates your account when you're ready to start building. If you'd like to open an account and aren't already in touch with the team, send us a message through our contact form.

Your first Forage account is a sandbox account. When you're ready for production, the team provides you with a new set of production credentials.

Create a Forage account

After you contact Forage to create an account, the team responds requesting the following information:

• Merchant name
• For each person who needs dashboard access (one business and one engineering contact recommended):
  • Name and email address
  • Role: individual merchant, platform manager, developer, or finance manager
• 2FA method: SMS (include phone number with country code) or a TOTP authenticator app like Authy or Duo

Once you share this information by email, allow up to 24 hours for the team to reach out and schedule an onboarding call.

Update Forage Checkout Settings

📘

Checkout Settings scope

The Checkout Settings in the Forage dashboard determine the merchant name and logo displayed in the Forage Checkout interface. Only Fully Hosted and Custom integrations use the Forage Checkout UI, so Checkout Settings have no impact if you're building with a Forage SDK.

To update your Checkout settings:

1. From the left navigation menu, click Checkout Settings.
2. Under Merchants, select your merchant name.
3. Click MERCHANT DETAILS in the right callout box.
4. Select Update to change your merchant display name or logo.
5. When you're done with changes, click Save.

Your merchant display name and logo are now configured for the Forage Checkout interface.

📘

Logo requirements

Use PNG or SVG file types for the logo image. Logos should have a height of 180px, but the width can vary up to a maximum of 360px.

Next steps

• Register an app to get the Client ID and Client Secret you need to generate API tokens.