Test your onboarding integration

Once your integration is complete, you should test it in order to make sure you cover all the use cases, including making the required API calls, load the onboarding UI and listening to webhooks.

Please follow the guide below to test each use case using the UNIPaaS sandbox environment.

Before you begin

Make sure you are using your UNIPaaS sandbox private key for API calls. These can be found in the UNIPaaS portal.

Test scenarios

The following instructions will help you test all possible onboarding scenarios, and are relevant to both registered companies and individuals/sole trades.

Action required (additional_information)

The Action required (additional_information) status, means that there is an action that the vendor needs to take in order to complete the onboarding process. In this case, the action is ‘additional information’, which means that the vendor is asked to provide additional information or re-submit some of the information he already provided.

Follow the steps below to simulate this status:

  1. Create a new vendor via API or the UNIPaaS portal with the following First Name (firstName) suffix: the TESTadditionalinfo
    • Example: First Name: Alex TESTadditionalinfo
  2. Complete the vendor creation and onboarding flows by submitting any information via API or the UNIPaas UI (using the onboarding link).
    • If done correctly, the vendor status should be ‘Restricted’
  3. Accept a payment of 1GBP as the vendor, by creating (and paying) a checkout via API or the UNIPaaS portal.
    • If done correctly, the vendor status should briefly change to ‘In review’, followed by ‘Action Required’
  4. Once step 3 is complete, the UNIPaaS system will simulate a review process and it’s result will require the vendor to re-submit the vendor’s phone number. The vendor’s onboarding status will change to ‘Action required (additional_information)’

Action required (Payments_limit_reached)

The Action required (Payments_limit_reached) status, means that a vendor has reached the maximum aggregate amount of payments he was allowed to accept, before completing the full onboarding flow.

Follow the steps below to simulate this status:

  1. Create a new vendor via API or the UNIPaaS portal with any information
  2. Complete the first step of the onboarding process via API or UNIPaaS UI (submit all fields up to, and including, the Merchant service agreement signature)
    • If done correctly, the vendor should have an ‘Accept Payments’ status.
  3. Accept a payment, as the vendor, of 1,500 GBP or 2,500 GBP for individuals/sole traders or Registered companies respectively, by creating (and paying) a checkout via API or the UNIPaaS portal.
    • If done correctly, the vendor should reach the payment acceptance limit and have an ‘Action Required (Payments_limit_reached)’ status.

Action required (Activation_deadline_reached)

The Action required (activation_deadline_reached) status, means that 30 days have passed since the vendor received his first payment, while not completing the full onboarding flow.

Follow the steps below to simulate this status:

  1. Create a new vendor via API or the UNIPaaS portal with the following First Name (firstName) suffix:
  • TESTtimelimitreach*
    • Example: First Name: Alex TESTtimelimitreach
  1. Complete the first step of the onboarding process via API or UNIPaaS UI (submit all fields up to, and including, the Merchant service agreement signature)
    - If done correctly, the vendor should have an ‘Accept Payments’ status.
    - If done correctly, the vendor status should change ‘Action Required’
    Once step 2 is complete, the UNIPaaS system will simulate a situation in which 30 days have passed since the vendor accepted his first payment, while not completing the full onboarding process.

Accept payments

The ‘Accept payments’ status means that the vendor can accept payment up to a limited amount, and cannot receive payouts until the onboarding flow is completed.

Follow the steps below to simulate this status:

  1. Create a new vendor via API or the UNIPaaS portal with any information
  2. Complete the first step of the onboarding process via API or UNIPaaS UI (submit all fields up to, and including, 3. the Merchant service agreement signature)
    • If done correctly, the vendor should have an ‘Accept Payments’ status.

Restricted

The ‘Restricted’ status means that the vendor has completed the onboarding flow, but has not started to accept any payments. Once the vendor accepts his first payments he will be reviewed by UNIPaaS.

Follow the steps below to simulate this status:

  1. Create a new vendor via API or the UNIPaaS portal with any information
  2. Complete the vendor creation and onboarding flow by submitting any information via API or the UNIPaas UI (onboarding link).
    • If done correctly, vendor should have a ‘Restricted’ status

In Review

The ‘In Review’ status means that the vendor has both completed the onboarding flow and accepted his first payment, and his information is now being reviewed by UNIPaaS.

Follow the steps below to simulate this status:

  1. Create a new vendor via API or the UNIPaaS portal with any information
  2. Complete the vendor creation and onboarding flow by submitting any information via API or the UNIPaas UI (onboarding link).
    • If done correctly, vendor should have a ‘Restricted’ status
  3. Accept a payment of 1GBP as the vendor, by creating (and paying) a checkout via API or the UNIPaaS portal.
    • If done correctly, the vendor should have an ‘In Review’ status.

Competed

The ‘Completed’ status means that the vendor has completed the full onboarding process and was fully approved by UNIPaaS.

Follow the steps below to simulate this status:

  1. Create a new vendor via API or the UNIPaaS portal with the following First Name (firstName) suffix: TESTcomplete
    • Example: First Name: Alex TESTcomplete
  2. Complete the vendor creation and onboarding flow by submitting any information via API or the UNIPaas UI (onboarding link).
    • If done correctly, vendor should have a ‘Restricted’ status
  3. Accept a payment of 1GBP as the vendor, by creating (and paying) a checkout via API or the UNIPaaS portal.
    • If done correctly, the vendor status should briefly change to ‘In review’, followed by ‘Completed’
  4. Once step 3 is complete, the UNIPaaS system will simulate a situation in which the vendor was reviewed and fully approved by UNIPaaS.

Rejected

The ‘Rejected’ status means that the vendor did not pass the UNIPaaS review and was rejected. This vendor cannot use the UNIPaaS system.

Follow the steps below to simulate this status:

  1. Create a new vendor via API or the UNIPaaS portal with the following First Name (firstName) suffix: TESTreject
    • Example: First Name: Alex TESTreject
  2. Complete the vendor creation and onboarding flow by submitting any information via API or the UNIPaas UI (onboarding link).
    • If done correctly, vendor should have a ‘Restricted’ status
  3. Accept a payment of 1GBP as the vendor, by creating (and paying) a checkout via API or the UNIPaaS portal.
    • If done correctly, the vendor status should briefly change to ‘In review’, followed by ‘Rejected’
  4. Once step 3 is complete, the UNIPaaS system will simulate a situation in which the vendor was reviewed and rejected by UNIPaaS.