For AI agents: visit https://docs.nofrixion.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
MoneyMoov
GuidesRecipesDocumentation
v1.0

Log InMoneyMoov
Documentation
Log In
v1.0GuidesRecipesDocumentation

Getting Started

  • Sandbox

Authentication

  • Introduction
  • OAuth2 integration
  • Merchant tokens
    • Merchant token permissions
  • User tokens (for testing only)
  • HMAC Trusted Third Party Authentication
  • HMAC Merchant Token Authentication
  • HMAC Merchant Token Authentication

Authorisation

  • API Authorisation
    • Accounts
    • Beneficiaries
    • Mandates (Direct Debit)
    • Merchant
    • Metadata
    • Open Banking
    • Payment Requests
    • Payouts
    • Payruns
    • Reports
    • Rules
    • Tokens
    • Transactions
    • User
    • User Invites
    • Webhooks

Mooving money

  • Sending payments
    • Payout Destinations
    • Managing payouts
    • Generate strong access token
    • Authorising a payout
    • Batch payouts
  • Receiving payments
    • Creating and managing payment requests
    • Accepting payments
    • Merchant initiated card payments
    • Payment request status
    • Payment attempts
    • Managing card payments
    • Refund bank payments
    • Direct Debit
    • Payment Request Callback & Webhook URLs

PAYMEnt accounts

  • Balances and transactions
  • Transaction Synchronisation Guide

Managing users

  • User role permissions
  • User Invitation Process

Webhooks

  • Introduction
  • Create a webhook
  • Receiving webhooks

Troubleshooting

  • Checking API connectivity
  • Testing Authentication
  • Error message format

