PartnerStack Public API

The PartnerStack vendor REST API offers predictable, resource-oriented URLs to access the core objects of your partner programs.

View the PartnerStack API reference for the most up to date list of supported resources

Authentication

Authenticate vendor requests using Basic Auth.
Simply use your public key as the username and private key as the password.

Responses

All endpoints return a JSON body, even if returning an error.
Our API libraries convert responses to appropriate language-specific objects.

Test and Production Keys

Your PartnerStack account has both Test and Production API keys available in your integration settings.
There is no "toggle" to swap between testing and production modes, simply use the appropriate key to perform a live or test request.

🚧

Test Mode Transactions

You can only add "test" transactions to Test customers. You cannot add test transactions or other test-events to customers created with PRODUCTION credentials.

Creating a test customer can be achieved by using the customer API with your TEST API keys.