Show the Orchard investment flow with your own branding

Custom branding lets partners show the Orchard investment flow under their own name and color. It uses the same CDN script as the CDN Script method, plus a branding option. The example below uses a partner called Crowdital.

Load the SDK

<script src="https://sdk.orchard.africa/orchard.js"></script>

Add a button

<button id="invest">Invest</button>

Create a branded instance and open the flow

index.html

<script>
  const crowdital = new Crowdital({
    publicKey: 'pk_live_xxxxxxxxx',
    apiUrl: 'https://core.orchard.africa/api/v1/embed',
    sessionToken: 'your-session-token',
    apiKey: 'your-api-key',
    branding: {
      primaryColor: '#0f2638',
    },
  })

  document
    .getElementById('invest')
    .addEventListener('click', () => {
      crowdital.open({
        onSuccess: function (investment) {
          console.log('Investment successful', investment)
        },
        onClose: function () {
          console.log('Crowdital closed')
        },
        onError: function (error) {
          console.error('Investment failed', error)
        },
      })
    })
</script>

Replaceyour-session-token with a token from POST {apiUrl}/session. See Authentication.

Configuration

string

required

Your Orchard public key, starting with pk_.

string

required

The Orchard API URL.

string

required

A session token for the current user.

string

required

Your Orchard API key.

object

Brand settings applied to the flow.

Show properties

string

Brand name shown in the flow.

string

Primary brand color as a hex value, for example #0f2638.

Callbacks

Callback	When it runs
`onSuccess(investment)`	The user completes an investment.
`onClose()`	The user closes the flow.
`onError(error)`	The investment fails.

⌘I

Get Started

Integration

Show the Orchard investment flow with your own branding

Configuration

Callbacks

​Configuration

​Callbacks

Configuration

Callbacks