Bank accounts

Read-only. Bank accounts carry accountnumber, positive-pay SFTP credentials and private keys. Those are never returned, and the account is not writable through the API - changing where money moves is not an integration operation.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
nameread-only	string(30)	Account name.
currencyread-only	string(10)	Currency code.
apread-only	boolean	Available for payables.
arread-only	boolean	Available for receivables.
inactiveread-only	boolean	Not in use.
cancelread-only	boolean	True once cancelled.

Endpoints#

GET/checkaccounts 200403

List bank accounts.

Requires scope banking:read.

Parameters

Name	In	Type	Notes
name	query	string	name. Partial match, case-insensitive.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
403	insufficient_scope	Token lacks `checkaccounts:read`.

curl \
  'https://acme.nolapro.com/!/api/v2/checkaccounts' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/checkaccounts');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/checkaccounts",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/checkaccounts',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/checkaccounts");
res.EnsureSuccessStatusCode();

GET/checkaccounts/{id} 200404

Retrieve one record.

Requires scope banking:read.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl \
  'https://acme.nolapro.com/!/api/v2/checkaccounts/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/checkaccounts/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/checkaccounts/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/checkaccounts/104',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/checkaccounts/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 3,
    "name": "Operating",
    "currency": "USD",
    "ap": true,
    "ar": true,
    "inactive": false,
    "cancel": false
}

Bank deposits →

Deposits into a bank account.

Credit card accounts →

Merchant accounts used to take card payments. The processor behind each one is a static lookup and is not exposed.