An entrypoint is an alias used to identify an organization or paypoint. When you make a call via the API or with embedded components, the entrypoint value indicates which paypoint account to use for a payment, subscription, or storing a payment method.

Sometimes the terms “paypoint” and “entrypoint” are used seemingly interchangeably. A paypoint is a merchant. An entrypoint is an alias used to identify an organization or a paypoint. Sometimes the entrypoint is referred to as entry or entryname in the APIs and as Entry Name in PartnerHub and PayHub.

​
Find an entrypoint with the API

You can get the list of active paypoints for your organization by making a request to the List Paypoints endpoint. You need the entry ID for the parent organization to make the request. Payabli gives you this ID in your onboarding documents.

A paypoint’s entrypoint is returned as EntryName in the response. This is the value you need to make any API calls that deal with that paypoint.

...
     "EntryPoints": [
        {
          "IdEntry": 100,
          "EntryName": "8cfec329267",
    ...
        }
     ]

​
Find an entrypoint name in PartnerHub

You can get entrypoint names from the UI in PartnerHub. Just navigate to Portfolio > Paypoints, and copy the value in the Entry Name column for the paypoint you want to work with.

Was this page helpful?

EnvironmentsAPI Responses