Nofrixion SDK

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, Golang, Ruby SDKs, and an interactive REPL — all generated from one OpenAPI spec by @voxgig/sdkgen.

Entities, not endpoints

This SDK exposes the API as a small set of semantic entities — Account, Beneficiary, Cancel, Disable, Enable, Merchant, Metadata, NoFrixionBizBizModelsPagingMerchantDirectDebitMandatePage, NoFrixionBizBizModelsPagingPaymentRequestPage, NoFrixionBizBizModelsPagingPayoutPage, NoFrixionBizBizModelsPagingPayrunPage, NoFrixionBizBizModelsPagingRuleEventsPage, NoFrixionBizBizModelsPagingRulesPage, NoFrixionBizBizModelsPaymentsCardPayment, NoFrixionBizBizModelsPaymentsCardPublicKey, NoFrixionMoneyMoovApiFeaturesBeneficiariesBeneficiaries, NoFrixionMoneyMoovApiFeaturesPaymentRequestsPayment, NoFrixionMoneyMoovApiFeaturesPermissionsRolesCreate, NoFrixionMoneyMoovApiFeaturesUserInvitesCreate, NoFrixionMoneyMoovModelsAuthorisationSettingsMerchant, NoFrixionMoneyMoovModelsBatchPayout, NoFrixionMoneyMoovModelsBeneficiaryGroupPage, NoFrixionMoneyMoovModelsBeneficiaryPage, NoFrixionMoneyMoovModelsCardCustomerToken, NoFrixionMoneyMoovModelsCurrencyCurrencyInfo, NoFrixionMoneyMoovModelsDirectDebitBatchSubmit, NoFrixionMoneyMoovModelsFxRate, NoFrixionMoneyMoovModelsIPayment, NoFrixionMoneyMoovModelsMandatesMandate, NoFrixionMoneyMoovModelsMerchant, NoFrixionMoneyMoovModelsMerchantPage, NoFrixionMoneyMoovModelsMerchantPayByBankSetting, NoFrixionMoneyMoovModelsMerchantToken, NoFrixionMoneyMoovModelsMerchantTokenPage, NoFrixionMoneyMoovModelsNoFrixionVersion, NoFrixionMoneyMoovModelsOpenBankingAccount, NoFrixionMoneyMoovModelsOpenBankingConsent, NoFrixionMoneyMoovModelsOpenBankingTransaction, NoFrixionMoneyMoovModelsPayment, NoFrixionMoneyMoovModelsPaymentAccountMinimalPage, NoFrixionMoneyMoovModelsPaymentAccountPage, NoFrixionMoneyMoovModelsPaymentInitiation, NoFrixionMoneyMoovModelsPaymentRequestEvent, NoFrixionMoneyMoovModelsPaymentRequestMetric, NoFrixionMoneyMoovModelsPaymentRequestMinimal, NoFrixionMoneyMoovModelsPaymentRequestResult, NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment, NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment2, NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment3, NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment4, NoFrixionMoneyMoovModelsPayoutKeysetPage, NoFrixionMoneyMoovModelsPayoutMetric, NoFrixionMoneyMoovModelsPayoutsPayoutsCreate, NoFrixionMoneyMoovModelsPayrun, NoFrixionMoneyMoovModelsReportResult, NoFrixionMoneyMoovModelsRule, NoFrixionMoneyMoovModelsTransaction, NoFrixionMoneyMoovModelsTransactionPage, NoFrixionMoneyMoovModelsUserInvite, NoFrixionMoneyMoovModelsUserInvitePage, NoFrixionMoneyMoovModelsUserPage, NoFrixionMoneyMoovModelsWebhook, OpenBanking, Payeeverification, PaymentRequest, Payout, Payrun, Reject, Report, Rule, Send, Sendbeneficiary, Tag, Token, Transaction, User, UserInvite, Virtual, Webhook, Whoami and Whoamitrustedapp — that you call directly, instead of assembling URL paths and query strings. 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)

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()

Packages

LanguagePackageInstall
TypeScript@voxgig-sdk/nofrixionpublish pending — install from git tag
Pythonvoxgig-sdk-nofrixionpublish pending — install from git tag
Golanggithub.com/voxgig-sdk/nofrixion-sdk/gogo get github.com/voxgig-sdk/nofrixion-sdk/go@latest
Rubyvoxgig-sdk-nofrixionpublish pending — install from git tag

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 merchant (returns a Merchant)
const merchant = await client.Merchant().load({
  merchant_id: 'example_merchant_id',
})
console.log(merchant)

