Nofrixion SDK
NoFrixion MoneyMoov API client, generated from the OpenAPI spec.
Learn more about NoFrixion MoneyMoov API at nofrixion.com.
This is an unofficial SDK for the NoFrixion MoneyMoov public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.
Learn more about Voxgig SDKs at voxgig.com/sdk.
TypeScript, Python, PHP, Golang, Ruby, Lua SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.
Entities, not endpoints
This SDK exposes the API as 49 semantic entities that you
call directly, instead of assembling URL paths and query strings. See the Entities table below for the full list. Entities are
Capitalised to mark them as the primary surface, each with the operations they
support (list, load, create, update, remove):
const client = new NofrixionSDK()
const items = await client.Account().list()
Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.
Offline unit testing
Every SDK ships a built-in test mode that swaps the HTTP transport for an in-memory mock, so your unit tests run fully offline — no server, no network, and no credentials:
TypeScript
const client = NofrixionSDK.test()
const accounts = await client.Account().list()
// accounts is an array of bare Account records populated with mock data
console.log(accounts)
Python
client = NofrixionSDK.test()
accounts = client.Account().list()
print(accounts)
PHP
// Seed fixture data so offline calls resolve without a live server.
$client = NofrixionSDK::test([
"entity" => ["account" => ["test01" => ["id" => "test01"]]],
]);
$accounts = $client->Account()->list();
Golang
client := sdk.Test()
result, err := client.Account(nil).List(
nil, nil,
)
Ruby
# Seed fixture data so offline calls resolve without a live server.
client = NofrixionSDK.test({
"entity" => { "account" => { "test01" => { "id" => "test01" } } },
})
accounts = client.Account.list()
Lua
local client = sdk.test()
local results, err = client:Account():list()
Packages
| Language | Package | Install |
|---|---|---|
| TypeScript | @voxgig-sdk/nofrixion | publish pending — install from git tag |
| Python | voxgig-sdk-nofrixion | publish pending — install from git tag |
| PHP | voxgig-sdk/nofrixion | publish pending — install from git tag |
| Golang | github.com/voxgig-sdk/nofrixion-sdk/go | go get github.com/voxgig-sdk/nofrixion-sdk/go@latest |
| Ruby | voxgig-sdk-nofrixion | publish pending — install from git tag |
| Lua | voxgig-sdk-nofrixion | publish pending — install from git tag |
| Go CLI | github.com/voxgig-sdk/nofrixion-sdk/go-cli | go install github.com/voxgig-sdk/nofrixion-sdk/go-cli/cmd/nofrixion@latest |
| Go MCP server | github.com/voxgig-sdk/nofrixion-sdk/go-mcp | go get github.com/voxgig-sdk/nofrixion-sdk/go-mcp@latest |
Quickstart
TypeScript
import { NofrixionSDK } from '@voxgig-sdk/nofrixion'
const client = new NofrixionSDK({
apikey: process.env.NOFRIXION_APIKEY,
})
// List all accounts (returns Account[])
const accounts = await client.Account().list()
for (const account of accounts) {
console.log(account)
}
// Load a specific cardcustomertoken (returns a CardCustomerToken)
const cardcustomertoken = await client.CardCustomerToken().load({
customer_email_address: 'example_customer_email_address',
})
console.log(cardcustomertoken)
See the TypeScript README for the full guide.
Surfaces
| Surface | Path |
|---|---|
| SDK (TypeScript, Python, PHP, Golang, Ruby, Lua) | ts/ py/ php/ go/ rb/ lua/ |
| CLI | go-cli/ |
| MCP server | go-mcp/ |
Use it from an AI agent (MCP)
The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:
cd go-mcp && go build -o nofrixion-mcp .
Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):
{
"mcpServers": {
"nofrixion": {
"command": "/abs/path/to/nofrixion-mcp"
}
}
}
Entities
The API exposes 49 entities:
| Entity | Description | API path |
|---|---|---|
| Account | The Account entity (create, list, load, remove, update). | /api/v1/accounts/{accountID}/{currency} |
| Batch | The Batch entity (create, load). | /api/v1/payouts/batch |
| Beneficiary | The Beneficiary entity (create, list, load, remove, update). | /api/v1/beneficiaries/authorise/{id} |
| BeneficiaryGroup | The BeneficiaryGroup entity (list). | /api/v1/merchants/{merchantID}/beneficiarygroups |
| Card | The Card entity (create). | /api/v1/paymentrequests/{id}/card |
| CardCustomerToken | The CardCustomerToken entity (list, load, remove). | /api/v1/paymentrequests/card/customertokens/{merchantID}/{customerEmailAddress} |
| CardPayment | The CardPayment entity (create). | /api/v1/paymentrequests/{id}/card/refund/{partialRefundAmount} |
| CardPublicKey | The CardPublicKey entity (load). | /api/v1/paymentrequests/{id}/card/publickey |
| Consent | The Consent entity (create, list, load, remove, update). | /api/v1/openbanking/consents |
| Currency | The Currency entity (list). | /api/v1/currencies |
| DirectDebitBatchSubmit | The DirectDebitBatchSubmit entity (create). | /api/v1/paymentrequests/directdebit/batchsubmit |
| FxRate | The FxRate entity (list, load). | /api/v1/payouts/fxallheldrates/{source}/{destination} |
| IPayment | The IPayment entity (create). | /api/v1/paymentrequests/payondemand |
| Mandate | The Mandate entity (create, load). | /api/v1/mandates |
| Merchant | The Merchant entity (list, load, remove, update). | /api/v1/merchants/{merchantID}/childmerchants |
| MerchantAuthorisationSetting | The MerchantAuthorisationSetting entity (list). | /api/v1/merchants/{merchantID}/authorisationsettings |
| MerchantDirectDebitMandatePage | The MerchantDirectDebitMandatePage entity (list). | /api/v1/mandates |
| MerchantPayByBankSetting | The MerchantPayByBankSetting entity (list). | /api/v1/merchants/{merchantID}/banksettings |
| MerchantPaymentRequestTemplate | The MerchantPaymentRequestTemplate entity (list, load, remove, update). | /api/v1/paymentrequests/{merchantID}/templates |
| MerchantToken | The MerchantToken entity (create, list, load, update). | /api/v1/tokens |
| Metadata | The Metadata entity (load). | /api/v1/metadata/problemnotification |
| NoFrixionVersion | The NoFrixionVersion entity (load). | /api/v1/metadata/version |
| OpenBanking | The OpenBanking entity (create, remove). | /api/v1/openbanking/account/{accountID}/synchronise |
| Payeeverification | The Payeeverification entity (create). | /api/v1/openbanking/payeeverification |
| Payment | The Payment entity (create, load, update). | /api/v1/paymentrequests |
| PaymentAccount | The PaymentAccount entity (list). | /api/v1/accounts/paged |
| PaymentAccountMinimal | The PaymentAccountMinimal entity (list). | /api/v1/accounts/minimal |
| PaymentInitiation | The PaymentInitiation entity (create). | /api/v1/paymentrequests/{id}/pisp |
| PaymentRequest | The PaymentRequest entity (create, list, load, remove, update). | /api/v1/paymentrequests/{id}/directdebit |
| PaymentRequestEvent | The PaymentRequestEvent entity (list). | /api/v1/paymentrequests/{id}/events |
| PaymentRequestMetric | The PaymentRequestMetric entity (load). | /api/v1/paymentrequests/metrics |
| PaymentRequestMinimal | The PaymentRequestMinimal entity (list). | /api/v1/paymentrequests/{id}/minimal |
| PaymentRequestResult | The PaymentRequestResult entity (list). | /api/v1/paymentrequests/{id}/result |
| Payout | The Payout entity (create, list, load, remove, update). | /api/v1/payouts/batch/submit/{id} |
| PayoutKeysetPage | The PayoutKeysetPage entity (list). | /api/v1/accounts/{accountID}/payouts/failed |
| PayoutMetric | The PayoutMetric entity (load). | /api/v1/payouts/metrics |
| Payrun | The Payrun entity (create, list, load, remove, update). | /api/v1/payruns/{id}/request-authorisation |
| Report | The Report entity (update). | /api/v1/reports/{id}/initiate |
| ReportResult | The ReportResult entity (load). | /api/v1/reports/{id}/result/{statementNumber} |
| Role | The Role entity (create). | /api/v1/merchants/{merchantID}/roles/batchcreate |
| Rule | The Rule entity (create, list, load, remove, update). | /api/v1/rules |
| RuleEvent | The RuleEvent entity (list). | /api/v1/rules/{id}/events |
| Tag | The Tag entity (create, list). | /api/v1/merchants/{merchantID}/tags |
| Token | The Token entity (create, remove). | /api/v1/tokens/authorise/{id} |
| Transaction | The Transaction entity (create, list, load, remove). | /api/v1/transactions/{id}/tags |
| User | The User entity (list, update). | /api/v1/user/{merchantID}/userspaged |
| UserInvite | The UserInvite entity (create, list, load, remove, update). | /api/v1/userinvites/authorise/{id} |
| Virtual | The Virtual entity (create, update). | /api/v1/accounts/{accountID}/virtual |
| Webhook | The Webhook entity (create, list, load, remove, update). | /api/v1/webhooks |
The operations available across these entities are load, list, create, update, remove — see each entity’s own list above for exactly which it supports.
Quickstart in other languages
Python
import os
from nofrixion_sdk import NofrixionSDK
client = NofrixionSDK({
"apikey": os.environ.get("NOFRIXION_APIKEY"),
})
# List all accounts (returns a list, raises on error)
accounts = client.Account().list()
for account in accounts:
print(account)
# Load a specific account (returns the record, raises on error)
account = client.Account().load({"id": "example_id"})
print(account)
PHP
<?php
require_once 'nofrixion_sdk.php';
$client = new NofrixionSDK([
"apikey" => getenv("NOFRIXION_APIKEY"),
]);
// List all accounts (returns an array; throws on error)
$accounts = $client->Account()->list();
print_r($accounts);
// Load a specific account (returns the bare record; throws on error)
$account = $client->Account()->load(["id" => "example_id"]);
print_r($account);
Golang
import sdk "github.com/voxgig-sdk/nofrixion-sdk/go"
client := sdk.NewNofrixionSDK(map[string]any{
"apikey": os.Getenv("NOFRIXION_APIKEY"),
})
// List all accounts
accounts, err := client.Account(nil).List(nil, nil)
if err != nil {
panic(err)
}
fmt.Println(accounts)
// Load a specific cardcustomertoken
cardCustomerToken, err := client.CardCustomerToken(nil).Load(
map[string]any{"customer_email_address": "example_customer_email_address"}, nil,
)
if err != nil {
panic(err)
}
fmt.Println(cardCustomerToken)
Ruby
require_relative "Nofrixion_sdk"
client = NofrixionSDK.new({
"apikey" => ENV["NOFRIXION_APIKEY"],
})
# List all accounts (returns an Array; raises on error)
accounts = client.Account.list
puts accounts
# Load a specific account (returns the bare record; raises on error)
account = client.Account.load({ "id" => "example_id" })
puts account
Lua
local sdk = require("nofrixion_sdk")
local client = sdk.new({
apikey = os.getenv("NOFRIXION_APIKEY"),
})
-- List all accounts
local accounts, err = client:Account():list()
print(accounts)
-- Load a specific account
local account, err = client:Account():load({ id = "example_id" })
print(account)
Direct and prepare
For endpoints the entity model doesn’t cover, use the low-level methods:
direct(fetchargs)— build and send an HTTP request in one step.prepare(fetchargs)— build the request without sending it.
Both accept a map with path, method, params, query,
headers, and body. See the How-to guides below.
How-to guides
Make a direct API call
When the entity interface does not cover an endpoint, use direct:
TypeScript:
const result = await client.direct({
path: '/api/resource/{id}',
method: 'GET',
params: { id: 'example' },
})
if (result instanceof Error) {
throw result
}
console.log(result.data)
Python:
result = client.direct({
"path": "/api/resource/{id}",
"method": "GET",
"params": {"id": "example"},
})
PHP:
$result = $client->direct([
"path" => "/api/resource/{id}",
"method" => "GET",
"params" => ["id" => "example"],
]);
Go:
result, err := client.Direct(map[string]any{
"path": "/api/resource/{id}",
"method": "GET",
"params": map[string]any{"id": "example"},
})
if err != nil {
panic(err)
}
fmt.Println(result)
Ruby:
result = client.direct({
"path" => "/api/resource/{id}",
"method" => "GET",
"params" => { "id" => "example" },
})
Lua:
local result, err = client:direct({
path = "/api/resource/{id}",
method = "GET",
params = { id = "example" },
})
Advanced
Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.
Every SDK call runs the same five-stage pipeline:
- Point — resolve the API endpoint from the operation definition.
- Spec — build the HTTP specification (URL, method, headers, body).
- Request — send the HTTP request.
- Response — receive and parse the response.
- Result — extract the result data for the caller.
A feature hook fires at each stage (e.g. PrePoint, PreSpec,
PreRequest), so features can inspect or modify the pipeline without
forking the SDK.
Features
| Feature | Purpose |
|---|---|
| TestFeature | In-memory mock transport for testing without a live server |
Pass custom features via the extend option at construction time.
Per-language documentation
Upstream API
This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.
- Upstream API: https://api-sandbox.nofrixion.com
Security
Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.
Generated from the NoFrixion MoneyMoov API OpenAPI spec by @voxgig/sdkgen.