1. Getting Started
  2. Welcome

Getting Started


The PackageX API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the PackageX API in test/sandbox mode, by creating an account on https://sandbox.packagex.io, which will let you simulate all features of the platform without any real payment information. Test accounts can be found here.

Base URLs

The following are valid base URLs of the different environments that you are targeting:

Environment Endpoint
Production https://api.packagex.io
Sandbox https://sandbox--api.packagex.io