Account API (V2)

Download OpenAPI specification:Download

Account

Provides methods for Account management and to retrieve account related details including terms, transactions and pending authorizations.

Change Overdraft Limit

Changes the overdraft limit of the specified account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

The request information.

OverdraftLimit
required
integer <int32>

The maximum limit up to which consumer can use or withdraw more money than consumers have in their account up to approved limits.

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/ChangeOverdraftLimit
Request samples
application/json
{
  • "OverdraftLimit": 2000,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Change Terms

Changes the agreement terms of the specified account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

ChangeTermsReq

AgreementCode
required
string [ 0 .. 8 ] characters

Unique identifier of an agreement that is to be applied to an account.

PackageEffectiveDate
required
string <date-time>

The date from which the new agreement package is to be effective.
Format for date must be 'yyyy-MM-ddTHH:mm:ss.fff',
e.g. '2018-05-24T10:27:26.325' represents 24-May-2018 10:27:26.325.

PromotionalCode
string [ 0 .. 10 ] characters

PromotionalCode. Which is associate with Agreement

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/ChangeTerms
Request samples
application/json
{
  • "AgreementCode": "ABCXYZ",
  • "PackageEffectiveDate": "2021-11-19T13:27:32.0266383+05:30",
  • "PromotionalCode": "STUDENT",
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Charge Fee

Debits the relevant fee amount from the specific account, crediting it to the respective partner program charge, holding or buffer account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

ChargeFeeReq

Amount
required
integer <int32>

The amount to be charged for applicable fees of an account. For e.g. Amount for Administration fees.

ReferenceNumber
required
string [ 0 .. 100 ] characters

Unique Reference Number of the Charge to identify particular charge type in transactions.

ClientReferenceNumber
string [ 0 .. 50 ] characters

Unique Reference Number of the Client to identify the particular transaction.

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/ChargeFee
Request samples
application/json
{
  • "Amount": 6937,
  • "ReferenceNumber": "Admin Fees",
  • "ClientReferenceNumber": "test1",
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ChargeReferenceID": 2422647,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Account Only Limits

Retrieves the limits (credit, debit, overdraft, balance etc.) for the specified account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

ListAccountLimitsReq

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/GetAccountOnlyLimits
Request samples
application/json
{
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "DailySpendLimit": 0,
  • "WeeklySpendLimit": 0,
  • "MonthlySpendLimit": 0,
  • "DailySendMoneyLimit": 0,
  • "WeeklySendMoneyLimit": 0,
  • "MonthlySendMoneyLimit": 0,
  • "YearlyTotalSpendLimit": 0,
  • "MaximumAccountBalanceLimit": 0,
  • "DailyWorldPayLimit": 0,
  • "WeeklyWorldPayLimit": 0,
  • "MonthlyWorldPayLimit": 0,
  • "DailyBacsFbacsLimit": 0,
  • "WeeklyBacsFbacsLimit": 0,
  • "MonthlyBacsFbacsLimit": 0,
  • "TotalSpendLimit": 0,
  • "DailyPayPointLoadLimit": 0,
  • "WeeklyPayPointLoadLimit": 0,
  • "MonthlyPayPointLoadLimit": 0,
  • "DailyTransferMoneyLimit": 0,
  • "WeeklyTransferMoneyLimit": 300,
  • "MonthlyTransferMoneyLimit": 500,
  • "DailyAcceptTransferMoneyLimit": 10000,
  • "WeeklyAcceptTransferMoneyLimit": 10000,
  • "MonthlyAcceptTransferMoneyLimit": 10000,
  • "DailyReceiveMoneyLimit": 1300,
  • "WeeklyReceiveMoneyLimit": 1500,
  • "MonthlyReceiveMoneyLimit": 1700,
  • "DailyIBANLimit": 0,
  • "WeeklyIBANLimit": 0,
  • "MonthlyIBANLimit": 0,
  • "OverDraftLimit": 0,
  • "TotalSpendCount": 0,
  • "TotalLoadCount": 0,
  • "WorldpayDailyLoadCount": 0,
  • "WorldpayWeeklyLoadCount": 0,
  • "WorldpayMonthlyLoadCount": 0,
  • "BacsFbcsDailyLoadCount": 0,
  • "BacsFbcsWeeklyLoadCount": 0,
  • "BacsFbcsMonthlyLoadCount": 0,
  • "PayPointDailyLoadCount": 0,
  • "PayPointWeeklyLoadCount": 0,
  • "PayPointMonthlyLoadCount": 0,
  • "SendMoneyDailyCount": 0,
  • "SendMoneyWeeklyCount": 0,
  • "SendMoneyMonthlyCount": 0,
  • "TransferMoneyDailyCount": 7,
  • "TransferMoneyWeeklyCount": 9,
  • "TransferMoneyMonthlyCount": 11,
  • "AcceptTransferMoneyDailyCount": 8,
  • "AcceptTransferMoneyWeeklyCount": 10,
  • "AcceptTransferMoneyMonthlyCount": 12,
  • "ReceiveMoneyDailyCount": 14,
  • "ReceiveMoneyWeeklyCount": 16,
  • "ReceiveMoneyMonthlyCount": 18,
  • "DailyIBANLoadCount": 0,
  • "WeeklyIBANLoadCount": 0,
  • "MonthlyIBANLoadCount": 0,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Balance

Retrieves the latest balance information for the specified account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

GetBalanceReq

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/GetBalance
Request samples
application/json
{
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ISOAccountCurrencyCode": "826",
  • "FriendlyName": "HARDIK DIRECT DEBIT",
  • "AccountStatus": "Live",
  • "AccountBalance": 997037,
  • "DebitHoldBalance": 0,
  • "CreditHoldBalance": 0,
  • "EnvelopeHoldBalance": 50,
  • "AvailableBalance": 996987,
  • "AccountActivatedDate": "0001-01-01T00:00:00",
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Remaining Load Limit

Retrieves the remaining load limit (the remaining funds that can be credited to the account) for the specified account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

GetRemainingLoadLimitReq

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/GetRemainingLoadLimit
Request samples
application/json
{
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "AccountBalance": 997037,
  • "AvailableBalance": 996987,
  • "ISOAccountCurrencyCode": "826",
  • "RemainingLoadLimit": 0,
  • "IsUnlimitedLoadLimit": true,
  • "FirstLoadedDate": "2021-11-12T13:27:31.7204219+05:30",
  • "AllowedLoadTillDate": "2021-11-12T13:27:31.7204219+05:30",
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Specific Account

Retrieves the specified account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

GetSpecificAccountReq

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/GetSpecificAccount
Request samples
application/json
{
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "AccountRes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Specific Terms

Retrieves the agreement terms for the specified account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

GetSpecificTermsReq

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/GetSpecificTerms
Request samples
application/json
{
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "AgreementCode": "MRNJKHUP",
  • "TermName": "TermName",
  • "TermReferenceID": 1,
  • "CurrencyCode": "GBP",
  • "NewCardCharge": 556,
  • "CardReissueCharge": 100,
  • "PinReissueCharge": 100,
  • "LocalATMwithdrawCharge": 0,
  • "LocalATMwithdrawChargePercent": 0,
  • "AbroadATMwithdrawCharge": 0,
  • "AbroadATMwithdrawChargePercent": 0,
  • "LocalPOSCharge": 0,
  • "LocalPOSChargePercent": 0,
  • "AbroadPOSCharge": 0,
  • "AbroadPOSChargePercent": 0,
  • "ApplyLocalPOSChargeAndPercent": false,
  • "ApplyLocalATMwithdrawChargeAndPercent": false,
  • "ApplyAbroadPOSChargeAndPercent": false,
  • "ApplyAbroadATMwithdrawChargeAndPercent": false,
  • "AdditionalCardCharge": 336,
  • "OtherAdditionalCardCharge": 0,
  • "MaxNoOfAdditionalCards": 10,
  • "ATMBalanceCharge": 100,
  • "CancellationCharge": 0,
  • "WithdrawalCharge": 0,
  • "WithdrawalChargePercent": 0,
  • "TransferMoneyCharge": 0,
  • "TransferMoneyChargePercent": 0,
  • "InternalTransferMoneyCharge": 0,
  • "InternalTransferMoneyChargePercent": 0,
  • "YearlyAccountFee": 0,
  • "ATMDailyTransactionSpendLimit": 0,
  • "POSDailyTransactionSpendLimit": 0,
  • "ATMYearlySpendLimit": 0,
  • "POSYearlySpendLimit": 0,
  • "TotalYearlySpendLimit": 0,
  • "MaximumAccountBalanceLimit": 0,
  • "CardLimit": 0,
  • "AdditionalCardMonthlyAccountFee": 0,
  • "MonthlyAccountFee": 0,
  • "DeclinedPOSCharge": 100,
  • "PINchangeAtATMCharges": 100,
  • "DeclinedATMCharge": 100,
  • "ApplyEuropeanPOSChargeAndPercent": false,
  • "ApplyEuropeanATMChargeAndPercent": false,
  • "EuropeanATMCharge": 0,
  • "EuropeanPOSCharge": 0,
  • "EuropeanATMChargePercent": 0,
  • "EuropeanPOSChargePercent": 0,
  • "InactivityFee": 0,
  • "FirstLoadFee": 0,
  • "DailySpendLimit": 0,
  • "WeeklySpendLimit": 0,
  • "MonthlySpendLimit": 0,
  • "TotalLoad": 0,
  • "ATMWeeklySpendLimit": 0,
  • "ATMMonthlySpendLimit": 0,
  • "CashBackDailyLimit": 0,
  • "CashBackWeeklyLimit": 0,
  • "CashBackMonthlyLimit": 0,
  • "CashBackYearlyLimit": 0,
  • "WeeklyPOSLimit": 0,
  • "MonthlyPOSLimit": 0,
  • "DailyBacsFbacsLimit": 0,
  • "WeeklyBacsFbacsLimit": 0,
  • "MonthlyBacsFbacsLimit": 0,
  • "DailyWorldpayLoadCount": 0,
  • "WeeklyWorldpayLoadCount": 0,
  • "MonthlyWorldpayLoadCount": 0,
  • "TotalLoadCount": 0,
  • "TotalSpendCount": 0,
  • "FreeWithdrawalAmount": 0,
  • "ManagementFeeFrequency": 1,
  • "ManagementFeeDay": 0,
  • "EuropeanMoneyConversionChargeInPercentage": 0,
  • "InternationalMoneyConversionChargeInPercentage": 0,
  • "ChargebackFee": 0,
  • "ChargebackFeePercentage": 0,
  • "ApplyChargebackFeeAndPercentage": false,
  • "AdministrationFee": 0,
  • "UnpaidDirectDebitFee": 0,
  • "PaperStatementFee": 0,
  • "SMSChargeFee": 0,
  • "PaypointLoadFee": 0,
  • "PaypointLoadFeePercentage": 0,
  • "ApplyPaypointLoadFeeAndPercentage": false,
  • "SameDayTransferFee": 0,
  • "SameDayTransferFeePercentage": 0,
  • "NextDayTransferFee": 0,
  • "NextDayTransferFeePercentage": 0,
  • "FutureDatedTransferFee": 0,
  • "FutureDatedTransferFeePercentage": 0,
  • "InternationalUrgentFee": 0,
  • "InternationalUrgentFeePercentage": 0,
  • "InternationalRegularFee": 0,
  • "InternationalRegularFeePercentage": 0,
  • "SepaBankTransferFee": 0,
  • "SepaBankTransferFeePercentage": 0,
  • "FasterPaymentTransferFee": 0,
  • "FasterPaymentTransferFeePercentage": 0,
  • "PostOfficeCashWithdrawCharge": 0,
  • "PostOfficeCashWithdrawChargePercentage": 0,
  • "ApplyPostOfficeCashWithdrawChargeAndPercentage": false,
  • "PostOfficeDeclinedCharge": 0,
  • "PostOfficeBalanceEnquiryCharge": 0,
  • "PostOfficeCashWithdrawLimitMetFee": 0,
  • "PostOfficeCashWithdrawQualifyingLimit": 0,
  • "RequestToPayFee": 0,
  • "NewDigitalCardIssueCharge": 1,
  • "DigitalCardReissueCharge": 4,
  • "AdditionalDigitalCardCharge": 5,
  • "OtherAdditionalDigitalCardCharge": 6,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Account Limits

Retrieves the maximum permitted limits (credit, debit, overdraft, balance etc.) for the specified account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

ListAccountLimitsReq

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/ListAccountLimits
Request samples
application/json
{
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "TotalLoadCount": 0,
  • "TotalSpendCount": 0,
  • "TotalSpendLimit": 0,
  • "WeeklySendMoneyLimit": 0,
  • "MonthlySendMoneyLimit": 0,
  • "DailySendMoneyLimit": 0,
  • "CardLimit": 0,
  • "PostOfficeCashWithdrawQualifyingLimit": 0,
  • "PayPointDailyLoadCount": 0,
  • "PayPointWeeklyLoadCount": 0,
  • "PayPointMonthlyLoadCount": 0,
  • "BacsFbcsDailyLoadCount": 0,
  • "BacsFbcsWeeklyLoadCount": 0,
  • "BacsFbcsMonthlyLoadCount": 0,
  • "WorldpayDailyLoadCount": 0,
  • "WorldpayWeeklyLoadCount": 0,
  • "WorldpayMonthlyLoadCount": 0,
  • "ReceiveMoneyDailyCount": 14,
  • "ReceiveMoneyWeeklyCount": 16,
  • "ReceiveMoneyMonthlyCount": 18,
  • "SendMoneyDailyCount": 0,
  • "SendMoneyWeeklyCount": 0,
  • "SendMoneyMonthlyCount": 0,
  • "DailyIBANLimit": 0,
  • "DailyIBANLoadCount": 0,
  • "WeeklyIBANLimit": 0,
  • "WeeklyIBANLoadCount": 0,
  • "MonthlyIBANLimit": 0,
  • "MonthlyIBANLoadCount": 0,
  • "ContactLessPerTxnLimit": 0,
  • "DailySpendLimit": 0,
  • "WeeklySpendLimit": 0,
  • "MonthlySpendLimit": 0,
  • "DailyATMSpendLimit": 0,
  • "WeeklyATMSpendLimit": 0,
  • "MonthlyATMSpendLimit": 0,
  • "YearlyATMSpendLimit": 0,
  • "DailyPOSSpendLimit": 0,
  • "WeeklyPOSSpendLimit": 0,
  • "MonthlyPOSSpendLimit": 0,
  • "YearlyPOSSpendLimit": 0,
  • "YearlyTotalSpendLimit": 0,
  • "MaximumAccountBalanceLimit": 0,
  • "ATMQualifyingLimitLocal": 0,
  • "ATMQualifyingLimitAbroad": 0,
  • "ATMQualifyingLimitEuropean": 0,
  • "POSQualifyingLimitLocal": 0,
  • "POSQualifyingLimitAbroad": 0,
  • "POSQualifyingLimitEuropean": 0,
  • "DailyWorldPayLimit": 0,
  • "WeeklyWorldPayLimit": 0,
  • "MonthlyWorldPayLimit": 0,
  • "DailyCashBackLimit": 0,
  • "WeeklyCashBackLimit": 0,
  • "MonthlyCashBackLimit": 0,
  • "YearlyCashBackLimit": 0,
  • "DailyBacsFbacsLimit": 0,
  • "WeeklyBacsFbacsLimit": 0,
  • "MonthlyBacsFbacsLimit": 0,
  • "DailyPayPointLoadLimit": 0,
  • "WeeklyPayPointLoadLimit": 0,
  • "MonthlyPayPointLoadLimit": 0,
  • "DailyTransferMoneyLimit": 0,
  • "WeeklyTransferMoneyLimit": 300,
  • "MonthlyTransferMoneyLimit": 500,
  • "DailyAcceptTransferMoneyLimit": 1000,
  • "WeeklyAcceptTransferMoneyLimit": 1000,
  • "MonthlyAcceptTransferMoneyLimit": 100,
  • "DailyReceiveMoneyLimit": 1300,
  • "WeeklyReceiveMoneyLimit": 1500,
  • "MonthlyReceiveMoneyLimit": 1700,
  • "DailyECommerceLimit": 0,
  • "WeeklyECommerceLimit": 0,
  • "MonthlyECommerceLimit": 0,
  • "YearlyECommerceLimit": 0,
  • "OverDraftLimit": 0,
  • "MonthlyLocalATMCount": 0,
  • "MonthlyAbroadATMCount": 0,
  • "MonthlyEuropeanATMCount": 0,
  • "TransferMoneyDailyCount": 7,
  • "TransferMoneyWeeklyCount": 9,
  • "TransferMoneyMonthlyCount": 11,
  • "AcceptTransferMoneyDailyCount": 8,
  • "AcceptTransferMoneyWeeklyCount": 10,
  • "AcceptTransferMoneyMonthlyCount": 12,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Account Limits With Spent

Retrieves the maximum permitted limits (credit, debit, overdraft, balance etc.) for the specified account, as well as the respective amounts remaining for those limits.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

ListAccountLimitsReq

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/ListAccountLimitsWithSpent
Request samples
application/json
{
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Limit": {
    },
  • "LimitUsed": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Accounts

Retrieves all primary and secondary accounts for the specified consumer.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

ListAccountsReq

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/ListAccounts
Request samples
application/json
{
  • "ConsumerID": 21,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "AccountResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Pending Authorizations

Retrieves all pending authorizations for the specified account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json
AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/ListPendingAuthorizations
Request samples
application/json
{
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "AuthorizationResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Terms History

Retrieves all historic term agreements that have applied to the specified account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

The request information.

AccountID
required
integer <int32>

Unique identifier of the account.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/ListTermsHistory
Request samples
application/json
{
  • "AccountID": 12345678,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "TermsResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Transactions

Retrieves transactions for the specified account between the dates requested.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

The object req information.

FromDate
required
string <date-time>

From Date is the start date in UTC format for the transactions to be listed.
Format for date must be 'yyyy-MM-ddTHH:mm:ss.fff',
e.g. '2018-05-24T10:27:26.325' represents 24-May-2018 10:27:26.325.

ToDate
required
string <date-time>

To Date is the End date in UTC format up to which transactions to be listed. i.e. Transactions between From Date and To Date will be listed.
Format for date must be 'yyyy-MM-ddTHH:mm:ss.fff',
e.g. '2018-05-24T10:27:26.325' represents 24-May-2018 10:27:26.325.

Reference
string [ 0 .. 150 ] characters

Unique identifier for the transaction.

RowIndex
integer <int32>

RowIndex is the index that indicates the Page number starting from where records should be displayed. If value for RawIndex is not provided, default value will be considered as 1. If RowIndex exceeds the total pages (i.e. Total Pages = Number of Rows in Response / Pagesize), No result will be displayed.

Pagesize
integer <int32>

Pagesize is the number of rows to be displayed per page.If Pagesize is not provided then default value is considered set at scheme settings. Maximum value for Pagesize should not be more than 200.

TransactionAmount
integer <int64>

Search the transaction on Amount

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/ListTransactions
Request samples
application/json
{
  • "FromDate": "2021-11-11T07:57:32.1902007Z",
  • "ToDate": "2021-11-12T07:57:32.1902007Z",
  • "Reference": "",
  • "RowIndex": 1,
  • "Pagesize": 5,
  • "TransactionAmount": 0,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "TotalRows": 259,
  • "TransactionResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Load Consumer Account

Loads (credits) funds to the specified account from the partner's holding or funding account. The amount to be transferred is governed by the terms of the agreement currently applied to the account. The Amount value specified is denoted in minor units of the respective currency.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

The request information.

Amount
required
integer <int32>

The amount to be credited or loaded in an account.

Description
string [ 0 .. 50 ] characters

Description of the transaction.

ReferenceNumber
string [ 0 .. 18 ] characters

Unique Reference Number to identify particular type in transactions.

ClientReferenceNumber
string [ 0 .. 50 ] characters

Unique identifier of the client.

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/LoadConsumerAccount
Request samples
application/json
{
  • "Amount": 6937,
  • "Description": "Admin Fees",
  • "ReferenceNumber": "Reference Number - 1",
  • "ClientReferenceNumber": "Client Reference Number - 1",
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "TransactionReferenceID": 2422647,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Set Account Limits

Sets the permitted limits for the specified account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

SetAccountLimitsReq

DailySpendLimit
integer <int64>

The total amount that can be spent from an account in one day.

WeeklySpendLimit
integer <int64>

The total amount that can be spent from an account in one week.

MonthlySpendLimit
integer <int64>

The total amount that can be spent from an account in one month.

DailyATMSpendLimit
integer <int64>

The total amount that can be withdrawn from an ATM in one day.

WeeklyATMSpendLimit
integer <int64>

The total amount that can be withdrawn from an ATM in one week.

MonthlyATMSpendLimit
integer <int64>

The total amount that can be withdrawn from an ATM in one month.

DailyPOSSpendLimit
integer <int64>

The total amount that can be spent at POS in one day.

WeeklyPOSSpendLimit
integer <int64>

The total amount that can be spent at POS in one week.

MonthlyPOSSpendLimit
integer <int64>

The total amount that can be spent at POS in one month.

CardLimit
integer <int64>

The maximum limit of an amount that can be spent from the card.

DailyCashBackLimit
integer <int64>

The total amount that can be returned back as cashback reward in one day.

WeeklyCashBackLimit
integer <int64>

The total amount that can be returned back as cashback reward in one week.

MonthlyCashBackLimit
integer <int64>

The total amount that can be returned back as cashback reward in one month.

TotalSpendLimit
integer <int64>

The total amount that can be spent from an account.

DailyECommerceLimit
integer <int64>

The spend limit for an E-commerce of an account in one day.

WeeklyECommerceLimit
integer <int64>

The spend limit for an E-commerce of an account in one week.

MonthlyECommerceLimit
integer <int64>

The spend limit for an E-commerce of an account in one month.

MonthlyLocalATMCount
integer <int32>

The total number of withdrawals from a local ATM in one month.

MonthlyAbroadATMCount
integer <int32>

The total number of withdrawals from an abroad ATM in one month.

MonthlyEuropeanATMCount
integer <int32>

The total number of withdrawals from an Europe ATM in one month.

TotalSpendCount
integer <int32>

The total number of debit transactions from an account.

TotalLoadCount
integer <int32>

The total number of credit transactions for an account.

ContactLessPerTxnLimit
integer <int64>

Contactless limit per transaction.

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/SetAccountLimits
Request samples
application/json
{
  • "DailySpendLimit": 0,
  • "WeeklySpendLimit": 0,
  • "MonthlySpendLimit": 0,
  • "DailyATMSpendLimit": 0,
  • "WeeklyATMSpendLimit": 0,
  • "MonthlyATMSpendLimit": 0,
  • "DailyPOSSpendLimit": 0,
  • "WeeklyPOSSpendLimit": 0,
  • "MonthlyPOSSpendLimit": 0,
  • "CardLimit": 0,
  • "DailyCashBackLimit": 0,
  • "WeeklyCashBackLimit": 0,
  • "MonthlyCashBackLimit": 0,
  • "TotalSpendLimit": 0,
  • "DailyECommerceLimit": 0,
  • "WeeklyECommerceLimit": 0,
  • "MonthlyECommerceLimit": 0,
  • "MonthlyLocalATMCount": 0,
  • "MonthlyAbroadATMCount": 0,
  • "MonthlyEuropeanATMCount": 0,
  • "TotalSpendCount": 0,
  • "TotalLoadCount": 0,
  • "ContactLessPerTxnLimit": 80,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Set Friendly Name

Sets a friendly/memorable name for the specified account to permit easier identification.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

The request information.

FriendlyName
required
string [ 1 .. 25 ] characters

Friendly name of an account to identify an account easily from multiple accounts.

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/SetFriendlyName
Request samples
application/json
{
  • "FriendlyName": "pass new friendly name",
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Unload Consumer Account

Unloads (debits) funds from the specified account to the partner's holding or funding account. The amount to be transferred is governed by the terms of the agreement currently applied to the account. The Amount value specified is denoted in minor units of the respective currency.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

The request information.

Amount
required
integer <int32>

The amount to be debited or unloaded from an account.

Description
string [ 0 .. 50 ] characters

Description of the transactions.

ReferenceNumber
string [ 0 .. 18 ] characters

Unique Reference Number to identify particular type in transactions.

ClientReferenceNumber
string [ 0 .. 50 ] characters

Unique identifier of the client.

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/account/UnloadConsumerAccount
Request samples
application/json
{
  • "Amount": 6937,
  • "Description": "Admin Fees",
  • "ReferenceNumber": "Reference Number - 1",
  • "ClientReferenceNumber": "Client Reference Number - 1",
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "TransactionReferenceID": 2422650,
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}
Solaris is the brand name for the regulated entities Contis Financial Services Ltd and UAB „Finansinės paslaugos „Contis“, which are part of the Solaris Group.