Overview

Introduction

If you have the need to segregate business lines or are a channel partner who wishes to be autonomous in on boarding their customers onto the Ordo Platform, then you can use Ordo's Financial Institution (FI) APIs to add as many Participants to your open banking capability as you need.

Typically, an Ordo API customer that is integrating into Ordo does so as a single User/Client and can create new Participants and add each of them to this single User. Adding multiple Participants allows the User/Client to easily manage and administer a range of their own customers/business areas that require payment to be made to them. For instance, a Council may wish to have a Participant per administrative area, one for Council Tax, another for Parking fines etc. Each Participant can have one or more Billing Accounts (bank accounts) assigned to it.

We also provide the option to manage receivables into a large number of different bank accounts, either for your own organisation or on behalf of multiple customers. Typical use cases include:

• banks managing a portfolio of savings or loan accounts,
• EMIs offering pre-paid card accounts, and
• SaaS providers operating hosted solutions for multiple customers.

Each payment request would present the name of the account that funds are to go to, providing a more personalised touch to your customer experience. You can also segregate different customers/business lines by creating a range of participant IDs, and associate different accounts and white-labelling to each participant ID.

Client On-Boarding Prerequisites

Please see our Get Started section, to learn in detail how to On-Board onto our platform and register for our Financial Institution API.

API Ochestration Guide For Financial Institution Flows

Creation of a Participant

Obtain an access token from the identity service with Client Credentials context, using the supplied Client Id and Client Secret, with scope ‘users’

The UserPID will be supplied to you as part of the integration steps into our SIT, and then Production environments. The UserPID can be included in both the "requestingUserPID" and "contextUserPID".

Example Create participant and response

{
    "requestingUserPID": "9317b7ec-6ycb-4fd1-bb3c-7932d5bf6528",
    "contextUserPID": "9317b7ec-6ycb-4fd1-bb3c-7932d5bf6528",
    "participantType": "ORG",
    "participantDisplayName": "New Participant",
    "isApprovedBiller": true,
    "payerStatus":"Y"  
}

{
    "participantId": 17454,
    "participantType": "ORG",
    "participantDisplayName": "New Participant",
    "organisationType": null,
    "organisationId": null,
    "billerApprovedName": "null",
    "logo": null,
    "payerStatus": "Y",
    "participantDescription": null,
    "emailAddress": null,
    "phoneNumber": null,
    "address": null,
    "isApprovedBiller": true,
    "participantBillerOptions": null
}

A participantId will be returned

🚧

Note

• Please use participantDisplayName for each client you on board.
• billerApprovedName will change the name displayed to a PSU for all Participants created under a User.
• isApprovedBiller set to ‘true’ allows the biller to request larger value payments as it bypasses our value controls.

Adding a Billing Account

A Participant requires a bank account to receive payment into, and rather than providing these details in the Payment Request message, the Biller Account Id is used instead. When the end-customer pays the Payment Request, Ordo provides the actual account details to the payer’s bank. A Participant Administrator can add/remove account details. Bank Account details will be validated by the Financial Institution as part of the Know Your Customer (KYC) process.

Example Add Billing Account and response

{
    "participantId": 17454,
    "accountType": "BUSINESS",
    "accountSubType": "CURRENTACCOUNT",
    "schemeName": "SortCodeAccountNumber",
    "currency": "GBP",
    "accountName": "Business Line 1",
    "sortCode": "166851",
    "accountNumber": "87849196"
}

{
    "participantId": 17454,
    "billerAccountId": "917A8A90-7AE9-4A3F-8C68-535DA5234CE0",
    "accountType": "PERSONAL",
    "accountSubType": "CURRENTACCOUNT",
    "currency": "GBP",
    "schemeName": "SortCodeAccountNumber",
    "accountName": "Business Line 1",
    "sortCode": "166051",
    "accountNumber": "87889196"
}

A billerAccountId will be returned

📘

NOTE

When adding a billing account in the Ordo Staging or Production environment, please ensure that the sort code and account number are numeric values and six-digits and eight-digits respectively. If you have an account number that is shorter than eight-digits, it should be padded with leading zeros to meet the required eight-digit length.

🚧

Note

• accountName's are truncated to 35 characters due as this is the maximum character limit within the Faster Payments Scheme. OBAPI will also trunacate
• accountName's are also truncated to 18 characters for payments made to HSBC Business & Barclays (Personal, Business, Corporate & Wealth) as these banks have this as their maximum character limit