Implementation FAQ

See Use Cases: Fees for resources on setting up different Merchant Fees.

After a Pro Client has signed up for the sandbox environment, the Implementation team will contact them for white-labeling or customized branding parameters and retrieve their colors and logos.

For more information on white label requests and logos, review the White Label and Customized Branding resource.

Sandbox testing is when the implementation group will review your process of boarding a merchant and submitting a transaction. Sandbox is the best place to “play” and learn our system.

Production end-to-end testing is done to see your entire process from start (onboarding a merchant) to finish (running a transaction). This allows our team to verify all system settings are working as expected and we successfully see your API calls (if applicable).

This can be accomplished by creating a token, and reviewing the method parameter value in the response. See the following example:

Example Request

POST /tokens HTTP/1.1 
Accept: application/json 
Content-Type: application/json 
Host: test-api.payrix.com 
APIKEY: {apiKey} 

{
    "customer": {
        "first": "John",
        "last": "Doe",
        "merchant": "t1_mer_123abc4d567890efg1h2i34"
    },
    "payment": {
        "number": "4242424242424242",
        "cvv": "123"
    },
    "expiration": "1234"
}

Example Response

{
    "response": {
        "data": [
            {
                "customer": {
                    "id": "t1_cus_123abc4d567890efg1h2i34",
                    "created": "2025-06-06 15:32:03.6233",
                    "modified": "2025-06-06 15:32:03.6233",
                    "creator": "t1_log_123abc4d567890efg1h2i34",
                    "modifier": "t1_log_123abc4d567890efg1h2i34",
                    "login": "t1_log_123abc4d567890efg1h2i34",
                    "merchant": "t1_mer_123abc4d567890efg1h2i34",
                    "first": "John",
                    "middle": null,
                    "last": "Doe",
                    "company": null,
                    "email": null,
                    "fax": null,
                    "phone": null,
                    "country": null,
                    "zip": null,
                    "state": null,
                    "city": null,
                    "address2": null,
                    "address1": null,
                    "inactive": 0,
                    "frozen": 0,
                    "shippingFirst": null,
                    "shippingMiddle": null,
                    "shippingLast": null,
                    "shippingCompany": null,
                    "shippingAddress1": null,
                    "shippingAddress2": null,
                    "shippingCity": null,
                    "shippingState": null,
                    "shippingZip": null,
                    "shippingCountry": null,
                    "shippingPhone": null,
                    "shippingFax": null,
                    "custom": null,
                    "authTokenCustomer": null,
                    "entity": null
                },
                "payment": {
                    "id": "g123456abc7de8f",
                    "method": 2,
                    "number": "4242",
                    "routing": "0",
                    "bin": "424242",
                    "payment": null,
                    "lastChecked": null,
                    "last4": null,
                    "mask": null,
                    "plaidConsumerAccount": null
                },
                "id": "t1_tok_123abc4d567890efg1h2i34",
                "created": "2025-06-06 15:32:03.648",
                "modified": "2025-06-06 15:32:03.648",
                "creator": "t1_log_123abc4d567890efg1h2i34",
                "modifier": "t1_log_123abc4d567890efg1h2i34",
                "token": "a12bc3d4e56f789g0h1ij23kl456789",
                "expiration": "1234",
                "inactive": 0,
                "frozen": 0,
                "name": null,
                "description": null,
                "custom": null,
                "authTokenCustomer": null,
                "status": "ready",
                "origin": null,
                "entryMode": null,
                "omnitoken": null
            }
        ],
        "details": {
            "requestId": 1
        },
        "errors": []
    }
}

method
The method used to make this payment. See the following valid values:

After you log in, select Reports in the Admin section of the left navigation panel. The Select Report field lists a number of reports that you can select and generate. See Create and Manage Reports for more details.

The integration guides for PayFields and PayFrame can be found here.

PayFrame has limited customization and PayFields is designed to let the customer apply their own look and feel. 

This can be accomplished by using the config field. When sending a transaction using PayFields, you can preset a few config fields prior to the submission of the form. An example of a field wanting to be used when sending a payment is the txns.description field. This field can be preset by sending the description data to PayFields.config.additionalData.description. See PayFields for more information.

In the field configuration section, you will see a list of other fields that can be sent through PayFields.config.

One of the fields is additionalData, and this field has subfields. The following is the list of subfields that can be included with additionalData:

• discount

• shipping

• duty

• description

• tokenDescription

• txnDescription

• tax

Not at this time.

Terminal transactions (terminalTxn) will only show up under the associated terminal (Merchants > Terminals > Terminal Name > Transactions). The next day when the transaction is imported into Payrix Pro, the transaction record will be created and linked to the terminalTxn. The transaction record will then be included in the payment history tab.

The only time you would see a merchant account denied is if the business owner was on Mastercard Alert To Control High-risk Merchants (MATCH) or the information provided could not be verified. For example, Owner, DOB, or SSN. 

MATCH is a database that houses information about businesses (and their owners) whose credit card processing privileges have been terminated for a set of very specific reasons.

You can update merchant account information through the Payrix Pro portal or through an API integration. To update a merchant’s account information:

1. In the Management section of the left navigation panel, select Merchants.

2. Select the merchant whose information you want to update.

3. In the Account Overview section, click the edit icon.

If a merchant account owner changes, you should inactivate the original account and submit a new one for approval.

This can be done either through the API or a webhook. Essentially you would set up an alert anytime a merchant account status changed.

Note

alertTriggers determines which resource and event will trigger a webhook. In the case of a webhook that notifies your server when a new Merchant's boarding status updates to (Successfully) Boarded the API resource is merchant (resource 9) and the event is merchant.boarded.

Decline reasons should be dwindled down that are applicable to your clients (i.e. card present declines are different than card not present declines). A few samples would be AVS miss-match (update address) insufficient funds, do not honor (FSA + HSA cards would have this) pick up card (card marked as fraudulent), invalid card number.

You can submit a REQUEST-TOKEN header with any API request to include unique alphanumeric value that identifies the request as original and idempotent. If the same REQUEST-TOKEN  value is submitted again, your original transaction results will be returned with an additional details value of "duplicateRequest": true. This prevents duplicate charges and allows you to resubmit requests in the event of a system timeout.

The items factoring into the total amount disbursed from the Payrix Pro portal. These entries form the Disbursement Statement which outlines all associated debits and credits of your account. Such examples of entries include revenue from Captures and eCheck Sales, as well fees incurred such as Interchange.

These are items on the transactional level that outline the activity on the Payrix Pro portal. Where Disbursement Entries will show overall disbursement details, Statement Entries are more granular and show per-transaction data.

We currently do not have a setup where our system will automatically calculate the convenience fee, and add it to the total transaction amount. However, a workaround to this is to create the fee in Payrix Pro and set it as a surcharge. What this will do is reverse calculate the fee based on the percentage provided, and only charge the fee on the calculated amount.

For example, a transaction for $100, with a 3% convenience fee added would bring the total to $103.00. In Payrix Pro you would set up a surcharge fee at 3%. We will use this fee to calculate that the original transaction was $100, the 3% will only be charged on the $100, and the end result is that the merchant will receive the $100.

See Set Up a Convenience Fee for more resources on Fees. For further inquiries, your Project Manager can schedule Fee setup demonstrations with an Implementation Engineer to walk you through it.

You can always contact Payrix Pro Partner Services for more specific queries that can be answered by our support specialists.