Welcome to the PartnerStack Integration Docs

Here you can find guides, documentation, support and FAQs to get you setup on PartnerStack.

Chat with us by clicking the message bubble in the bottom right if you are having any trouble!

Get Started

PartnerStack API

Overview

The PartnerStack REST API gives you the most control over your integration, and, like a good API it is, has predictable, resource-oriented URLs.

We currently offer public endpoints allowing you to interact with:

Authentication

Authenticate your requests using basic Auth.
Simply use your public key as the user name 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 Live Production Keys

Your PartnerStack account has both TEST and PRODUCTION API keys available in your integration settings.

There is no "switch" for changing between modes, just use the appropriate key to perform a live or test request.

Test Mode Transactions

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

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

PartnerStack API


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.