Sign in
Accounts

Creates a new payment account in a different currency, based on an existing payment account.

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

post/api/v1/accounts/{accountID}/{currency}

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/accounts/{accountID}/{currency}
  • Auth: API key in header Authorization

Path parameters

accountIDstring uuid required

The ID of the existing payment account.

currency'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC' required

The currency for the new payment account (must differ from the existing account's currency).

Response

OK

idstring uuid

Unique id for the account.

merchantIDstring uuid

The ID of the merchant that owns the account.

merchantNamestring nullable

The name of the merchant that owns the account.

balancenumber double

Balance of the account.

balanceMinorUnitsinteger

Balance of the account expressed in the currency’s minor units (e.g. cents, pence).

submittedPayoutsBalancenumber double

Total of the payouts that have been submitted for processing.

submittedPayoutsBalanceMinorUnitsinteger

The balance of the submitted payouts expressed in the currency’s minor units (e.g. cents, pence).

insertedstring date-time

Timestamp when the account was created.

lastUpdatedstring date-time

Timestamp when the account was last updated.

currency'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC'

Currency of the account in ISO 4217 format

accountNamestring nullable

Name for the account

displayNamestring nullable

Gets a unique display name for the payment account. Useful for when payment accounts need to be listed.

summarystring nullable

Gets a summary of the payments account's most important properties.

isDefaultboolean

Is the default account

availableBalancenumber double

The current available balance of the account. Calculated by subtracting any submitted payments from the current balance.

availableBalanceMinorUnitsinteger

The available balance expressed in the currency’s minor units (e.g. cents, pence).

accountSupplierName'None' | 'CyberSource' | 'Checkout' | 'Stripe' | 'Modulr' | 'Plaid' | 'Yapily' | 'Nofrixion' | 'Bitcoin' | 'BitcoinTestnet' | 'BankingCircle' | 'BankingCircleAgency' | 'Simulator' | 'Lightning' | 'LightningTestnet' | 'BankingCircleDirectDebit' | 'Technoxander'

The payment account supplier name. A payment account can be supplied by multiple payment processors.

isConnectedAccountboolean

Indicates if the payment account is an externally connected account. Externally connected account can be used to view account balances and transactions.

consentIDstring uuid nullable

The ID of the consent used to connect the external account.

externalAccountIconstring nullable

The Icon for external accounts

bankNamestring nullable

The bank name for external accounts

expiryDatestring date-time nullable

The date that the external account will expire

isTrustAccountboolean

Indicates if the payment account is a trust account. The account name is displayed in the statement instead of the merchant name for trust accounts.

xeroBankFeedConnectionStatus'None' | 'Pending' | 'Active' | 'Inactive' | 'Failed' nullable

States the status of the Xero bank feed connection, if applicable.

xeroBankFeedSyncStatus'None' | 'InProgress' | 'Completed' | 'Failed'
xeroBankFeedLastSyncedAtstring date-time nullable
xeroBankFeedSyncLastFailedAtstring date-time nullable
xeroBankFeedSyncLastFailureReasonstring nullable
xeroUnsynchronisedTransactionsCountinteger nullable

Indicates the number of unsynchronised transactions with Xero

createdByDisplayNamestring nullable

Either the name of the user, merchant token or api key that created the account

defaultPaymentRail'Default' | 'SEPA_CT' | 'SEPA_INST' | 'TARGET2'

Indicates the default payment rail for this account. Normally it will be left as the default value but in some special cases it may be set to indicate payouts from this account should be attempted with a specific payment rail.

isArchivedboolean

Indicates whether the account is archived. Archived accounts are not displayed in the UI. If an account receives a payment it will be automatically unarchived.

supplierSepaInstantStatus'None' | 'Pending' | 'InProgress' | 'Enabled' | 'Disabled' | 'Failed' nullable

Indicates the status of the SEPA Instant payment rail for this account.

physicalAccountIDstring uuid nullable

For virtual accounts this is the ID of the physical account that the virtual account is linked to.

isVirtualboolean

True if the account is a virtual account.

Changes

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