--- title: "Partner Quickstart Guide" slug: "partner-quickstart-guide" updated: 2026-04-03T21:40:48Z published: 2026-04-03T22:00:08Z stale: true --- > ## Documentation Index > Fetch the complete documentation index at: https://resource.payrix.com/llms.txt > Use this file to discover all available pages before exploring further. # Partner Quickstart Guide You can use this implementation guide to understand the steps involved in getting started with your Payrix Pro integration, from learning and testing basic Payrix Pro portal and API functionality in the Sandbox to going live with your integration. 1. [Provide Your Scope of Work](/v1/docs/partner-quickstart-guide#provide-your-scope-of-work) 2. [Sign Up for Sandbox](/v1/docs/partner-quickstart-guide#sign-up-for-sandbox) 3. [Apply Your Branding to the Portal](/v1/docs/partner-quickstart-guide#apply-your-branding-to-the-portal) 4. [Perform Sandbox Testing](/v1/docs/partner-quickstart-guide#perform-sandbox-testing) 5. [Provide Boarding & Processing Requirements](/v1/docs/partner-quickstart-guide#provide-boarding-processing-requirements) 6. [Provide Proof of Risk Requirements](/v1/docs/partner-quickstart-guide#provide-proof-of-risk-requirements) 7. [Provide Partner Live-Testing Instruction](/v1/docs/partner-quickstart-guide#provide-partner-livetesting-instruction) 8. [Create a Production Account](/v1/docs/partner-quickstart-guide#create-a-production-account) 9. [Perform Production Testing](/v1/docs/partner-quickstart-guide#perform-production-testing) 10. [Portal Training](/v1/docs/partner-quickstart-guide#portal-training) In addition to the steps and resources highlighted in this guide, the following API documentation resources are available for reference when using the Payrix Pro API: - [Payrix Pro API Reference](https://test-portal.payrix.com/docs/api) - [Developer Guide](https://portal.payrix.com/docs/index/intro) ## Provide Your Scope of Work Ahead of your implementation kickoff call, you must complete the Scope of Work form provided by the Worldpay for Platforms Sales Team. The Scope of Work will be reviewed with the Payrix Pro project manager during the kickoff call. ## Sign Up for Sandbox After reviewing the Scope of Work during the kickoff call, a Payrix Pro Sandbox account is created to test the Payrix Pro portal and API. The Sandbox testing environment mirrors the experience in the live production space and allows you to test the integrations before enabling merchants on the go-live date. - [Sandbox Signup Form](https://test-portal.payrix.com/signup/ProSandbox) - [Sandbox Portal Login](https://test-portal.payrix.com/login) For more information on Sandbox, see [Get Started with Sandbox Testing](/v1/docs/get-started-with-sandbox-testing). ## Apply Your Branding to the Portal After signing up for the Sandbox environment, the Implementation team will contact you for white-labeling or customized branding parameters and retrieve your colors and logos. For more information on white label requests and logos, see [White Label and Customized Branding](/v1/docs/white-label-and-customized-branding). ## Perform Sandbox Testing After creating a Production Account, you can begin Sandbox testing. To begin testing with the Payrix Pro API or hosted payments, you’ll need to get your API key from the Sandbox Portal. To generate your API key in the portal: 1. Click **Settings** in the left navigation panel. 2. Select **API Keys** from the Business Settings section. 3. Click **Add API Key**. 4. In the Add API Key dialog, provide the following information: - Enter a **Name** for the API key. - Select **Active** from the Status dropdown. - Select **Private** from the Type dropdown. 5. Click **Add** to generate the new API key. ### Testing Cases While performing Sandbox testing, be sure to test the following functions at a minimum: - **Board a Merchant:** See [Merchant Boarding](/v1/docs/merchant-boarding) for details on using the Merchant Signup Form or API. - **Create a Credit Card Sale Transaction:** See [Use Case: Process a Card Payment with Create Payment](/v1/docs/use-case-process-a-card-payment-with-create-payment). - **Create an eCheck Sale Transaction:** See [Use Case: Process an eCheck (ACH) Payment with Create Payment](/v1/docs/use-case-process-an-echeck-ach-payment-with-create-payment). - **Process a Refund Transaction:** See [Use Case: Issue a Transaction Refund](/v1/docs/use-case-issue-a-transaction-refund). - **Tokenize a Payment Method:** See [Use Case: Create a Customer Payment Token](/v1/docs/use-case-create-a-customer-payment-token). - **Create a Sale Transaction with an Existing Token:** See [Use Case: Process a Token Payment with Create Payments](/v1/docs/use-case-process-a-token-payment-with-create-payments). - **Set Up a Merchant Billing Group:**See [Use Case: Set Up Merchant Statement Billing](/v1/docs/use-case-set-up-merchant-statement-billing). - **Create and Verify Merchant Withdrawals:** See [Use Case: Set Up a Scheduled Withdrawal Flow for New Merchant Accounts](/v1/docs/use-case-set-up-a-scheduled-withdrawal-flow-for-new-merchant-accounts). ## Provide Boarding & Processing Requirements After completing Sandbox end-to-end testing, provide your boarding and processing requirements to the Implementation Team. ## Provide Proof of Risk Requirements After providing your boarding and processing requirements, send screenshots and details of your risk requirements. ## Provide Partner Live-Testing Instruction After providing proof of your risk requirements, the Implementations Team engineer will provide live testing instructions. You should complete the Live Testing Instructions form provided before live testing. ## Create a Production Account After submitting your white label request and logos. Next, create a production account from your Sandbox account. ## Perform Production Testing After receiving live-testing instructions, you can perform end-to-end testing in the production environment. ## Portal Training After completing production testing, you can begin portal training.