Referrer API Quick Start Guide
- Yehudah Rodman (Unlicensed)
- Miles Graves
- Paul Clifton
A complete guide for implementing the Payrix Pro solution.
Key Terms
Pro Client: A client implementing the Payrix Pro solution to meet their Merchant portfolio’s payment processing needs
Portfolio: The collective of Merchants being integrated to the Payrix Platform by a Pro Client
The Sandbox Testing Environment - Get to Know Payrix
New Payrix Pro Clients can familiarize themselves with the Payrix API & Portal by visiting the Sandbox testing environments which mirrors their experience in our live production space. We suggest using Sandbox to get to know the Payrix Platform & test the integrations you plan to release to your Merchants once you are ready to go live.
Because the Sandbox testing environment mirrors our live production space, you can use the API instructions & syntax included in this guide for testing in the Sandbox API.
You can request access to Sandbox by completing the Pro Client Sandbox SignUp link. The Sandbox Portal can be located by visiting the following URL:
https://test-portal.payrix.com/
The Sandbox API can be reached with the following URL:
API Authentication - Gaining Access to the Payrix API
To successfully reach the Payrix API a request must follow the common syntax of URL, HEADER, and BODY. Pro Clients can authenticate their access to the Payrix API by including a Private API Key within the HEADER of their request:
Location | Syntax |
|---|---|
URL
| [Request Type]https://test-api.payrix.com/[endpoint] |
HEADER
| Content-Type:application/[code language]
APIKEY:{{private_api_key}} |
BODY | Include the code to complete the API request within the BODY. Information about specific requests can be found in the Payrix API Reference. |
Generating a Payrix API Key
A Payrix API Key can easily be generated directly in the Portal by following these easy steps.
The API syntax and process for generating an API Key is identical in the Sandbox and production spaces. Thus, use the information provided above to send test requests to the Sandbox API.
Onboarding a Merchant Via the Payrix API
Onboarding your Merchants to Payrix is the first step to getting your portfolio integrated with the Payrix Platform. In order for a Merchant to be Successfully Boarded to Payrix, you will need to submit information pertaining to the Merchant’s business, the owner, and adding their bank account information for payouts.
Via the API, Merchants can be onboarded to Payrix via sending a POST request to the /entities endpoint, and including the following data in the BODY (example in JSON script):
Location | Syntax |
|---|---|
URL | [POST]https://test-api.payrix.com/entities |
HEADER | |
BODY |
When successfully submitted, you will receive a Payrix Merchant ID in the response to your API onboarding request. You will use this Merchant ID to reference the Merchant you created when performing functions within the Payrix Platform.
Additional Onboarding Resources
Submitting a Payment Via the Payrix API
Once your Merchants are Successfully Boarded to the Payrix Platform, you’ll want to know the process for them to begin submitting payments for processing. Via the API, payments are submitted with a POST request to the /Txns endpoint, and at a minimum must include the Merchant’s Payrix Merchant ID, the payment type & method information, and the payment amount.
When submitting a card payment via the API, the fields indicated in the sample (JSON) code below are the minimum required data in order for the payment to be successfully submitted. You can view additional information in the Payrix API reference.
Location | Syntax |
|---|---|
URL | |
HEADER | |
BODY |