Entities Overview for Developers

Payabli’s hierarchical structure enables partners to manage unlimited suborganizations and paypoints. Below are descriptions of different entities supported within Payabli’s Platform Architecture:

​

Entity types

Organization: Payabli was created for organizations like software companies to manage their payments business. Organizations are able to create unlimited parent-child relationships of suborganizations and Paypoints. Organizations can white label Payabli’s web app, called either PartnerHub or PayHub depending on the use, for some or all payment solutions. Organizations are sometimes referred to as “partners” in Payabli.

Suborganization: Suborganizations are created by organizations to group and manage paypoints. For example, if you have franchise groups, value added resellers, or trade association partners, you can create suborganizations empower those groups to manage their own paypoint portfolios.

Paypoint: Paypoints are the organization’s customers, that are using your product to receive and send payments. These are also referred to as merchants.

Customer: Customers are the businesses or individuals that make payments (pay in transactions) to the paypoint via the organization’s product.

Vendor: Vendors are the inverse of customers. They’re businesses or individuals that receive payments (pay out transactions) from the paypoint.

​

Entity status codes

When working with entities via the API, you can control and monitor entity statuses with their status fields.

​

Paypoint status

In paypoint endpoints and endpoints that return paypoint data, the status field is PaypointStatus.

​

Customer status

In customer endpoints and endpoints that return customer data, the customer status field is customerStatus.

​

Vendor status

In vendor endpoints and endpoints that return vendor data, the vendor status field is VendorStatus.