The Partner API is designed for Independent Software Vendors (ISVs), platform providers, and other businesses that need to manage multiple merchants through a single integration. It is ideal for partners who want to onboard new merchants, manage merchant accounts, and streamline payment operations across their network.
Important Considerations
It is important to note that partner developers must use the Partner API and the Merchant API to perform various tasks. The Partner API is used primarily for registration and enrollment, while the Merchant API is used for most other functions, such as managing transactions, customer data, and invoices.
To effectively manage merchant data, it is recommended that partner developers save every merchant and the corresponding Merchant API key in their database. This ensures they can easily access each merchant's information. Alternatively, developers can programmatically reference the Merchant API keys using the List API Keys for Merchant endpoint.
Be aware that if the API key for a given merchant (MID) changes, it must be updated manually in the partner's database. This distinction is critical to maintaining seamless integration, especially for larger partners building an enrollment flow.
Requesting a Partner API Key
Partners must request an API key to gain access. Once your request is processed, you'll receive an email with instructions for accessing your API key.
Accessing Your Partner API Key
Log into Stax Pay
In the top left corner toggle into a new account I created named Partner Production API Key - {partner name}
Go to APPS >API Keys app > Launch the app.
On the API Keys page, you will see the production partner API key named production-partner-api-key-partnername.