Developer Documentation
  • Welcome to OurPass Developer Documentation 🥳
  • Quick Start Guide🚓
    • Errors🚦
    • Test Cards💳
  • OurPass Checkout Button 🔘
  • Collect Payment via the Checkout Button🔘
    • OurPass Inline - HTML
    • OurPass Inline - Angular.js
    • OurPass Inline - React.js
    • OurPass Inline - Vue.js
  • SDKs and Plugins📱
    • Banks 🏦
    • WooCommerce Plugin
    • AdobeCommerce Plugin
  • Connect🖇
    • Create a Connected Account
    • Get Connected Accounts
    • Accepting Payments with Connected Accounts
    • Connected Account Transactions
    • Update/Overhaul Connected Account
    • Delete Connected Account
  • API Reference※
    • Banks🏦
Powered by GitBook
On this page
  • List connected accounts
  • Get Connected accounts
  • Create a Connected Accounts

Was this helpful?

  1. Connect🖇

Get Connected Accounts

List connected accounts

List of connected accounts can be seen via dashboard and available via API for larger integrations. If you accessing connected accounts via your business dashboard, simply go to connect and select the connected account tab.

Terminologies for connected businesses

  • limit: This refers to the number of paginated data you want to be returned

  • Page: This refers to the particular pagination you want to returned.

Get Connected accounts

Connected accounts can either be created via your business/merchant dashboard or directly via create account endpoint.

Create a Connected Accounts

GET https://api2.ourpass.co/v1/api/subaccounts/partial

This endpoint help businesses to create connected accounts

Headers

Name
Type
Description

apiKey*

String

Pass your api key in the request header to authorise the call

{
    "success": true,
    "message": "Successfully gotten your SubAccount",
    "data": [
        {
            "id": 1296,
            "accountId": 52,
            "subAccountEmail": "tobitom601@royins.com",
            "type": "subaccount",
            "authorizationKeys": "auth_live_VPEC6b6Ep2QGq0kepUUfEtw6VyVuU5y3",
            "txPercentage": 10,
            "txCap": 1000,
            "enabled": true,
            "businessId": 155,
            "walletUserMobile": "2348112705999",
            "account": {
                "bankName": "ACCESS BANK",
                "accountNumber": "0073559141",
                "bankCode": "000001",
                "currency": "NGN",
                "name": "OLALEKAN ADEWALE",
                "walletType": "user"
            }
        },
        {
            "id": 1297,
            "accountId": 53,
            "subAccountEmail": "tosin@royins.com",
            "type": "subaccount",
            "authorizationKeys": "auth_live_VPEC6b6Ep2QGq0kepUUfEtw6VyVuU5y3",
            "txPercentage": 10,
            "txCap": 1000,
            "enabled": true,
            "businessId": 155,
            "walletUserMobile": "2348112705990",
            "account": {
                "bankName": "ZENITH BANK",
                "accountNumber": "0073559142",
                "bankCode": "000011",
                "currency": "NGN",
                "name": "OLALEKAN JESSE",
                "walletType": "user"
            }
        },
    ]
}
{
    "success": false,
    "message": "Invalid AuthKey",
    "data": null
}
curl --location --request GET 'https://api2.ourpass.co/v1/api/subaccounts?page=1&limit=24'
var axios = require('axios');

var config = {
  method: 'post',
  url: 'https://api2.ourpass.co/v1/api/subaccounts?page=1&limit=24',
  headers: { },
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://api2.ourpass.co/v1/api/subaccounts?page=1&limit=24');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));

try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "net/http"

url = URI("https://api2.ourpass.co/v1/api/subaccounts?page=1&limit=24")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)

response = https.request(request)
puts response.read_body
import requests

url = "https://api2.ourpass.co/v1/api/subaccounts?page=1&limit=24"

headers = {}

response = requests.request("GET", url, headers=headers)

print(response.text)
PreviousCreate a Connected AccountNextAccepting Payments with Connected Accounts

Last updated 2 years ago

Was this helpful?