See the TypeScript README for the full guide.

Surfaces

SurfacePath
SDK (TypeScript, Python, Golang, Ruby)ts/ py/ go/ rb/

Entities

The API exposes 81 entities:

EntityDescriptionAPI path
AccountThe Account entity (create, list, load, remove, update)./api/v1/accounts/{accountID}/{currency}
BeneficiaryThe Beneficiary entity (create, load, remove, update)./api/v1/beneficiaries/authorise/{id}
CancelThe Cancel entity (update)./api/v1/payouts/cancel/{id}
DisableThe Disable entity (update)./api/v1/beneficiaries/disable/{id}
EnableThe Enable entity (update)./api/v1/beneficiaries/enable/{id}
MerchantThe Merchant entity (load, remove, update)./api/v1/merchants/{merchantID}/payouts/export
MetadataThe Metadata entity (load)./api/v1/metadata/problemnotification
NoFrixionBizBizModelsPagingMerchantDirectDebitMandatePageThe NoFrixionBizBizModelsPagingMerchantDirectDebitMandatePage entity (list)./api/v1/mandates
NoFrixionBizBizModelsPagingPaymentRequestPageThe NoFrixionBizBizModelsPagingPaymentRequestPage entity (list)./api/v1/paymentrequests
NoFrixionBizBizModelsPagingPayoutPageThe NoFrixionBizBizModelsPagingPayoutPage entity (list)./api/v1/payouts
NoFrixionBizBizModelsPagingPayrunPageThe NoFrixionBizBizModelsPagingPayrunPage entity (list)./api/v1/payruns
NoFrixionBizBizModelsPagingRuleEventsPageThe NoFrixionBizBizModelsPagingRuleEventsPage entity (list)./api/v1/rules/{id}/events
NoFrixionBizBizModelsPagingRulesPageThe NoFrixionBizBizModelsPagingRulesPage entity (list)./api/v1/rules
NoFrixionBizBizModelsPaymentsCardPaymentThe NoFrixionBizBizModelsPaymentsCardPayment entity (create)./api/v1/paymentrequests/{id}/card/refund/{partialRefundAmount}
NoFrixionBizBizModelsPaymentsCardPublicKeyThe NoFrixionBizBizModelsPaymentsCardPublicKey entity (load)./api/v1/paymentrequests/{id}/card/publickey
NoFrixionMoneyMoovApiFeaturesBeneficiariesBeneficiariesThe NoFrixionMoneyMoovApiFeaturesBeneficiariesBeneficiaries entity (create)./api/v1/beneficiaries/batchcreate
NoFrixionMoneyMoovApiFeaturesPaymentRequestsPaymentThe NoFrixionMoneyMoovApiFeaturesPaymentRequestsPayment entity (create)./api/v1/paymentrequests/batchcreate
NoFrixionMoneyMoovApiFeaturesPermissionsRolesCreateThe NoFrixionMoneyMoovApiFeaturesPermissionsRolesCreate entity (create)./api/v1/merchants/{merchantID}/roles/batchcreate
NoFrixionMoneyMoovApiFeaturesUserInvitesCreateThe NoFrixionMoneyMoovApiFeaturesUserInvitesCreate entity (create)./api/v1/userinvites/batchcreate
NoFrixionMoneyMoovModelsAuthorisationSettingsMerchantThe NoFrixionMoneyMoovModelsAuthorisationSettingsMerchant entity (list)./api/v1/merchants/{merchantID}/authorisationsettings
NoFrixionMoneyMoovModelsBatchPayoutThe NoFrixionMoneyMoovModelsBatchPayout entity (create, load)./api/v1/payouts/batch
NoFrixionMoneyMoovModelsBeneficiaryGroupPageThe NoFrixionMoneyMoovModelsBeneficiaryGroupPage entity (list)./api/v1/merchants/{merchantID}/beneficiarygroups
NoFrixionMoneyMoovModelsBeneficiaryPageThe NoFrixionMoneyMoovModelsBeneficiaryPage entity (list)./api/v1/beneficiaries
NoFrixionMoneyMoovModelsCardCustomerTokenThe NoFrixionMoneyMoovModelsCardCustomerToken entity (list, load, remove)./api/v1/paymentrequests/card/customertokens/{merchantID}/{customerEmailAddress}
NoFrixionMoneyMoovModelsCurrencyCurrencyInfoThe NoFrixionMoneyMoovModelsCurrencyCurrencyInfo entity (list)./api/v1/currencies
NoFrixionMoneyMoovModelsDirectDebitBatchSubmitThe NoFrixionMoneyMoovModelsDirectDebitBatchSubmit entity (create)./api/v1/paymentrequests/directdebit/batchsubmit
NoFrixionMoneyMoovModelsFxRateThe NoFrixionMoneyMoovModelsFxRate entity (list, load)./api/v1/payouts/fxallheldrates/{source}/{destination}
NoFrixionMoneyMoovModelsIPaymentThe NoFrixionMoneyMoovModelsIPayment entity (create)./api/v1/paymentrequests/payondemand
NoFrixionMoneyMoovModelsMandatesMandateThe NoFrixionMoneyMoovModelsMandatesMandate entity (create, load)./api/v1/mandates
NoFrixionMoneyMoovModelsMerchantThe NoFrixionMoneyMoovModelsMerchant entity (list, load, update)./api/v1/merchants
NoFrixionMoneyMoovModelsMerchantPageThe NoFrixionMoneyMoovModelsMerchantPage entity (list)./api/v1/merchants/paged
NoFrixionMoneyMoovModelsMerchantPayByBankSettingThe NoFrixionMoneyMoovModelsMerchantPayByBankSetting entity (list)./api/v1/merchants/{merchantID}/banksettings
NoFrixionMoneyMoovModelsMerchantTokenThe NoFrixionMoneyMoovModelsMerchantToken entity (create, load, update)./api/v1/tokens
NoFrixionMoneyMoovModelsMerchantTokenPageThe NoFrixionMoneyMoovModelsMerchantTokenPage entity (list)./api/v1/merchants/{merchantID}/tokens
NoFrixionMoneyMoovModelsNoFrixionVersionThe NoFrixionMoneyMoovModelsNoFrixionVersion entity (load)./api/v1/metadata/version
NoFrixionMoneyMoovModelsOpenBankingAccountThe NoFrixionMoneyMoovModelsOpenBankingAccount entity (load)./api/v1/openbanking/accounts/{id}
NoFrixionMoneyMoovModelsOpenBankingConsentThe NoFrixionMoneyMoovModelsOpenBankingConsent entity (create, list, load, remove, update)./api/v1/openbanking/consents
NoFrixionMoneyMoovModelsOpenBankingTransactionThe NoFrixionMoneyMoovModelsOpenBankingTransaction entity (list)./api/v1/openbanking/transactions/{id}/{accountID}
NoFrixionMoneyMoovModelsPaymentThe NoFrixionMoneyMoovModelsPayment entity (create, load, update)./api/v1/paymentrequests
NoFrixionMoneyMoovModelsPaymentAccountMinimalPageThe NoFrixionMoneyMoovModelsPaymentAccountMinimalPage entity (list)./api/v1/accounts/minimal
NoFrixionMoneyMoovModelsPaymentAccountPageThe NoFrixionMoneyMoovModelsPaymentAccountPage entity (list)./api/v1/accounts/paged
NoFrixionMoneyMoovModelsPaymentInitiationThe NoFrixionMoneyMoovModelsPaymentInitiation entity (create)./api/v1/paymentrequests/{id}/pisp
NoFrixionMoneyMoovModelsPaymentRequestEventThe NoFrixionMoneyMoovModelsPaymentRequestEvent entity (list)./api/v1/paymentrequests/{id}/events
NoFrixionMoneyMoovModelsPaymentRequestMetricThe NoFrixionMoneyMoovModelsPaymentRequestMetric entity (load)./api/v1/paymentrequests/metrics
NoFrixionMoneyMoovModelsPaymentRequestMinimalThe NoFrixionMoneyMoovModelsPaymentRequestMinimal entity (list)./api/v1/paymentrequests/{id}/minimal
NoFrixionMoneyMoovModelsPaymentRequestResultThe NoFrixionMoneyMoovModelsPaymentRequestResult entity (list)./api/v1/paymentrequests/{id}/result
NoFrixionMoneyMoovModelsPaymentRequestsMerchantPaymentThe NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment entity (list)./api/v1/paymentrequests/{merchantID}/templates
NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment2The NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment2 entity (load)./api/v1/paymentrequests/{merchantID}/templates/{templateID}
NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment3The NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment3 entity (update)./api/v1/paymentrequests/{merchantID}/templates/{templateID}
NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment4The NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment4 entity (remove)./api/v1/paymentrequests/{merchantID}/templates/{templateID}
NoFrixionMoneyMoovModelsPayoutKeysetPageThe NoFrixionMoneyMoovModelsPayoutKeysetPage entity (list)./api/v1/accounts/{accountID}/payouts/failed
NoFrixionMoneyMoovModelsPayoutMetricThe NoFrixionMoneyMoovModelsPayoutMetric entity (load)./api/v1/payouts/metrics
NoFrixionMoneyMoovModelsPayoutsPayoutsCreateThe NoFrixionMoneyMoovModelsPayoutsPayoutsCreate entity (create)./api/v1/payouts/batchcreate
NoFrixionMoneyMoovModelsPayrunThe NoFrixionMoneyMoovModelsPayrun entity (create, load, update)./api/v1/payruns/{merchantID}
NoFrixionMoneyMoovModelsReportResultThe NoFrixionMoneyMoovModelsReportResult entity (load)./api/v1/reports/{id}/result/{statementNumber}
NoFrixionMoneyMoovModelsRuleThe NoFrixionMoneyMoovModelsRule entity (create, load, update)./api/v1/rules
NoFrixionMoneyMoovModelsTransactionThe NoFrixionMoneyMoovModelsTransaction entity (load)./api/v1/accounts/{accountID}/transactions/{id}
NoFrixionMoneyMoovModelsTransactionPageThe NoFrixionMoneyMoovModelsTransactionPage entity (list, load)./api/v1/accounts/{accountID}/transactions
NoFrixionMoneyMoovModelsUserInviteThe NoFrixionMoneyMoovModelsUserInvite entity (create, load)./api/v1/userinvites
NoFrixionMoneyMoovModelsUserInvitePageThe NoFrixionMoneyMoovModelsUserInvitePage entity (list)./api/v1/merchants/{merchantID}/userinvitespaged
NoFrixionMoneyMoovModelsUserPageThe NoFrixionMoneyMoovModelsUserPage entity (list)./api/v1/user/{merchantID}/userspaged
NoFrixionMoneyMoovModelsWebhookThe NoFrixionMoneyMoovModelsWebhook entity (create, list, load, update)./api/v1/webhooks
OpenBankingThe OpenBanking entity (create, remove)./api/v1/openbanking/account/{accountID}/synchronise
PayeeverificationThe Payeeverification entity (create)./api/v1/openbanking/payeeverification
PaymentRequestThe PaymentRequest entity (create, load, remove, update)./api/v1/paymentrequests/{id}/directdebit
PayoutThe Payout entity (create, load, remove, update)./api/v1/payouts/batch/submit/{id}
PayrunThe Payrun entity (create, remove, update)./api/v1/payruns/{id}/request-authorisation
RejectThe Reject entity (update)./api/v1/payouts/reject/{id}
ReportThe Report entity (update)./api/v1/reports/{id}/initiate
RuleThe Rule entity (remove, update)./api/v1/rules/{id}
SendThe Send entity (create)./api/v1/payouts/send
SendbeneficiaryThe Sendbeneficiary entity (create)./api/v1/payouts/sendbeneficiary
TagThe Tag entity (create, list)./api/v1/merchants/{merchantID}/tags
TokenThe Token entity (create, remove)./api/v1/tokens/authorise/{id}
TransactionThe Transaction entity (create, load, remove)./api/v1/transactions/{id}/tags
UserThe User entity (list, update)./api/v1/merchants/{merchantID}/users
UserInviteThe UserInvite entity (create, remove, update)./api/v1/userinvites/authorise/{id}
VirtualThe Virtual entity (create, update)./api/v1/accounts/{accountID}/virtual
WebhookThe Webhook entity (remove)./api/v1/webhooks/{id}
WhoamiThe Whoami entity (list)./api/v1/metadata/whoami
WhoamitrustedappThe Whoamitrustedapp entity (list)./api/v1/metadata/whoamitrustedapp

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)

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 merchant
merchant, err := client.Merchant(nil).Load(
    map[string]any{"merchant_id": "example_merchant_id"}, nil,
)
if err != nil {
    panic(err)
}
fmt.Println(merchant)

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

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"},
})

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" },
})

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:

  1. Point — resolve the API endpoint from the operation definition.
  2. Spec — build the HTTP specification (URL, method, headers, body).
  3. Request — send the HTTP request.
  4. Response — receive and parse the response.
  5. 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

FeaturePurpose
TestFeatureIn-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.

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.

Get the Voxgig dispatch

Short notes on building SDKs, CLIs, REPLs, and MCPs for API-first teams, plus the occasional Fireside episode pick.

By signing up you agree to our Terms and Conditions.