Pro Client Launch Quick Start Guide

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 Pro Platform by a Pro Client

The Sandbox Testing Environment: Get to Know Payrix Pro

New Payrix Pro Clients can familiarize themselves with the Payrix Pro API and 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 Pro Platform and 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:

https://test-api.payrix.com

API Authentication: Gaining Access to the Payrix Pro API

To successfully reach the Payrix Pro API a request must follow the common syntax of URL, HEADER, and BODY. Pro Clients can authenticate their access to the Payrix Pro API by including a Private API Key within the HEADER of their request:

[Request Type]https://test-api.payrix.com/[endpoint]

Content-Type:application/[code language]
APIKEY:{{private_api_key}}

Generating a Payrix Pro API Key

A Payrix Pro 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 Using the Payrix Pro API

Onboarding your Merchants to Payrix Pro is the first step to getting your portfolio integrated with the Payrix Pro platform. In order for a Merchant to be Successfully Boarded to Payrix Pro, you will need to submit information pertaining to the Merchant’s business, the owner, and adding their bank account information for payouts.

Using the API, Merchants can be onboarded to Payrix Pro by sending a POST request to the /entities endpoint and including the following data in the BODY (example in JSON script):

[POST]https://test-api.payrix.com/entities

Content-Type:application/json
APIKEY:{{private_api_key}}

{
    "type": 2,
    "name": "Merchant Test",
    "address1": "1234 Rivver Lane",
    "address2": null,
    "city": "Frisco",
    "state": "TX",
    "zip": "75034",
    "country": "USA",
    "phone": "8556729749",
    "fax": null,
    "email": "Entity.Email@gmail.com",
    "ein": "123456789",
    "website": "http://merchantsite.com",
    "tcVersion": "1.0",
    "currency": "USD",
    "accounts": [
        {
            "primary": "1",
            "currency": "USD",
                    "account": {
                        "method": "8",
                        "number": "90720860",
                        "routing": "021000021"
                    }
        }
    ],
    "merchant": {
        "dba": null,
        "new": "1",
        "mcc": "1799",
        "status": "5",
        "members": [
            {
                "title": "CEO",
                "first": "Chad",
                "middle": null,
                "last": "Foster",
                "ssn": null,
                "dob": "19941208",
                "dl": "9331726679",
                "dlstate": "MD",
                "ownership": 10000,
                "email": "Jerrod_Glover@hotmail.com",
                "fax": null,
                "phone": "5106406131",
                "primary": "1",
                "address1": "83 Dan Ways",
                "address2": null,
                "city": "East Bettye",
                "state": "MD",
                "zip": "60064",
                "country": "USA"
            }
        ]
    }
}              

When successfully submitted, you will receive a Payrix Pro 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 Pro platform.

Additional Onboarding Resources

• Merchant Onboarding in the Payrix Pro Resource Center

• Risk and Compliance Underwriting Process

• Alternative Payrix Pro Onboarding Methods

• Required versus Optional Onboarding Fields

Submitting a Payment Using the Payrix Pro API

Once your Merchants are Successfully Boarded to the Payrix Pro 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 Pro Merchant ID, the payment type and 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 Pro API reference.

[POST]https://test-api.payrix.com/txns

Content-Type:application/json
APIKEY:{{private_api_key}}

{
    "merchant": "t1_mer_59efbf4e69b27a4760b885d",
    "type": "1",
    "origin": "2",
    "payment": {
        "number": "4242424242424242",
        "cvv": "123",
        "expiration": "1020"
    },
    "total": "10000"
}

Additional Payment Submission Resources

• Payment Processing in the Payrix Pro Resource Center

• Alternative Payrix Pro Payment Submission Solutions

• eCheck & ACH Processing

• Payment Method Tokenization

Payrix Pro Documentation and Developer Resources

• Payrix Pro Developer Guide

• Payrix Pro API Reference

• Payrix Pro Resource Center