Versions Compared

Old Version 19

changes.mady.by.user Miles Graves

Saved on

compared with

New Version Current

changes.mady.by.user Miles Graves

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

A complete guide for implementing the Payrix Pro solution.

Table of Contents

...

Key Terms

Info

  • 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.

...

https://test-api.payrix.com

...

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

  • API URL

  • API endpoint

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

HEADER

  • Content-Type (code language)

  • APIKey

Code Block
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.

Info

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 Boardedto Payrix, you will need to submit information pertaining to the Merchant’s business, the owner, and adding their bank account information for payouts.

...

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 Boardedto 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.

...

Location

Syntax

URL

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

HEADER

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

BODY

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

Additional Payment Submission Resources

...

Payrix Documentation & Developer Resources