Sign in
Merchants

Updates a merchant's details.

<b>Authorization</b>: End user token is required.

<b>User permissions required</b>: CanUpdateMerchant

put/api/v1/merchants/{merchantID}

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/merchants/{merchantID}
  • Auth: API key in header Authorization

Path parameters

merchantIDstring uuid required

The ID of the merchant to update.

Request body

shortNamestring nullable
paymentAccountLimitinteger nullable
logoUrlPngstring nullable
logoUrlSvgstring nullable
notesstring nullable

Response

Returns the updated merchant.

idstring uuid

Unique ID for the merchant.

namestring nullable

The registered business name of the merchant.

companyIDstring uuid nullable

The Company ID recorded in the Compliance system.

merchantCategoryCodestring nullable

The industry code that represents the merchant's primary trading activity.

shortNamestring nullable

A URL friendly shortish name for the merchant. Principal purpose is to use in the hosted payment page URL.

tradingNamestring nullable

An optional trading name. If not set the Name field will be used .

paymentAccountLimitinteger

The maximum number of payment accounts that can be created for the Merchant. To increase the limit contact support.

insertedstring date-time

Timestamp the merchant was added to MoneyMoov.

jurisdiction'IE' | 'UK' | 'EU'

The jurisdiction the merchant entity is incorporated or established in.

hostedPayVersioninteger

The version of the hosted payment page to use with the merchant.

webHookLimitinteger

The maximum number of web hooks that can be created for the Merchant. To increase the limit contact support.

displayQrOnHostedPayboolean

Indicates if a QR Code containing the payment link should be displayed on the hosted payment page.

supportedPaymentMethodsListstring[] nullable

The payment methods that are configured and supported for this merchant.

yourRoleNamestring nullable

The name of the role for the identity that loaded the merchant record.

logoUrlPngstring nullable

The CDN URL of the merchant's logo in PNG format.

logoUrlSvgstring nullable

The CDN URL of the merchant's logo in SVG format.

notesstring nullable

The notes field is an optional free text field that can be used to store any additional information about the merchant.

isBlockedboolean

The merchant is blocked from making payments (payouts).

isExitedboolean

The merchant has formally terminated their relationship and is no longer a customer.

isSuspendedboolean

The merchant has temporarily suspended their own account. This is a merchant-initiated action to temporarily pause services.

suspensionReasonstring nullable

The reason for the suspension, provided by the merchant. This should provide a clear explanation as to why the account was suspended.

timeZoneIdstring nullable

The IANA (Internet Assigned Numbers Authority) time zone identifier of the merchant. For example, "Europe/Dublin" or "America/New_York". This is used to ensure that timestamps and events are displayed and processed in the merchant's local time.

accountCurrenciesstring[] nullable

The list of currencies that the merchant has accounts for.

canHaveTrustAccountsboolean

Trust accounts are a special type of account that allow the account name to be trusted for use in statements and verification of payee checks.

cardPaymentProcessorstring nullable

Name of the card payment processor. Can be "Checkout", "Stripe" or none.

Changes

No recorded changes to this endpoint across all 2 revisions of this API.