Overview

This document details how to create a merchant and initiate onboarding to Payrix via the API and Portal.

TERMS:

• Entity: This is a top-level resource of a business that references a merchant, referrer or facilitator.

• Account: This represents the bank account associated with an Entity.

• Merchant: Any business that accepts payments in exchange for goods or services.

• Member: A person associated with a Merchant.

API

Additional information regarding the Boarding process and requirements can be referenced on our Boarding API Documentation Center.

There are multiple ways a merchant can be created based on the endpoint used. For example, to create an Entity, Account, Merchant, and Member in a single request then you would use the /entities endpoint and include the classes for accounts , merchant, and members. This allows you to leverage a single request to create everything you need rather than having to split out multiple requests.

The example below uses the /entities endpoint to create an account in a single request.

Getting Started:

It is important to always reference our swagger documentation available on our API Portal for more information on each method, field, and to view example requests. For a quick break down on each class field, requirements, variable type, length, and an example reference the API Specification Supplement (Entities, Accounts, Merchants, Members).

...