Get a list of merchant's payment accounts.
<b>Authorization</b>: End user or Merchant token (IP address whitelisted) is required.
Request
- Base URL: https://api.nofrixion.com
- URL: https://api.nofrixion.com/api/v1/merchants/{merchantID}/accounts
- Auth: API key in header Authorization
Path parameters
The ID of the merchant to get the payment accounts for.
Query parameters
Optional include connected accounts along with payment accounts.
Response
Returns the list of merchant's accounts.
Unique id for the account.
The ID of the merchant that owns the account.
The name of the merchant that owns the account.
Balance of the account.
Balance of the account expressed in the currency’s minor units (e.g. cents, pence).
Total of the payouts that have been submitted for processing.
The balance of the submitted payouts expressed in the currency’s minor units (e.g. cents, pence).
Timestamp when the account was created.
Timestamp when the account was last updated.
Currency of the account in ISO 4217 format
Name for the account
Gets a unique display name for the payment account. Useful for when payment accounts need to be listed.
Gets a summary of the payments account's most important properties.
Is the default account
The current available balance of the account. Calculated by subtracting any submitted payments from the current balance.
The available balance expressed in the currency’s minor units (e.g. cents, pence).
The payment account supplier name. A payment account can be supplied by multiple payment processors.
Indicates if the payment account is an externally connected account. Externally connected account can be used to view account balances and transactions.
The ID of the consent used to connect the external account.
The Icon for external accounts
The bank name for external accounts
The date that the external account will expire
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.
States the status of the Xero bank feed connection, if applicable.
Indicates the number of unsynchronised transactions with Xero
Either the name of the user, merchant token or api key that created the account
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.
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.
Indicates the status of the SEPA Instant payment rail for this account.
For virtual accounts this is the ID of the physical account that the virtual account is linked to.
True if the account is a virtual account.
Changes
No recorded changes to this endpoint across all 2 revisions of this API.