7. Getting Started in Sandbox

Before you can start playing with our PayTo APIs, you'll need to ensure that the following setup steps have been completed:

Step 1 - Register for a Zepto Sandbox test account here
Step 2 - Ask your onboarding contact at Zepto to enable PayTo on your new Sandbox account
Step 3 - Setup your Sandbox OAuth application
Step 4 - Setup your Personal Access Token
Step 5 - Setup Webhooks
Step 6 - Play

These steps are explained in more detail below, but please feel free to reach out to your onboarding buddy if you have any questions about getting started.

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:

Create Sandbox Account

Step 2 - Ask your onboarding contact at Zepto to enable PayTo on your new Sandbox account

To enable the PayTo APIs on your account, we just need to know your test account details. After your Sandbox account has been set up, let your onboarding buddy know via email or phone the following info:

Your Legal Entity or Business Name; and
Account nickname

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 and create an OAuth2 profile for your application:

Once you're logged into your Zepto account, click on your name at the top left of the interface
In the drop-down menu displayed click on ‘Your applications’
Click on the green ‘+ New application’ button
Fill in the necessary fields
- When defining the available scope of your application, ensure you have the following PayTo specific actions configured:
  - pay_to_agreements
  - pay_to_aliases
  - pay_to_amendments
  - pay_to_amendment_recalls
  - pay_to_cancellations
  - pay_to_payments
  - pay_to_reactivations
  - pay_to_suspensions
- You can copy and paste everything from the Scopes box to ensure that your application has full access to our API.
Select the green ‘Submit’ button when complete

Additional OAuth grant guides can be found in the general API documentation below:

OAuth Grant Flow

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

Click ‘Your applications’ from your account profile dropdown
Select the application created in Step 3
Click ‘+Personal Access Token’
Enter a relevant title (eg. “Zepto Sandbox Access Token”)
Copy the personal access token into a secure document
- NOTE: The access token will be masked once the pop-up modal is closed

Step 5 - Setup Webhooks

Due to the asynchronous nature of our PayTo API, you'll need a way to stay up to date with any updates to your Agreements and Payments. The primary method for staying up to date is by subscribing to our Webhook notifications, but polling is also supported.

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

Configure a Webhook URL

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

Step 6 - Play

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

NOTE:

Just remember to use the following URL to resolve each endpoint: https://api.sandbox.zeptopayments.com
Use the Bearer Token auth type with your newly created Personal Access Token

Learn more about Zepto's sandbox simulations.