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
| Language | Package | Install |
|---|---|---|
| TypeScript | @voxgig-sdk/nofrixion | publish pending — install from git tag |
| Python | 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 |
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
| Surface | Path |
|---|---|
| SDK (TypeScript, Python, Golang, Ruby) | ts/ py/ go/ rb/ |
Entities
The API exposes 81 entities:
| Entity | Description | API path |
|---|---|---|
| Account | The Account entity (create, list, load, remove, update). | /api/v1/accounts/{accountID}/{currency} |
| Beneficiary | The Beneficiary entity (create, load, remove, update). | /api/v1/beneficiaries/authorise/{id} |
| Cancel | The Cancel entity (update). | /api/v1/payouts/cancel/{id} |
| Disable | The Disable entity (update). | /api/v1/beneficiaries/disable/{id} |
| Enable | The Enable entity (update). | /api/v1/beneficiaries/enable/{id} |
| Merchant | The Merchant entity (load, remove, update). | /api/v1/merchants/{merchantID}/payouts/export |
| Metadata | The Metadata entity (load). | /api/v1/metadata/problemnotification |
| NoFrixionBizBizModelsPagingMerchantDirectDebitMandatePage | The NoFrixionBizBizModelsPagingMerchantDirectDebitMandatePage entity (list). | /api/v1/mandates |
| NoFrixionBizBizModelsPagingPaymentRequestPage | The NoFrixionBizBizModelsPagingPaymentRequestPage entity (list). | /api/v1/paymentrequests |
| NoFrixionBizBizModelsPagingPayoutPage | The NoFrixionBizBizModelsPagingPayoutPage entity (list). | /api/v1/payouts |
| NoFrixionBizBizModelsPagingPayrunPage | The NoFrixionBizBizModelsPagingPayrunPage entity (list). | /api/v1/payruns |
| NoFrixionBizBizModelsPagingRuleEventsPage | The NoFrixionBizBizModelsPagingRuleEventsPage entity (list). | /api/v1/rules/{id}/events |
| NoFrixionBizBizModelsPagingRulesPage | The NoFrixionBizBizModelsPagingRulesPage entity (list). | /api/v1/rules |
| NoFrixionBizBizModelsPaymentsCardPayment | The NoFrixionBizBizModelsPaymentsCardPayment entity (create). | /api/v1/paymentrequests/{id}/card/refund/{partialRefundAmount} |
| NoFrixionBizBizModelsPaymentsCardPublicKey | The NoFrixionBizBizModelsPaymentsCardPublicKey entity (load). | /api/v1/paymentrequests/{id}/card/publickey |
| NoFrixionMoneyMoovApiFeaturesBeneficiariesBeneficiaries | The NoFrixionMoneyMoovApiFeaturesBeneficiariesBeneficiaries entity (create). | /api/v1/beneficiaries/batchcreate |
| NoFrixionMoneyMoovApiFeaturesPaymentRequestsPayment | The NoFrixionMoneyMoovApiFeaturesPaymentRequestsPayment entity (create). | /api/v1/paymentrequests/batchcreate |
| NoFrixionMoneyMoovApiFeaturesPermissionsRolesCreate | The NoFrixionMoneyMoovApiFeaturesPermissionsRolesCreate entity (create). | /api/v1/merchants/{merchantID}/roles/batchcreate |
| NoFrixionMoneyMoovApiFeaturesUserInvitesCreate | The NoFrixionMoneyMoovApiFeaturesUserInvitesCreate entity (create). | /api/v1/userinvites/batchcreate |
| NoFrixionMoneyMoovModelsAuthorisationSettingsMerchant | The NoFrixionMoneyMoovModelsAuthorisationSettingsMerchant entity (list). | /api/v1/merchants/{merchantID}/authorisationsettings |
| NoFrixionMoneyMoovModelsBatchPayout | The NoFrixionMoneyMoovModelsBatchPayout entity (create, load). | /api/v1/payouts/batch |
| NoFrixionMoneyMoovModelsBeneficiaryGroupPage | The NoFrixionMoneyMoovModelsBeneficiaryGroupPage entity (list). | /api/v1/merchants/{merchantID}/beneficiarygroups |
| NoFrixionMoneyMoovModelsBeneficiaryPage | The NoFrixionMoneyMoovModelsBeneficiaryPage entity (list). | /api/v1/beneficiaries |
| NoFrixionMoneyMoovModelsCardCustomerToken | The NoFrixionMoneyMoovModelsCardCustomerToken entity (list, load, remove). | /api/v1/paymentrequests/card/customertokens/{merchantID}/{customerEmailAddress} |
| NoFrixionMoneyMoovModelsCurrencyCurrencyInfo | The NoFrixionMoneyMoovModelsCurrencyCurrencyInfo entity (list). | /api/v1/currencies |
| NoFrixionMoneyMoovModelsDirectDebitBatchSubmit | The NoFrixionMoneyMoovModelsDirectDebitBatchSubmit entity (create). | /api/v1/paymentrequests/directdebit/batchsubmit |
| NoFrixionMoneyMoovModelsFxRate | The NoFrixionMoneyMoovModelsFxRate entity (list, load). | /api/v1/payouts/fxallheldrates/{source}/{destination} |
| NoFrixionMoneyMoovModelsIPayment | The NoFrixionMoneyMoovModelsIPayment entity (create). | /api/v1/paymentrequests/payondemand |
| NoFrixionMoneyMoovModelsMandatesMandate | The NoFrixionMoneyMoovModelsMandatesMandate entity (create, load). | /api/v1/mandates |
| NoFrixionMoneyMoovModelsMerchant | The NoFrixionMoneyMoovModelsMerchant entity (list, load, update). | /api/v1/merchants |
| NoFrixionMoneyMoovModelsMerchantPage | The NoFrixionMoneyMoovModelsMerchantPage entity (list). | /api/v1/merchants/paged |
| NoFrixionMoneyMoovModelsMerchantPayByBankSetting | The NoFrixionMoneyMoovModelsMerchantPayByBankSetting entity (list). | /api/v1/merchants/{merchantID}/banksettings |
| NoFrixionMoneyMoovModelsMerchantToken | The NoFrixionMoneyMoovModelsMerchantToken entity (create, load, update). | /api/v1/tokens |
| NoFrixionMoneyMoovModelsMerchantTokenPage | The NoFrixionMoneyMoovModelsMerchantTokenPage entity (list). | /api/v1/merchants/{merchantID}/tokens |
| NoFrixionMoneyMoovModelsNoFrixionVersion | The NoFrixionMoneyMoovModelsNoFrixionVersion entity (load). | /api/v1/metadata/version |
| NoFrixionMoneyMoovModelsOpenBankingAccount | The NoFrixionMoneyMoovModelsOpenBankingAccount entity (load). | /api/v1/openbanking/accounts/{id} |
| NoFrixionMoneyMoovModelsOpenBankingConsent | The NoFrixionMoneyMoovModelsOpenBankingConsent entity (create, list, load, remove, update). | /api/v1/openbanking/consents |
| NoFrixionMoneyMoovModelsOpenBankingTransaction | The NoFrixionMoneyMoovModelsOpenBankingTransaction entity (list). | /api/v1/openbanking/transactions/{id}/{accountID} |
| NoFrixionMoneyMoovModelsPayment | The NoFrixionMoneyMoovModelsPayment entity (create, load, update). | /api/v1/paymentrequests |
| NoFrixionMoneyMoovModelsPaymentAccountMinimalPage | The NoFrixionMoneyMoovModelsPaymentAccountMinimalPage entity (list). | /api/v1/accounts/minimal |
| NoFrixionMoneyMoovModelsPaymentAccountPage | The NoFrixionMoneyMoovModelsPaymentAccountPage entity (list). | /api/v1/accounts/paged |
| NoFrixionMoneyMoovModelsPaymentInitiation | The NoFrixionMoneyMoovModelsPaymentInitiation entity (create). | /api/v1/paymentrequests/{id}/pisp |
| NoFrixionMoneyMoovModelsPaymentRequestEvent | The NoFrixionMoneyMoovModelsPaymentRequestEvent entity (list). | /api/v1/paymentrequests/{id}/events |
| NoFrixionMoneyMoovModelsPaymentRequestMetric | The NoFrixionMoneyMoovModelsPaymentRequestMetric entity (load). | /api/v1/paymentrequests/metrics |
| NoFrixionMoneyMoovModelsPaymentRequestMinimal | The NoFrixionMoneyMoovModelsPaymentRequestMinimal entity (list). | /api/v1/paymentrequests/{id}/minimal |
| NoFrixionMoneyMoovModelsPaymentRequestResult | The NoFrixionMoneyMoovModelsPaymentRequestResult entity (list). | /api/v1/paymentrequests/{id}/result |
| NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment | The NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment entity (list). | /api/v1/paymentrequests/{merchantID}/templates |
| NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment2 | The NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment2 entity (load). | /api/v1/paymentrequests/{merchantID}/templates/{templateID} |
| NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment3 | The NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment3 entity (update). | /api/v1/paymentrequests/{merchantID}/templates/{templateID} |
| NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment4 | The NoFrixionMoneyMoovModelsPaymentRequestsMerchantPayment4 entity (remove). | /api/v1/paymentrequests/{merchantID}/templates/{templateID} |
| NoFrixionMoneyMoovModelsPayoutKeysetPage | The NoFrixionMoneyMoovModelsPayoutKeysetPage entity (list). | /api/v1/accounts/{accountID}/payouts/failed |
| NoFrixionMoneyMoovModelsPayoutMetric | The NoFrixionMoneyMoovModelsPayoutMetric entity (load). | /api/v1/payouts/metrics |
| NoFrixionMoneyMoovModelsPayoutsPayoutsCreate | The NoFrixionMoneyMoovModelsPayoutsPayoutsCreate entity (create). | /api/v1/payouts/batchcreate |
| NoFrixionMoneyMoovModelsPayrun | The NoFrixionMoneyMoovModelsPayrun entity (create, load, update). | /api/v1/payruns/{merchantID} |
| NoFrixionMoneyMoovModelsReportResult | The NoFrixionMoneyMoovModelsReportResult entity (load). | /api/v1/reports/{id}/result/{statementNumber} |
| NoFrixionMoneyMoovModelsRule | The NoFrixionMoneyMoovModelsRule entity (create, load, update). | /api/v1/rules |
| NoFrixionMoneyMoovModelsTransaction | The NoFrixionMoneyMoovModelsTransaction entity (load). | /api/v1/accounts/{accountID}/transactions/{id} |
| NoFrixionMoneyMoovModelsTransactionPage | The NoFrixionMoneyMoovModelsTransactionPage entity (list, load). | /api/v1/accounts/{accountID}/transactions |
| NoFrixionMoneyMoovModelsUserInvite | The NoFrixionMoneyMoovModelsUserInvite entity (create, load). | /api/v1/userinvites |
| NoFrixionMoneyMoovModelsUserInvitePage | The NoFrixionMoneyMoovModelsUserInvitePage entity (list). | /api/v1/merchants/{merchantID}/userinvitespaged |
| NoFrixionMoneyMoovModelsUserPage | The NoFrixionMoneyMoovModelsUserPage entity (list). | /api/v1/user/{merchantID}/userspaged |
| NoFrixionMoneyMoovModelsWebhook | The NoFrixionMoneyMoovModelsWebhook entity (create, list, load, update). | /api/v1/webhooks |
| OpenBanking | The OpenBanking entity (create, remove). | /api/v1/openbanking/account/{accountID}/synchronise |
| Payeeverification | The Payeeverification entity (create). | /api/v1/openbanking/payeeverification |
| PaymentRequest | The PaymentRequest entity (create, load, remove, update). | /api/v1/paymentrequests/{id}/directdebit |
| Payout | The Payout entity (create, load, remove, update). | /api/v1/payouts/batch/submit/{id} |
| Payrun | The Payrun entity (create, remove, update). | /api/v1/payruns/{id}/request-authorisation |
| Reject | The Reject entity (update). | /api/v1/payouts/reject/{id} |
| Report | The Report entity (update). | /api/v1/reports/{id}/initiate |
| Rule | The Rule entity (remove, update). | /api/v1/rules/{id} |
| Send | The Send entity (create). | /api/v1/payouts/send |
| Sendbeneficiary | The Sendbeneficiary entity (create). | /api/v1/payouts/sendbeneficiary |
| 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, load, remove). | /api/v1/transactions/{id}/tags |
| User | The User entity (list, update). | /api/v1/merchants/{merchantID}/users |
| UserInvite | The UserInvite entity (create, remove, update). | /api/v1/userinvites/authorise/{id} |
| Virtual | The Virtual entity (create, update). | /api/v1/accounts/{accountID}/virtual |
| Webhook | The Webhook entity (remove). | /api/v1/webhooks/{id} |
| Whoami | The Whoami entity (list). | /api/v1/metadata/whoami |
| Whoamitrustedapp | The 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:
- 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.