Getting Started in Sandbox

This document will guide you through the steps to setup your Sandbox account.

Step 1 - Register a Zepto Sandbox test account

Visit the following link to get yourself a Zepto Sandbox account. The Sandbox environment is completely self-contained so you can't do any damage:

Step 2 - Create a new Service User Account

👍

A Service User Account is a non-human, shared user account created specifically for API interactions. They are functionally equivalent to a regular user account, but can be shared or transferred within your organisation as appropriate.

When configuring API access, we highly recommend using a service user account. This can avoid potential service disruption when a (human) user who configured API access is removed from your account (since their API tokens are also removed).

Once you have logged in to your account,

1. Go to Settings > Team
2. Click on Invite by email to add a new user.
3. Add your Service User details and click on Update.

4. Go to your inbox and follow the prompts to complete the user setup.

📘

Ask your onboarding contact at Zepto to enable relevant services on your new Sandbox account

Once we've activated your sandbox test account, you should be able to move on to the next step.

Step 3 - Setup your Sandbox OAuth application

Once your account is confirmed as up and running, sign in with your Service User and create an OAuth2 profile for your application:

1. Once you're logged into your Zepto account, click on your name at the top left of the interface
2. In the drop-down menu displayed click on ‘Your applications’
3. Click on the green ‘+ New application’ button
4. Fill in the necessary fields
5. Scopes : Enter the scopes as required or you can simply copy and paste everything from the Scopes box to ensure that your application has full access to our API.

public agreements bank_accounts bank_connections contacts open_agreements pay_to_agreements pay_to_amendment_recalls pay_to_amendments pay_to_cancellations pay_to_payments pay_to_reactivations pay_to_refunds pay_to_suspensions pay_to_aliases payment_requests payments refunds transactions transfers webhooks offline_access clients cop_account_validations

6. Click on ‘Submit’ button when complete.

📘

Click here for additional OAuth guides.

Step 4 - Setup a Personal Access Token

Your personal access token can be generated from your Zepto User Interface. Personal access tokens don't expire but can be deleted and replaced anytime.

Follow these steps to create your personal access token

1. Click ‘Your applications’ from your account profile dropdown
2. Select the application created in Step 3
3. Click ‘+Personal Access Token’
4. Enter a relevant title (eg. “Zepto Sandbox Access Token”)
5. Copy the personal access token into a secure document

• NOTE: The access token will be masked once the pop-up modal is closed

6. The token can now be used as a Bearer Token in your API

Step 5 - Setup Webhooks

Webhooks are used to notify your application of changes to the status of Agreements, Payment Requests, Credits and Debits, PayTo transactions, etc as they are processed through the system.

By subscribing to our webhook events you can monitor the status of each transaction, and then trigger the appropriate next steps.

If you choose to use webhooks you will first need to configure them in your Zepto Account Settings page.

Configure a Webhook URL

1. Once you're logged into your Zepto account, click on your name at the top left of the interface
2. In the drop-down menu displayed click on ‘Webhooks’
3. Click on the green ‘+ Webhook’ button
4. Add the URL to be called and select the relevant events depending on your need.
5. Click ‘Add webhook’

ℹ️

Learn more about Zepto Webhooks here.

Step 6 - Start throwing some sand

You should now have access to our APIs via the tool of your choice!

👍

🧪 Happy Testing !!