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.
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:
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.
For more information on the Scope of Work, see Partner Pre-Implementation.
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.
For more information on Sandbox, see 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.
Perform Sandbox Testing
After creating a Production Account, you can begin Sandbox testing. To begin testing with the Payrix Pro API or Integrated Payment Pages, you’ll need to get your API key from the Sandbox Portal.
To generate your API key in the portal:
Click Settings in the left navigation panel.
Select API Keys from the Business Settings section.
Click Add API Key.
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.
Click Add to generate the new API key.
Result: A new private API key for the Sandbox environment is now available for API testing in the Sandbox.
Testing Cases
While performing Sandbox testing, be sure to test the following functions at a minimum:
Board a Merchant: See 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.
Create an eCheck Sale Transaction: See Use Case: Process an eCheck (ACH) Payment with Create Payment.
Process a Refund Transaction: See Use Case: Issue a Transaction Refund.
Tokenize a Payment Method: See 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.
Set Up a Merchant Billing Group: See 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.
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.