API Reference
Start typing to search…

Getting Started

Get started automating your payments today with our Sandbox API.

Getting Started with the Sandbox Environment

Try out our product in our sandbox environment, and make your first payment, by following these steps.

Step 1: Create a Sandbox Account

First, create a sandbox account on this link https://sandbox.complypay.com/try. The information doesn't have to be real, but the email should be correct for you to receive the setup emails.

Step 2: Create password

Open your email and use the link you have received to create your password.

Step 3: Download the ComplyPay Authenticator App

Once you've created your password, you need to download the ZTLment Authenticator App.

Configure the app to sandbox mode:

  1. Open the app.
  2. Press the “settings” button.
  3. Select “Sandbox” and "Email".

Now you can log in with your email and password. The app will guide you through the final account setup and generate a secure private key that you will use to sign your payments.

Step 4: Log in to Dashboard

Your account is now fully setup 🎉

To get started with the product without coding, you can log in the the Dashboard on https://sandbox.complypay.com/. To get started with the API you can skip to step 6.

You will have 2 accounts by default: a split and a treasury, both with 10,000.- that you can use to try out the payment flow.

Step 5: Create Your First Payment via Dashboard

To make your first payment in the Dashboard, follow these steps:

  1. 🙋‍♀️ Create Vendor Accounts

    • Every payment needs a recipient, so your first step is creating a vendor account. Go to 'Vendors' in the left sidebar of the Dashboard, then click 'Create Vendor' and enter the recipient’s information.

  2. 💰 Create Payment Objects

    • Go to the home screen and press on the split account. Here you can press 'create payment'. Create a payment to your new vendor.

  3. ✅ Approve Payment Objects in your Dashboard

    • Once you have created a Payment Object, it must be approved via the dashboard. If you do not want four eyes approval, we can turn this off for you. You approve the payment by pressing the green tick box in the right side of the payment. In production, this could be done by someone in your finance department.

  4. 📲 Sign Payment Objects in ComplyPay Authenticator App

    • The final step is to sign the Payment Object with the private key of your wallet, which is securely stored in the ComplyPay Authenticator app on the user’s phone. To sign, log in to the app and swipe. This action completes the payment process.

By following these steps, you'll be able to successfully navigate our sandbox environment and make your first payment via the Dashboard.

Step 6: Create Your First Payment with the Sandbox API

To make your first payment via API, follow these steps:

  1. 🔐 Grab a JWT token

    • Once your sandbox account is set up, you can use your credentials to authenticate to our API as detailed in the Authentication section. You use your credentials to Retrieve JWT token which is used to authorise HTTPS requests.
    • Important: It is important to keep your credentials secret, as they can be used to create payments on your behalf. Do not commit the credentials to any code repository, but store them somewhere safe.

  2. 🙋‍♀️ Create Vendor Accounts

    • Create a ‘Vendor Account’ which contains the information of the payee.

  3. 💰 Create Payment Objects

    • Create a Payment Object where the payer is either the string "SPLIT", "TREASURY" or the id of your treasury payment wallet / split wallet (for more details about the different wallets see here). The payee should be the id of the newly created Vendor Account.

  4. ✅ Approve Payment Objects in your Dashboard

    • Once you have created a Payment Object, it must be approved via the dashboard. In production, this could be done by someone in your finance department. If you do not want four eyes approval, we can turn this off for you.

  5. 📲 Sign Payment Objects in ComplyPay Authenticator App

    • The final step is to sign the Payment Object with the private key of your wallet, which is securely stored in the ComplyPay Authenticator app on the user’s phone.
    • When a new Payment Object has been approved, the app will receive a notification to sign it. To sign, log in to the app and swipe. This action completes the payment process.

By following these steps, you'll be able to successfully navigate our sandbox environment and make your first payment via API. For further details on each step, refer to the linked sections in the documentation.