Quickstart Guide to Onboarding

Let's get you started quickly by going through the basic steps of setting up your first merchant and processing your first payment.
In order to take a payment you'll need to first take the following steps:

In order to take a payment you'll need to first take the following steps:

Create a merchant account
Create a user for that merchant who will then log in and complete the merchant application
Activate the merchant

Once the merchant has been set to Active you can then take a payment.

This guide contains code examples which you can copy, adding your own data where required.

Creating a merchant

Use the following example, adding your merchant's details

@auth = <ISV Admin API key>
@isvId = <ISV ID>
@merchantName = <legal name>

POST https://api.test.pay360evolve.com/demo/pf-api-gateway/apiGateway/merchant/merchants?createApplication=true
API_KEY: {{auth}}
Content-Type: application/json

{
  "isvId": "{{isvId}}",
  "type": "GENERIC",
  "organizationDetails": {
    "legalName": "{{merchantName}}"
    }
}

This example has the parameter createApplication=true, which will create the application at the same time as creating the merchant. If you don't include this parameter, or set it to false then you will also need to send a create application request once the merchant has been created.

Once the merchant account has been created you can track the application progress. If you know the merchant's ID, you can use GET Merchant to check the specific merchant otherwise, use GET Merchants to get a list of all your merchants.

GET Merchant:

@auth = <ISV Admin API key>
@merchantId = <merchant Id>

GET https://api.test.pay360evolve.com/demo/pf-api-gateway/apiGateway/merchant/merchants/{{merchantId}}
API_KEY: {{auth}}
Content-Type: application/json

GET Merchants

@auth = <ISV Admin API key>

GET https://api.test.pay360evolve.com/demo/pf-api-gateway/apiGateway/merchant/merchants
API_KEY: {{auth}}
Content-Type: application/json

Creating a user

The first user you create for a merchant should be the person who will complete the application for the merchant.

Emails in the system have to be unique. If you want to re-use an email you will need to delete the user first. It's easier to use an email generation service to create new emails when testing the system.

@auth = <ISV Admin API key>

@email = <unique email address>
@name = <User's name>
@isvId = <ISV ID>
@merchantId = <merchant ID>

POST https://api.test.pay360evolve.com/demo/pf-api-gateway/apiGateway/user-account/user-account/userAccounts?invitation=true
API_KEY: {{auth}}
Content-Type: application/json

{
  "email": "{{email}}",
  "authorities": [
    {
      "scope": "{{isvId}}/{{merchantId}}",
      "roles": ["MERCHANT_ADMIN_PARTNER_INVITE"]
    }
  ],
  "name":"{{name}}",
  "idp":"Pay360"
}

The example here has the parameter invitation=true, which will send an invitation to the email address used in the request. This invitation email will have a link to the merchant portal for them to set their password and log in. If you set the parameter to false, you will be responsible for authenticating the user and logging them into the merchant portal. You will also need to change the user roles and idp values, see Managed user account creation and login guide for more details.

Completing the application

One the user has activated their account and logged into the merchant portal they will be invited to fill in the details of the application which requires details of their business, key individuals, bank account, etc. Once the application has been submitted the system will do a number of back office checks. The user may be asked to provide documentation at this point. You can check the status of the application by sending a GET Application Status request.

@auth = <ISV Admin API key>

@merchantId = <merchant ID>

GET https://api.test.pay360evolve.com/demo/pf-api-gateway/apiGateway/merchant/merchants/{{merchantId}}/applications
API_KEY: {{auth}}
Content-Type: application/json

Assuming the application passes all the checks the merchant will be set to ACTIVE. You will now be able to create payments.

Creating a payment

Now that your merchant is active, you can start taking payments.There are now three integration methods for creating a payment. For more information on these methods, see the following sections.