Forage(ForageConfig)
Forage(ForageConfig) creates a Forage instance. A Forage instance interacts with the Forage server. You need a Forage instance before you can create an EBT Element and perform EBT checkout operations.
The constructor requires a ForageConfig object as its only parameter.
ForageConfig fields
| Field | Type | Description |
|---|---|---|
merchantIdrequired | string | A unique Merchant ID that Forage provides during onboarding. For example, 123ab45c67. The Merchant ID can be found in the Forage Sandbox or Production Dashboard. |
sessionTokenrequired | string | The session token that your backend generates to authenticate your app against the Forage Payments API. The token expires after 15 minutes. |
customerIdrequired | string | A unique ID for the end customer making the payment. If you use your internal customer ID, then we recommend that you hash the value before sending it on the payload. |
appearance? | object | A set of global styles that is applied to every EBT Element. Supported values include:* variables (parent key):- borderRadius- boxShadow- colorBackground- colorPlaceholderText- colorText- fontFamily- fontLineHeight- fontSizeBase- fontWeightNormal- padding |
Example: Create a Forage instance
const forage = Forage({
merchantId: '123ab45c67',
sessionToken:
'sandbox_eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhIjo0MiwiZXhwIjoxNjc2OTg2ODM1fQ.7KLvDpM9WHRD4pKCYr0rOy2kM0hVf3bwtZEAOZJrJ1w',
// NOTE: The following line is for testing purposes only and should not be used in production.
// Please replace this line with a real hashed customer ID value.
customerId: btoa(Math.random().toString()),
appearance: {
variables: {
borderRadius: '8px'
}
}
})