NoFrixion MoneyMoov API

  • Using the API reference
  • Accounts
    • Get a list of all payment accounts the user has access to.get
    • Creates a new merchant payment account.post
    • Get a paged list of all payment accounts the user has access to for a specific merchant.get
    • Get an account.get
    • Updates an account record.put
    • Get a list of the transactions for a single payment account.get
    • Get a transaction.get
    • Gets a list of all payouts for a specific account.get
    • SANDBOX ONLY. Top-ups a payment account with the amount provided.put
    • Sets the specified account as archived.del
    • Sets the specified account as unarchived / active.put
    • Sends a message to the transaction statement queue to generate a statement with the supplied parameters.post
    • Gets the specified statement from the user's cache.get
    • Gets all active statement generation requests for the user.get
    • Clears the cached user statements for a user.del
    • Exports a list of all payment accounts the user has access to for a specific merchant.get
    • Exports a list of all transactions for a specific account in CSV format.get
    • Get failed payouts for a specific account.get
    • Creates a new virtual account.post
    • Gets a paged list of virtual accounts for a specific account.get
    • Updates a virtual account record.put
    • Get a paged list of all payment accounts minimal the user has access to for a specific merchant.get
    • Creates a new payment account in a different currency, based on an existing payment account.post
  • Beneficiaries
    • Gets a list of all beneficiaries.get
    • Creates a new beneficiary.post
    • Get's a beneficiary by beneficiary ID.get
    • Deletes a beneficiarydel
    • Updates a beneficiary.put
    • Authorises a beneficiary.post
    • Attempts to disable a beneficiary. If successful the beneficiary will be disabled.put
    • Attempts to enable a beneficiary. If successful the beneficiary will be enabled.put
    • Export beneficiaries to CSV.get
    • Creates beneficiaries in batch.post
  • Currencies
    • Gets the supported currencies exposed by the platform.get
  • Mandates
    • Gets a specific mandate's information.get
    • Gets all mandates from a specific merchant with the supplied parameters.get
    • Creates a Direct Debit mandate.post
  • Merchants
    • Gets a list of a merchant's issued API tokens.get
    • Get's a list of merchants the caller has access to.get
    • Get a paged list of all the merchants the caller has access to.get
    • Get's a merchant.get
    • Gets a list of all beneficiaries.get
    • Get's a beneficiary by beneficiary ID.get
    • Gets a list of all beneficiary groups.get
    • Get a list of merchant's payment accounts.get
    • Get an account.get
    • Get all configured webhooks for a merchant.get
    • Gets a list of all payouts for a specific merchant.get
    • Gets all users including invitees for a merchant.get
    • Gets a list of the banks configured for a merchant's pay by bank requests,get
    • Get a list of merchant tagsget
    • Adds a tag to a merchant.post
    • Deletes a tag from a merchantdel
    • Gets a list of transactions for all a merchant's accounts.get
    • Deletes all roles for a user in a merchant.del
    • Gets a list of merchant authorisation settings for a merchantget
    • Suspends a merchantput
    • Exports a list of all beneficiaries.get
    • Exports a list of all payouts for a specific merchant as a CSV file.get
    • Get failed payouts for a specific merchant.get
    • Updates a merchant's details.put
    • Gets a paged list of user invites associated with merchant.get
    • Gets a webhook.get
    • Creates roles in batch for a specific merchant.post
    • Gets a paged list of child merchants for a specified parent merchant.get
  • Metadata
    • Gets the current version of the MoneyMoov API.get
    • Returns the profile of the requesting user.get
    • Returns the name of the merchant that authentication token was issued for.get
    • Returns the name of the merchant that IP address whitelisted merchants token was issued for.get
    • Returns the name of a merchant that signed merchant token request was authenticated for.get
    • Returns the name of the trusted third party application user the request was authenticated for.get
    • Returns an example problem response.get
    • Triggers a webhook with the problem details in the payload.get
  • OpenBanking
    • Creates a consent thats used to initiate an authorisation to a financial institution.post
    • Retrieve a single open banking consent.get
    • Deletes a single open banking consent.del
    • Creates a new authorisation to a financial institution based on a consent that has already been authorised.patch
    • Retrieve all the open banking consents for a single user.get
    • Delete all the open banking consents for a single user.del
    • Retrieves list of accounts from financial institution.get
    • Retrieves transactions from financial institution.get
    • Attempts to synchronise the balance and transactions of a connected account.post
    • Deletes the specified connected account and all associated transactions.del
    • Verifies a payee using VoP or CoP.post
  • PaymentRequests
    • Submit a payment authorisation request to the card gateway.post
    • Submits a request to capture a previously authorised card payment.post
    • Submits a payment request, using a tokenised card, to a payment gateway.post
    • Submits a request to void a card payment.post
    • Submits a request to refund a card payment.post
    • Submits a request to void all payments for a payment request.post
    • Gets the public key to encrypt card details with when submitting an authorisation.get
    • Gets a list of the tokenised cards stored for a single customer.get
    • Gets a list of the tokenised cards stored for a single customer.get
    • Deletes a single card token.del
    • Deletes all the card tokens for a customer.del
    • Deletes all the card tokens for a customer.del
    • Submits a payment initiation request.post
    • This action simulates a payment initiation callback from a bank to authorise a payment in a sandbox environment.put
    • Creates a payment request record.post
    • Gets a list of all payment requests.get
    • Creates a payment request record and processes the payment.post
    • Updates a payment request.put
    • Gets a payment request.get
    • Deletes a payment request, along with its keys and addresses, if there's no payment event associated with it.del
    • Gets a payment request by its order ID.get
    • Gets a minimal representation of a payment request.get
    • Gets payment request metrics of a merchant.get
    • Gets a payment request result.get
    • Gets a payment requests's events.get
    • Submits a Direct Debit payment attempt.post
    • Export a list of all payment requests to a CSV file.get
    • Gets a list of payment request templates for a merchant.get
    • Gets a payment request template for a merchant.get
    • Updates a payment request template for a merchant.put
    • Deletes a payment request template for a merchant.del
    • Gets the PDF receipt for a payment request.get
    • Creates payment requests in batch.post
    • Submits direct debit payments in batch.post
  • Payouts
    • Gets a list of all payout metrics for a specific merchant.get
    • Gets a list of all payouts for a specific merchant.get
    • Creates a new payout.post
    • Gets a single payout.get
    • Deletes a payout record.del
    • Updates a payout record.put
    • Creates payouts.post
    • Submits a payout for processing.post
    • Deletes a list of payout records.del
    • Gets a list of all the payouts contained in a batch.get
    • Creates a new batch payout.post
    • Submits a batch payout for processing.post
    • Attempts to cancel a scheduled payout.put
    • Rejects the authorisation for a payout.put
    • Creates and submits a payout for a trusted caller.post
    • Creates and submits a payout to a pre-authorised beneficiary.post
    • Generates a proof of payment PDF document with the details of a payout.get
    • Exports a list of all payouts for a specific merchant to a CSV file.get
    • Get failed payouts for a specific merchant.get
    • Gets an FX quote.get
    • Gets an FX held rate.get
    • Get all FX held rates.get
  • Payruns
    • Create a new Payrun from a list of invoices.post
    • Gets all payruns for a merchant.get
    • Gets a single payrun.get
    • Updates a payrun.put
    • Deletes a pay run, along with its invoices, if it's in a Draft state.del
    • Submits a payrun for processing.post
    • Request authorisation from authorisers for this payrun.post
    • Rejects a payrun.put
    • Archives a pay run, excluding it from most actions.del
    • Restores an archived pay run, making it retrievable from most actions.put
    • Cancels the schedule of a pay run and delete's all it's payouts.put
  • Reports
    • Initiates the execution of a merchant report.put
    • Attempts to get the aggregated results of report execution. If the report is still in progress an accepted response will be returned.get
  • Rules
    • Creates a new rule for a MoneyMoov payment account.post
    • Gets all the rules for a merchant.get
    • Update an existing rule.put
    • Get a single rule by ID.get
    • Deletes a rule and any associated events.del
    • Gets a list of the events for a single rule.get
    • Disables a rule.put
  • Tokens
    • Creates a new merchant API token.post
    • Authorises a merchant token.post
    • Archives a merchant API token.del
    • Updates an existing merchant token.put
    • Gets the details of a merchant API token.get
  • Transactions
    • Get a list of the transactions for all payment accounts a user has access to.get
    • Get a list of the transactions for a single payment account.get
    • Adds merchant tags to a transaction.post
    • Removes a tag from the transaction using the tag ID.del
    • Generates a proof of payment PDF document with the details of a transaction.get
    • Gets an account's transactions by sequence numberget
    • Exports a list of the transactions for a single payment account to a CSV file.get
    • Gets a transaction by its ID.get
  • User
    • Get the profile for the authenticated user.get
    • Updates a user record and optionally accepts an invite to join a merchant.put
    • Gets a paged list of users.get
  • UserInvites
    • Creates a new user invite and optionally sends the invitee an email with the details.post
    • Gets a user invite by ID.get
    • Deletes user invite.del
    • Resend, or request a resend, of a user invite.put
    • Gets a user invite detailss by ID.get
    • Creates user invites in batch.post
    • Authorises a user invite.post
  • Webhooks
    • Get all configured webhooks for a merchant.get
    • Creates a webhook for the given merchant.post
    • Updates a webhook for the given merchant.put
    • Deletes a webhook.del
Powered by 

Metadata

Metadata objects are useful diagnostic tools when getting started with the MoneyMoov API. It provides endpoints to retrieve:

  • The current API version.
  • The current user .

Updated over 1 year ago


Gets a paged list of child merchants for a specified parent merchant.
Gets the current version of the MoneyMoov API.
Did this page help you?

Updated over 1 year ago


Gets a paged list of child merchants for a specified parent merchant.
Gets the current version of the MoneyMoov API.
Did this page help you?