Benny React Native SDK

The Benny React Native SDK allows your app to use Benny client libraries.

Note See our complete documentation at docs.bennyapi.com.

Installation

Install the SDK using your preferred package manager.

yarn install @bennyapi/react-native-sdk

EBT Balance Link Flow

The Ebt Balance Link Flow allows users to link their EBT account, verify the account, and returning a tokenized representation of the credentials for fetching balance and transaction information.

Required IDs

You'll need an organizationId, the ID representing your organization, along with a temporarylink that is generated serverside via a call to the Benny API.

Note Reach out to [email protected] to set up your organization.

Integration

The Ebt Balance Link Flow is contained in a simple fullscreen component, EbtBalanceLinkFlow, that is initialized with your organization ID and the single-use temporary link.

Callbacks (i.e., onExit and onLinkResult) are responsible for communicating to your app when the user wants to exit the flow and when a link result is obtained.

<EbtBalanceLinkFlow
  organizationId="org_wup29bz683g8habsxvazvyz1"
  temporaryLink="temp_clr0vujq9000108l66odc7fxv"
  onExit={() => {
    /** Your on exit logic. */
  }}
  onLinkResult={
    /** Your on link result logic. */
  }
  environment={EbtBalanceLinkFlowEnvironment.Sandbox}
/>

Environments

Set the environment to EbtBalanceLinkFlowEnvironment.Sandbox to integrate with the Benny sandbox environment, or omit to default to the production environment.

Handling Browser Navigation

The flow will go back on Android's hardware back press or gesture if there are previous screens.

EBT Transfer

The EBT Transfer product consists of EbtTransferLinkCardFlow, EbtTransferBalanceFlow, and the EbtTransferFlow. Once a user successfully links their EBT card through the EbtTransferLinkCardFlow, a transfer token is created. The transfer token allows for EBT balance checks through the EbtTransferBalanceFlow and EBT cash transfers through the EbtTransferBalanceFlow.

Link Card Flow

The EbtTransferLinkCardFlow is initialized with an organization ID and a single-use temporary link generated serverside via a call to Benny's API.

Callbacks (i.e., onExit and onLinkResult) are responsible for communicating to your app when the user wants to exit the flow and when a link result is obtained. A successful link result returns a transfer token along with its expiration date. A failed link result returns an error message.

<EbtTransferLinkCardFlow
  organizationId="org_wup29bz683g8habsxvazvyz1"
  temporaryLink="temp_clr0vujq9000108l66odc7fxv"
  onExit={() => {
    /** Your on exit logic. */
  }}
  onLinkResult={
    (transferToken?: string, expiration?: string, error?: string) {/** Your on link result logic. */}
  }
  environment={EbtTransferEnvironment.Sandbox}
/>

Balance Flow

The EbtTransferBalanceFlow is initialized with an organization ID and the transfer token obtained earlier.

Callbacks (i.e., onExit and onResult) are responsible for communicating to your app when the user wants to exit the flow and when a result is obtained. A successful result returns the customer's cents-denominated EBT cash balance, while a failed link result returns an error message.

<EbtTransferBalanceFlow
  organizationId="org_wup29bz683g8habsxvazvyz1"
  transferToken="transfer_sf3k3absxvazvjsd3lks"
  onExit={() => {
    /** Your on exit logic. */
  }}
  onResult={
   (balance?: string, error?: string) => {/** Your logic here. */}
  }
  environment={EbtTransferEnvironment.Sandbox}
/>

Transfer Flow

The EbtTransferFlow is initialized with an organization ID, the transfer token obtained earlier, a cents-denominated amount that the customer wishes to transfer, and an idempotency key.

Callbacks (i.e., onExit and onResult) are responsible for communicating to your app when the user wants to exit the flow and when a transfer result is obtained. A successful result invokes the onResult callback with no value, while a failed result returns an error message.

<EbtTransferFlow
  organizationId="org_wup29bz683g8habsxvazvyz1"
  transferToken="transfer_sf3k3absxvazvjsd3lks"
  amount={100}
  idempotencyKey="idempotency"
  onExit={() => {
    /** Your on exit logic. */
  }}
  onResult={
      (error?: string) => {/** Your result logic. */}
  }
  environment={EbtTransferEnvironment.Sandbox}
/>

Environments

Set the environment to EbtTransferEnvironment.Sandbox to integrate with the Benny sandbox environment, or omit to default to the production environment.

Example App

The Expo example app can be run with:

yarn example android

or

yarn example ios

Author

Benny API Inc.

License

The Benny SDK is available under the MIT license.