Credit card accounts

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

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(100)	Account name.
ccprocessorid	integer	Processor. See `ccprocessors` - read-only, it is a static table.
ccprocessor	string(100)	Processor name instead of the id.
checkacctid	integer	Bank account deposits land in.
checkacct	string(30)	Bank account name (`checkacct.name`) instead of the id.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this credit card accounts. Scoped to your company.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.

Endpoints#

POST/ccaccounts/batch 207

Create many.

Requires scope banking:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(100)	Account name.
ccprocessorid	integer	Processor. See `ccprocessors` - read-only, it is a static table.
ccprocessor	string(100)	Processor name instead of the id.
checkacctid	integer	Bank account deposits land in.
checkacct	string(30)	Bank account name (`checkacct.name`) instead of the id.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this credit card accounts. Scoped to your company.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/ccaccounts/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "id": 1,
        "name": "Main merchant",
        "ccprocessorid": 1,
        "ccprocessor": "PaidYET",
        "checkacctid": 3,
        "checkacct": "Operating",
        "cancel": false
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/ccaccounts/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'id' => 1,
      'name' => 'Main merchant',
      'ccprocessorid' => 1,
      'ccprocessor' => 'PaidYET',
      'checkacctid' => 3,
      'checkacct' => 'Operating',
      'cancel' => false,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/ccaccounts/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "id": 1,
            "name": "Main merchant",
            "ccprocessorid": 1,
            "ccprocessor": "PaidYET",
            "checkacctid": 3,
            "checkacct": "Operating",
            "cancel": False,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/ccaccounts/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        id: 1,
        name: "Main merchant",
        ccprocessorid: 1,
        ccprocessor: "PaidYET",
        checkacctid: 3,
        checkacct: "Operating",
        cancel: false,
      },
    ]),
  }
);
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 body = new[] {
    new {
        id = 1,
        name = "Main merchant",
        ccprocessorid = 1,
        ccprocessor = "PaidYET",
        checkacctid = 3,
        checkacct = "Operating",
        cancel = false,
    },
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/ccaccounts/batch") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

GET/ccaccounts 200403

List credit card 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`.
externalid	query	string	Exact match on your own key. Scoped to your company.
modifiedsince	query	string	RFC 3339 UTC timestamp. Returns only records changed since then, including cancelled ones - so `cancel` defaults to any rather than `false` when this is used. The response carries `_meta.synced_through`; store it and send it back next time.
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 `ccaccounts:read`.

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

$ch = curl_init('https://acme.nolapro.com/!/api/v2/ccaccounts');
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/ccaccounts",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/ccaccounts',
  {
    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/ccaccounts");
res.EnsureSuccessStatusCode();

POST/ccaccounts 201400409

Create.

Requires scope banking:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(100)	Account name.
ccprocessorid	integer	Processor. See `ccprocessors` - read-only, it is a static table.
ccprocessor	string(100)	Processor name instead of the id.
checkacctid	integer	Bank account deposits land in.
checkacct	string(30)	Bank account name (`checkacct.name`) instead of the id.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this credit card accounts. Scoped to your company.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing.
409	duplicate	That code is already in use.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/ccaccounts' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 1,
    "name": "Main merchant",
    "ccprocessorid": 1,
    "ccprocessor": "PaidYET",
    "checkacctid": 3,
    "checkacct": "Operating",
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/ccaccounts');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 1,
    'name' => 'Main merchant',
    'ccprocessorid' => 1,
    'ccprocessor' => 'PaidYET',
    'checkacctid' => 3,
    'checkacct' => 'Operating',
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/ccaccounts",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 1,
        "name": "Main merchant",
        "ccprocessorid": 1,
        "ccprocessor": "PaidYET",
        "checkacctid": 3,
        "checkacct": "Operating",
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/ccaccounts',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 1,
      name: "Main merchant",
      ccprocessorid: 1,
      ccprocessor: "PaidYET",
      checkacctid: 3,
      checkacct: "Operating",
      cancel: false,
    }),
  }
);
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 body = new {
    id = 1,
    name = "Main merchant",
    ccprocessorid = 1,
    ccprocessor = "PaidYET",
    checkacctid = 3,
    checkacct = "Operating",
    cancel = false,
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/ccaccounts") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 201

{
    "id": 1,
    "name": "Main merchant",
    "ccprocessorid": 1,
    "ccprocessor": "PaidYET",
    "checkacctid": 3,
    "checkacct": "Operating",
    "cancel": false
}

GET/ccaccounts/{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/ccaccounts/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/ccaccounts/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/ccaccounts/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/ccaccounts/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/ccaccounts/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 1,
    "name": "Main merchant",
    "ccprocessorid": 1,
    "ccprocessor": "PaidYET",
    "checkacctid": 3,
    "checkacct": "Operating",
    "cancel": false
}

PATCH/ccaccounts/{id} 200404409

Update.

Requires scope banking:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(100)	Account name.
ccprocessorid	integer	Processor. See `ccprocessors` - read-only, it is a static table.
ccprocessor	string(100)	Processor name instead of the id.
checkacctid	integer	Bank account deposits land in.
checkacct	string(30)	Bank account name (`checkacct.name`) instead of the id.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this credit card accounts. Scoped to your company.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.
409	stale_record	`If-Match` did not match.

curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/ccaccounts/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 1,
    "name": "Main merchant",
    "ccprocessorid": 1,
    "ccprocessor": "PaidYET",
    "checkacctid": 3,
    "checkacct": "Operating",
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/ccaccounts/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 1,
    'name' => 'Main merchant',
    'ccprocessorid' => 1,
    'ccprocessor' => 'PaidYET',
    'checkacctid' => 3,
    'checkacct' => 'Operating',
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/ccaccounts/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 1,
        "name": "Main merchant",
        "ccprocessorid": 1,
        "ccprocessor": "PaidYET",
        "checkacctid": 3,
        "checkacct": "Operating",
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/ccaccounts/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 1,
      name: "Main merchant",
      ccprocessorid: 1,
      ccprocessor: "PaidYET",
      checkacctid: 3,
      checkacct: "Operating",
      cancel: false,
    }),
  }
);
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 body = new {
    id = 1,
    name = "Main merchant",
    ccprocessorid = 1,
    ccprocessor = "PaidYET",
    checkacctid = 3,
    checkacct = "Operating",
    cancel = false,
};

var req = new HttpRequestMessage(HttpMethod.Patch,
    "https://acme.nolapro.com/!/api/v2/ccaccounts/104") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 1,
    "name": "Main merchant",
    "ccprocessorid": 1,
    "ccprocessor": "PaidYET",
    "checkacctid": 3,
    "checkacct": "Operating",
    "cancel": false
}

DELETE/ccaccounts/{id} 200403404

Cancel.

Requires scope banking:cancel.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

When it fails

Status	Code	Meaning
403	insufficient_scope	Needs `ccaccounts:cancel`.
404	not_found	No record with that id.

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

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

import os, requests

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

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/ccaccounts/104',
  {
    method: 'DELETE',
    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 req = new HttpRequestMessage(HttpMethod.Delete,
    "https://acme.nolapro.com/!/api/v2/ccaccounts/104");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 1,
    "name": "Main merchant",
    "ccprocessorid": 1,
    "ccprocessor": "PaidYET",
    "checkacctid": 3,
    "checkacct": "Operating",
    "cancel": false
}

Card processors →

Payment processors NolaPro can talk to. A static table - dbupdate.php rebuilds it on every update, so it is read-only and your own rows would not survive. Referenced by ccaccounts.ccprocessorid.

Card terminals →

Physical card terminals.