API Quickstart

Getting started in Sandbox

Sandbox environment

The Sandbox environment is a replica of the production environment, supporting all of the same API endpoints. Applications should be tested against the Sandbox environment before being used in production.

Differences from production environment

  • The Sandbox contains only test data and is completely separate from your production account.
  • All API endpoints use the sandbox base URL (https://api.demo.narmitech.com/v1), not a production url.
  • Actual money is not sent or received as part of test transactions.
  • Transfers may not create corresponding transactions, they remain pending indefinitely.
Real financial data should never be used in the Sandbox.

Sandbox setup

To set up your Sandbox account, all we ask for is a valid email address.

After email verification, your Sandbox account will be created and you’ll be redirected to our Sandbox Dashboard at https://demo.narmitech.com/. Here you can view your API key and secret and generate an OAuth access token. On enrollment, we’ll seed your account with transaction history and a (fake) balance.

Next Steps

Once you have a valid Sandbox account, you can start making calls to the API. To simplify development, learn about configuring and using our SDKs. You can also jump straight into the API docs.

Make your first API call

Javascript

Install via NPM:

npm install github:narmitech/banking-client-node --save

The library is hosted at a git repository, (https://github.com/narmitech/banking-client-node).

Here's a good first call to make:

List transactionsjavascript
var BankingClient = require('banking-client');
var config = BankingClient.ApiClient.configuration;
config.basePath = "{{default_base_url}}";
var auth = config.authentications['Application'];
auth.accessToken = '{{default_api_key}}';
auth.secret = '{{default_api_secret}}';
var opts = {};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ', data);
}
};
BankingClient.transactions.list(opts, callback);

Php

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/narmitech/banking-client-php.git"
    }
  ],
  "require": {
    "narmitech/banking-client-php": "*@dev"
  }
}

Then run composer install.

Here's a good first call to make:

List transactionsphp
<?php
require_once(__DIR__ . '/vendor/autoload.php');
date_default_timezone_set('UTC');
Banking\Client\Configuration::getDefaultConfiguration()->setHost('{{default_base_url}}');
Banking\Client\Configuration::getDefaultConfiguration()->setAccessToken('{{default_api_key}}');
Banking\Client\Configuration::getDefaultConfiguration()->setSecret('{{default_api_secret}}');
$api_instance = new Banking\Client\Api\TransactionApi(new \Http\Adapter\Guzzle6\Client());
try {
$result = $api_instance->callList();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TransactionApi->callList: ', $e->getMessage(), PHP_EOL;
}
?>