Getting Started in Sandbox for Partners

Created by Richard Moore, Modified on Fri, 07 Jul 2023 at 12:40 PM by Richard Moore

Receiving your credentials


Once onboarded to the Sandbox, you will receive an email similar to the one below:


Accepting the invitation will bring the user to the ExactPay Sandbox log-in screen where the user's credentials will be set:


Authentication


To get started with integrating Exact's APIs, the user will first need to authenticate. It is important to note that Exact's API accepts two token types for authentication: User tokens and Application tokens.


Creating a User Token

After settings your user password you will create a user token to authenticate with the API. Below are the default fields:

{
  "email": "[email protected]",
  "password": "yourPassword",
  "application": "admin-pwa",
  "mode": "live"
}


Upon creation you will receive a user token that expires after one-hour. The token response reflects the permissions and account access of the user that created it. It appears as follows:

    "isAuthenticated": true,
    "mode": "live",
    "token": "885b6b91add1c1a03ce036e8ceb24093d49999b55a5e0e41e4c9f7351fa3d038fa9b811c2a8ae7v2",
    "type": "user",
    "user": "627ec613dfb95f34e3658ve4",
    "application": "admin-pwa",
    "account": "57f424bb7e534ff71f6e5600",
    "accountType": "organization",
    "allowedPermissions": [
        "account-invites.read",
        "accounts.read",
        "organizations.read",
        "reports.read",
        "roles.read",
        "users.read"
    "allowedAccounts": [
        "57f424bb7e534ff71f6e5600"
    ],
    "apiVersion": "1.0.0",
    "expiresAt": "2023-06-01T22:59:23.030Z"


[Optional] Creating an Application

Exact provides an application named "admin-pwa" for all its customers. That can be used to create an Application Token that does not expire. Partners or merchants who prefer create their own Application have the ability to do so. For more information on creating an Application, please click here.



Creating an Application Token


An application token can be created with a subset of permissions of the user who creates it. For instance, an Application Token could be created solely for Payments, or Onboarding functionality, rather than having all permissions that a user would have. This allows for greater application security.


Similar to the User Token, creating an Application Token provides an ID, a token, and a list of allowedPermissions, and allowedAccounts:


    "id": "645bf7e44bab8c7c1862d613",
    "label": "Allows Richards Test Application to do everything",
    "type": "application",
    "token": "6b2a8g0a88d98c4f543112af6f9d7d88b8ebbae576b8c108622395d048e95fcedabd5b356820184",
    "allowedPermissions": [
       "charges.create",
       "charges.read"
    "allowedAccounts": [
        "62abab4bf85edc2248577ef1"


Onboarding Merchants


There are two avenues to onboard sub-merchants: using Exact's hosted onboarding application, or integrating with the Create Onboarding and related APIs. Until this is completed it will not be possible to process a Payment.


Facilitating Payments for Merchants


Exact offers ExactJS embedded payments fields, and payments APIs to facilitate payments for merchants. To learn more about how to integrate payments use the links below:


Reporting


Once a merchant has been onboarded, Partners can begin viewing account level reports. Once payments have been processed additional settlement and funding reports are available. Reports can be generated both in the PayFac Dashboard and via the APIs. Reports can be downloaded as CSV and JSON files to be viewed externally.


Once started...


This is a brief outline of the core functionality of the PayFac platform, this along with Exact's additional guides, will allow a software partner to navigate, and integrate the Payfac service with its platform. Further information is available in our customer portal at knowledge.exactpay.com.





Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article