Skip to main content

Integration Sandbox

The sandbox environment is a testing environment that allows you to test your integration before going live. It is a sandboxed environment that is isolated from the production environment.

Getting Started​

To get started, you will need to populate the partner portal to completion and then request access to the sandbox environment using the service desk. Any incomplete fields in the partner portal will prevent you from accessing the sandbox environment and introduce delays in the request.

Partner Portal > Integrations

Service Desk

oAuth Video Requirement for POS and DSP partners​

As part of the sandbox environment request, you will need to provide a video recording of the oAuth flow. This video will be used to verify that the oAuth flow is working correctly and that the integration is working as expected.

The video should be a screen recording of the oAuth flow from the start to the end. It should include the following:

  • The oAuth flow from the start to the end, starting at the Partner Portal > Integrations page by using the "Test" button for the integration.
  • The oAuth flow should include the following:
    • Showing /v1/authorize rendering a web login / authorization flow
    • Showing /v1/token cURL response with valid tokens / expirations

All Partners (including non-whitelabel and Events Partners)​

  • Populate all branding details in the partner portal, regardless of the integration type.
    • Logo
    • Icon
    • Name

POS API​

Populate the POS API integration details in the partner portal with the following information:

  • API URL
  • Client ID
  • Client Secret

Retrieve the webhook secret from the partner portal and store it in your environment variables securely.

DSP API​

Populate the DSP API integration details in the partner portal with the following information:

  • API URL
  • Client ID
  • Client Secret

Retrieve the webhook secret from the partner portal and store it in your environment variables securely.

If you are not a whitelabel DSP partner please use Stripe's test card 4242 to get through the paywall.

https://docs.stripe.com/testing

Events API​

Populate the Events API integration details in the partner portal with the following information:

  • API URL

Events integrators do not go through the OAuth or screen recording flow. The Events API does not provide access to a sandbox environment; instead, developers are encouraged to integrate directly in production using a pilot merchant account.

Integrators are onboarded by the merchant through the Dispatch settings in the UI. All communication is secured using a webhook secret, which is enforced for partner authorization.

For additional details, integrators can refer to this Help Center article

White Label Stream​

Populate all theme details in the partner portal for the white label stream.

  • Primary Color
  • Secondary Color
  • Foreground Color
  • Border Color
  • Background Color