This guide provides an overview of users and accounts, two primary resources on the Solaris platform. It covers how to create and manage these resources, as well as their most common statuses and workflows.
- A user is anyone who holds an account or payment card on the Solaris platform. Users are created and managed via the Consumer API .
- An account is an e-money (EMI) account that allows a user to accept and make payments in the UK and EEA without the need for a bank account. EMI accounts come with addressable account numbers, sort codes, BICs, IBANs and Bank IDs. Accounts are managed via the Account API .
- All accounts are created with an associated agreement code which specifies the terms and conditions of the account including fees, charges and limits etc.
Users are created via the Consumer/AddConsumers method, which will create both the consumer and the respective account simultaneously.
When creating a consumer, the
IsSkipKYC parameter determines which KYC journey should be used:
If KYC is to be conducted by Solaris EMI, the partner must pass this parameter as
false. This will initiate the relevant KYC checks synchronously, and there will be a delay before a response from the API as these are run.
If KYC is being undertaken by the partner on behalf of Solaris EMI, then this must be passed as
Accounts can be closed either via the API or by directly requesting the account closure from Solaris.
To successfully action a closure via the API, the account must have:
- An account balance and available balance of zero.
- No pending settlement transactions.
- No currently active sub accounts.
Provided these conditions are met, the Consumer/SetConsumerAsLockout method can be used to close the account. When successfully called:
- The consumer's status will be set to Locked Out .
- The associated account status will be set to Closed .
- Any cards associated with the account will be set to Issuer Cancelled .
Setting a consumer's status to Locked Out cannot be reverted via the API.
- If you are providing customer services directly to your end users and intend to use the API for account closures, you must provide your account closure process and procedures in your Customer Service Policies, which will need to be reviewed and approved by Solaris Partner Services.
- If you intend to close a Card Program, do not use the API to close individual accounts. Card Program closure activities must be handled by Solaris.
Unless a user's status is Active, outbound transfers are not permitted from their account.
|Settable via API
|Live, active user with all relevant functionality permitted.
|Prior to set up being completed. The user's account has not yet been activated.
|Additional information is required for setup to be completed. No transfers or transactions allowed.
|Account has been declined by Solaris, for example due to failure to pass the relevant KYC checks.
|Prior to setup being completed. Additional information may be required or a sign up fee not paid, for example. The user can receive payments into their account while in this status.
|User is locked out and will not be able to login to or access any functionality of the Solaris API.
|The user has been suspended - all user activity is blocked.
- The User status change notification provides a notification when the status of a user changes.
- The User contact update notification can notify you when a user's contact information - mobile number, address or email address has been updated by Solaris.
- The User login block/unblock notification can inform you when a user has been blocked or unblocked from accessing the Solaris platform.
It is not possible to set account statuses via the API.
|The account is active with all functionality permitted.
|Account is temporarily suspended for either investigation or as a status prior to closure.
|The account is in the process of being set up.
|The account is closed. Once set to this status, the account cannot be reopened and the user will not be able to gain access to it.
|The account is under investigation for fraudulent activity. No fund movements into or out of the account are permitted.
|The account has not been used for a pre-determined time - typically 90 days without any transactions (excluding fees), and has been set as dormant to protect any funds in the account.
|The account setup is not yet fully complete. For example, fraud (or KYC if in scope) checks are currently being performed. No transfers or transactions permitted.
- The Account Balance change notification provides a notification when the balance of an account changes.
- The Account status change notification provides details of a change in account status.
- The Authorization notification and Transaction notification provide notifications on authorizations and transactions respectively, and can be used, for example, to build a record of pending transactions for a given account.