Transfer API (V2)

Download OpenAPI specification:Download

Transfer

Provides methods to facilitate fund transfers, including management of recipients.

Add Recipient

AddRecipient method is used to add details of recipient and link (UK or International) recipient bank account to Solaris consumer account for fund transfer.

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.

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

BankName
string [ 0 .. 100 ] characters

The name of the recipient bank, whose account to be linked with Solaris consumer account.

BankAddress
string [ 0 .. 200 ] characters

The address of the recipient bank.

BankAccountNumber
string [ 0 .. 35 ] characters

The account number for recipient bank account. If BankAccountType is (01) i.e. UK, then it should be of eight characters and for other BankAccountTypes, it can be of eight to thirty-five characters.

BankSortCode
string [ 0 .. 6 ] characters

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

BankAccountHolderName
required
string [ 0 .. 50 ] characters

The name of a recipient bank account holder.

ReferenceNumber
string [ 0 .. 18 ] characters

The unique roll number of a building society, made up of letters and numbers. An optional field that supports maximum 18 characters.

FriendlyName
string [ 0 .. 50 ] characters

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

BankAccountTypeID
required
integer <int32> [ 1 .. 32767 ]

Look up value that identifies the type of bank account whether UK or International bank account.

1 = UK
2 = International
3 = SEPA

Enum: "None" "UK" "International" "SEPA"
RecipientISOCountryCode
string [ 0 .. 3 ] characters

Three-digit ISO country code of recipient bank account.

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 recipient bank.

NCC
string [ 0 .. 12 ] characters

National Clearing Code used for international payments. It is required for money transfer to bank accounts that do not have international bank account. NCC is mostly used for the payments outside the EU region.

BankAccountHolderAddress
string [ 0 .. 200 ] characters

The address of the recipient bank account holder. It is required to provide AccountHolderAddress if BankAccountType code is 02 (i.e. International).

RecipientEmailAddress
string [ 0 .. 100 ] characters

Email address of recipient bank account holder.

BeneficiaryCity
string [ 0 .. 50 ] characters

City of recipient. This field is required for international bank payment with currency cloud.

BeneficiaryState
string [ 0 .. 50 ] characters

State of recipient. This field is required for international bank payment with currency cloud.

BeneficiaryPostCode
string [ 0 .. 12 ] characters

PostCode of recipient. This field is required for international bank payment with currency cloud.

ToCurrencyCode
string

Currency code in which amount should be converted.
Its value should be 3 char currency code.
i.e. For United Kingdom currency code is GBP.
For Euro currency code is EUR.
For US Dollar currency code is USD.

BankEntityTypeID
integer <int32>

Entity Type of the Bank. (i.e. Individual=1 OR Company=2 OR Both=3).

CLABE
string [ 0 .. 18 ] characters

CLABE must be used instead of account number or IBAN when sending payments in any currency to Mexico. CLABE is the banking standard for the numbering of bank accounts in Mexico (equivalent to the Account Number in other jurisdictions)

ABA
string [ 0 .. 9 ] characters

American banks are identified by a 9 digit ABA number, also known as ‘Routing Number’. The ABA should be valid for FedWIRE payments. Some ABA values are only valid for FedACH payments. Payments to FedACH-only ABAs will fail. The ABA is required for all payments to the USA.

IFSC
string [ 0 .. 11 ] characters

IFSC stands for Indian Financial System Code. It is a 11-digit alpha-numeric code that uniquely identifies a bank branch. (The equivalent of a UK Sort Code or US ABA number).

BsbCode
string [ 0 .. 6 ] characters

The BSB code is a six-digit number used to identify the individual branch of an Australian financial institution (Equivalent to a UK sort code or US ABA number).

BankCode
string [ 0 .. 3 ] characters

Also known as ‘(Financial) Institution Number’. The Bank Code indicates which bank the payment should be sent to.

BranchCode
string [ 0 .. 5 ] characters

Also known as ‘Transit (Branch) Number’. The Branch Code indicates which branch at the bank the payment should be sent to.

CNAPS
string [ 0 .. 12 ] characters

The CNAPS code is the domestic bank routing number used in China (equivalent to a UK sort code or US ABA number). CNAPS is only required when sending CNY payments to China. CNY payments to any other jurisdiction do not require the CNAPS code.

TransferTypeID
integer <int32>

Lookup value that identifies the type of bank transfer like BACS, CHAPS, Faster Payments etc.

15 = SEPA Payment
16 = Same day CHAPS Payment
17 = Next day Payment
18 = Same day Faster Payment
19 = BACS Payment
20 = International urgent
21 = Automated International regular
22 = Automated International urgent
23 = SEPA Instant Payment

Enum: "None" "BankTransfer_BACS" "SameDayTransfer_CHAPS" "Cheque" "International_Regular" "International_Urgent" "Next_day" "Bank_Recall" "Faster_Payment_Danske_bank" "New_BankTransfer_BACS_FutureDatedUpto3Days" "New_SameDayTransfer_CHAPS" "New_International_Regular" "New_International_Urgent" "New_NextDayTransfer" "New_FasterPayment" "SEPA" "ClearBank_CHAPS" "ClearBank_NextDayTransfer" "ClearBank_FasterPayment" "ClearBank_BankTransfer_BACS_FutureDatedUpto3Days" "International_Urgent_CurrencyCloud" "International_Regular_CC_Automated" "International_Urgent_CC_Automated" "SEPA_Instant_Payments" "MCCYPayment" "Internal_Transfer" "ThirdParty_Transfer"
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/Transfer/AddRecipient
Request samples
application/json
{
  • "ConsumerID": 55320,
  • "BankName": "AddBankC1",
  • "BankAddress": "United Kingdom",
  • "BankAccountNumber": "00709983",
  • "BankSortCode": "623053",
  • "BankAccountHolderName": "Bank AccHolderC1",
  • "ReferenceNumber": "AddBankRefC1",
  • "FriendlyName": "BankNameC1",
  • "BankAccountTypeID": 1,
  • "RecipientISOCountryCode": "826",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "NCC": "",
  • "BankAccountHolderAddress": "ACH AddressC1",
  • "RecipientEmailAddress": "abc.xyz@ol.com",
  • "BeneficiaryCity": "Bruxelles",
  • "BeneficiaryState": "Bruxelles",
  • "BeneficiaryPostCode": "1000",
  • "ToCurrencyCode": "USD",
  • "BankEntityTypeID": 1,
  • "CLABE": "032180000118359719",
  • "ABA": "091000022",
  • "IFSC": "HDFC0003779",
  • "BsbCode": "012002",
  • "BankCode": "001",
  • "BranchCode": "91108",
  • "CNAPS": "104100000004",
  • "TransferTypeID": 1,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "RecipientBankReferenceID": 19181,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Bank Transfer

BankTransfer method is used to transfer the fund from Solaris consumer account to recipient account. It debits the specified amount from Solaris consumer account and credits the amount to recipient bank account if transfer amount is available in consumer 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

Bank transfer request detail

PayerIDCode
string [ 0 .. 3 ] characters

A legal document that verifies the identity of the payer. Required documentation will vary depending on the nationality or registered address of the payer.
Its value should be 0-3 char code. For Incorporation Number (ICN).
For Drivers License (DVL).
For Social Security Number (SSN).
For Green Card (GRC).

PayerIDCodeValue
string [ 0 .. 100 ] characters

An unique reference code for the identification document, such as a passport number.

PaymentPurposeCode
string [ 0 .. 25 ] characters

Payment purpose code which will identify for which purpose spicific payment has been done.
Its value should be 0-25 char payment purpose code. This Payment puspose code required only in below mentioned 4 countries.
For China (SWIFT CNY payments only).
For India (local INR payments to India only).
For Malaysia (local MYR payments to Malaysia only).
For United Arab Emirates (SWIFT payments in all currencies).

Description
string [ 0 .. 200 ] characters

Description of the bank transfer from Solaris consumer account to recipient account.

RecipientBankReferenceID
required
integer <int32>

Unique identifier of the recipient bank.

ClientReferenceNumber
string

Unique reference number provided by client to track the transfer transaction.

ReferenceNumber
string

Unique reference number of the transaction.

TransferTypeID
required
integer <int32> [ 1 .. 32767 ]

Lookup value that identifies the type of bank transfer like BACS, CHAPS, Faster Payments etc.

15 = SEPA Payment
16 = Same day CHAPS Payment
17 = Next day Payment
18 = Same day Faster Payment
19 = BACS Payment
20 = International urgent
21 = Automated International regular
22 = Automated International urgent
23 = SEPA Instant Payment

Enum: "None" "BankTransfer_BACS" "SameDayTransfer_CHAPS" "Cheque" "International_Regular" "International_Urgent" "Next_day" "Bank_Recall" "Faster_Payment_Danske_bank" "New_BankTransfer_BACS_FutureDatedUpto3Days" "New_SameDayTransfer_CHAPS" "New_International_Regular" "New_International_Urgent" "New_NextDayTransfer" "New_FasterPayment" "SEPA" "ClearBank_CHAPS" "ClearBank_NextDayTransfer" "ClearBank_FasterPayment" "ClearBank_BankTransfer_BACS_FutureDatedUpto3Days" "International_Urgent_CurrencyCloud" "International_Regular_CC_Automated" "International_Urgent_CC_Automated" "SEPA_Instant_Payments" "MCCYPayment" "Internal_Transfer" "ThirdParty_Transfer"
Amount
required
integer <int64>

The amount that is to be transferred to recipient account.

RecipientISOCountryCode
string

Three-digit ISO country code that identfies the country of recipient bank account.

DayTimeContactNumber
string

The daytime contact number of the recipient bank.

RequesterConsumerID
integer <int32>

Unique identifier of a consumer if authorisation is required for fund transfer.

ToCurrencyCode
string [ 0 .. 3 ] characters

Currency code in which amount should be converted.
Its value should be 3 char currency code.
i.e. For United Kingdom currency code is GBP.
For Euro currency code is EUR.
For US Dollar currency code is USD.

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/Transfer/BankTransfer
Request samples
application/json
{
  • "PayerIDCode": "ICN",
  • "PayerIDCodeValue": "U72200MH2009PLC123456",
  • "PaymentPurposeCode": "CCTFDR",
  • "Description": "DESC123",
  • "RecipientBankReferenceID": 16087,
  • "ClientReferenceNumber": "CREF123",
  • "ReferenceNumber": "REF123",
  • "TransferTypeID": 1,
  • "Amount": 1200,
  • "RecipientISOCountryCode": "826",
  • "DayTimeContactNumber": "9342342432423",
  • "RequesterConsumerID": 0,
  • "ToCurrencyCode": "EUR",
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "BankTransferReferenceID": 42596,
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Cancel Bank Transfer Change of Mind

CancelBankTransferChangeOfMind method is used to cancel the bank transfer request. The request can only be cancelled if the Cut-off time has not reached for export file. Cut-off time will be different for each bank transfer as per the provider. This is valid for UK accounts in GBP 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 object req information.

BankTransferReferenceID
required
integer <int32>

Unique identifier of the withdrawal request.

Remarks
string [ 0 .. 250 ] characters

The note about cancellation of the withdrawal request.

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/Transfer/CancelBankTransferChangeOfMind
Request samples
application/json
{
  • "BankTransferReferenceID": 42596,
  • "Remarks": "cancel transfer",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Delete Recipient

DeleteRecipient method is used to unlink the recipient account which is linked with Solaris consumer account and stops further money transfer.

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.

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

RecipientBankReferenceID
required
integer <int32>

Unique identifier of the recipient 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/Transfer/DeleteRecipient
Request samples
application/json
{
  • "ConsumerID": 55320,
  • "RecipientBankReferenceID": 19181,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Bank Details by IBAN

This method uses is to validate the IBAN and get other details if that IBAN is valid. It is a chargeable method.

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.

IBAN
required
string [ 0 .. 34 ] characters

Unique, 34-alphanumeric character code that identifies banks globally. IBAN consists of country code, two-check digits, and a alpha-numeric pattern that includes the domestic bank account number, branch identifier, and potential routing information.

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/Transfer/GetBankDetailsByIBAN
Request samples
application/json
{
  • "IBAN": "FI1410093000123458",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "IBAN": "FI1410093000123458",
  • "BIC": "NDEAFIHHXXX",
  • "BankName": "NORDEA",
  • "BankAddress": "ALEKSANTERINKATU 36",
  • "BankCity": "HELSINKI",
  • "BankState": "",
  • "BankZip": "00100",
  • "Country": "Finland",
  • "ISOCountryCode": "246",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Currency Rate

Get foreign exchange rate information for multiple currency pairs.

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.

FromAmount
number <double>

Currency amount to be converted.
NOTE : Either FromAmount or ToAmount must be provide.

ToAmount
number <double>

Converted currency amount.
NOTE : Either FromAmount or ToAmount must be provide.

FromCurrencyCode
required
string [ 0 .. 3 ] characters

Currency code of to be converted amount.
Its value should be 3 char currency code.
i.e. For United Kingdom currency code is GBP.
For Euro currency code is EUR.
For US Dollar currency code is USD.

ToCurrencyCode
required
string [ 0 .. 3 ] characters

Currency code in which amount should be converted.
Its value should be 3 char currency code.
i.e. For United Kingdom currency code is GBP.
For Euro currency code is EUR.
For US Dollar currency code is USD.

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/Transfer/GetCurrencyRate
Request samples
application/json
{
  • "FromAmount": 100,
  • "ToAmount": 110,
  • "FromCurrencyCode": "GBP",
  • "ToCurrencyCode": "EUR",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ClientBuyAmount": 100,
  • "ClientSellAmount": 120,
  • "ClientRate": 10,
  • "CoreRate": 10,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Specific Recipient

GetSpecificRecipient method is used to get the details of the UK or international recipient bank account linked with the Solaris consumer account provided in API request.

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
ConsumerID
required
integer <int32>

Unique identifier of the consumer.

RecipientBankReferenceID
required
integer <int32>

Unique identifier of the recipient 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/Transfer/GetSpecificRecipient
Request samples
application/json
{
  • "ConsumerID": 55320,
  • "RecipientBankReferenceID": 19181,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "RecipientBankDetail": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List International Bank Account Setup Countries

ListInternationalBankAccountSetupCountries method returns the list of Country Name, ISO country code and BankAccountSetupGroupValue. Response of this method helps to indicate that different international countries accepts what combination of details to identify a Bank account.
BankAccountSetupGroupValue tells different country wise BankAccountSetup established depending upon the Groupvalue.
Valid TransferTypeID = 20, 21, 22

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

BankAccountSetupCountriesReq

ISOCountryCode
string [ 0 .. 3 ] characters

Three-digit ISO country code of recipient bank account.

TransferTypeID
integer <int32>

Lookup value that identifies the type of bank transfer like BACS, CHAPS, Faster Payments etc.

15 = SEPA Payment
16 = Same day CHAPS Payment
17 = Next day Payment
18 = Same day Faster Payment
19 = BACS Payment
20 = International urgent
21 = Automated International regular
22 = Automated International urgent
23 = SEPA Instant Payment

Enum: "None" "BankTransfer_BACS" "SameDayTransfer_CHAPS" "Cheque" "International_Regular" "International_Urgent" "Next_day" "Bank_Recall" "Faster_Payment_Danske_bank" "New_BankTransfer_BACS_FutureDatedUpto3Days" "New_SameDayTransfer_CHAPS" "New_International_Regular" "New_International_Urgent" "New_NextDayTransfer" "New_FasterPayment" "SEPA" "ClearBank_CHAPS" "ClearBank_NextDayTransfer" "ClearBank_FasterPayment" "ClearBank_BankTransfer_BACS_FutureDatedUpto3Days" "International_Urgent_CurrencyCloud" "International_Regular_CC_Automated" "International_Urgent_CC_Automated" "SEPA_Instant_Payments" "MCCYPayment" "Internal_Transfer" "ThirdParty_Transfer"
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/Transfer/ListInternationalBankAccountSetupCountries
Request samples
application/json
{
  • "ISOCountryCode": "826",
  • "TransferTypeID": 1,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "BankAccountSetupCountries": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Recipients

ListRecipients method is used to get the detail list of all recipients bank account linked to the Solaris consumer provided in API request.

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
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/Transfer/ListRecipients
Request samples
application/json
{
  • "ConsumerID": 55320,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "RecipientResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Sepa Bank Account Setup Countries

ListSepaBankAccountSetupCountries method returns the list of Country Name, ISO country code and BankAccountSetupGroupValue. Response of this method helps to indicate that different registered countries under SEPA accepts what combination of details to identify a Bank account.
BankAccountSetupGroupValue tells different country wise BankAccountSetup established depending upon the Groupvalue. Valid TransferTypeID = 15

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

BankAccountSetupCountriesReq

ISOCountryCode
string [ 0 .. 3 ] characters

Three-digit ISO country code of recipient bank account.

TransferTypeID
integer <int32>

Lookup value that identifies the type of bank transfer like BACS, CHAPS, Faster Payments etc.

15 = SEPA Payment
16 = Same day CHAPS Payment
17 = Next day Payment
18 = Same day Faster Payment
19 = BACS Payment
20 = International urgent
21 = Automated International regular
22 = Automated International urgent
23 = SEPA Instant Payment

Enum: "None" "BankTransfer_BACS" "SameDayTransfer_CHAPS" "Cheque" "International_Regular" "International_Urgent" "Next_day" "Bank_Recall" "Faster_Payment_Danske_bank" "New_BankTransfer_BACS_FutureDatedUpto3Days" "New_SameDayTransfer_CHAPS" "New_International_Regular" "New_International_Urgent" "New_NextDayTransfer" "New_FasterPayment" "SEPA" "ClearBank_CHAPS" "ClearBank_NextDayTransfer" "ClearBank_FasterPayment" "ClearBank_BankTransfer_BACS_FutureDatedUpto3Days" "International_Urgent_CurrencyCloud" "International_Regular_CC_Automated" "International_Urgent_CC_Automated" "SEPA_Instant_Payments" "MCCYPayment" "Internal_Transfer" "ThirdParty_Transfer"
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/Transfer/ListSepaBankAccountSetupCountries
Request samples
application/json
{
  • "ISOCountryCode": "826",
  • "TransferTypeID": 1,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "BankAccountSetupCountries": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update Beneficiary Status

UpdateBeneficiaryStatus method is used to update the status of recipient account like trusted or untrusted based upon activities performed by recipient 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 object req information.

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

required
Array of objects (BeneficiaryStatusReq)

Request for status update of list of recipients at a same time.

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/Transfer/UpdateBeneficiaryStatus
Request samples
application/json
{
  • "ConsumerID": 55320,
  • "BeneficiaryStatusReqList": [
    ],
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Upload Payment File

Uploads bulk payment file for transfer of funds to a beneficiary account. The beneficiary account can be a consumer account in Solaris or UK or international bank 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.

FileName
required
string [ 0 .. 100 ] characters

Name of the file.

FileBytes
required
string <byte>

Encrypted data in the file.

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/Transfer/UploadPaymentFile
Request samples
application/json
{
  • "FileName": "[FILE_NAME]",
  • "FileBytes": "UVdOamIzVnVkRTUxYldKbGNpeFFZWGxsWlU1aGJXVXNVMjl5ZEdOdlpHVXNRbUZ1YTBGalkyOTFiblJPZFcxaVpYSXNRMnhwWlc1MFVtVm1aWEpsYm1ObFRuVnRZbVZ5TEVKaGJtdFNaV1psY21WdVkyVk9kVzFpWlhJc1YybDBhR1J5WVhkaGJFRnRiM1Z1ZEN4WGFYUm9aSEpoZDJGc1JHRjBaUTBLTWpBd01EQTBOVFFzYldGc2MyRjBkR0Z5TERFMk1qQXpNQ3d3TVRJeU56STBOQ3hYUkZJZ01UQXpMRUpoYm1zZ1ZHVnpkRE1zTVRFdU1ETXNNakF4T0RBeE1qa05Dakl3TURBd05EVTBMRkJoZEdsaVlXNWthR0VzTVRZeU1ETXdMREF4TWpJM01qUTBMRmRFVWlBeE1EUXNRbUZ1YXlCVVpYTjBOQ3d4TVRBdU5Dd3lNREUzTURFek1BMEtNakF3TURBME5UUXNVMlJtTERFMk1qQXpNQ3d3TURBeE5qSXlNeXhYUkZJZ01UQTFMRUpoYm1zZ1ZHVnpkRFVzTVM0eE1EVXNNakF4T0RBeE16QU5Dakl3TURBd05EVTBMRXBvWjJwb1oyaHFMREUyTWpBek1Dd3dNREF4TmpJeU15eFhSRklnTVRBMkxFSmhibXNnVkdWemREWXNNQzR4TVRBMkxESXdNVGd3TVRNd0RRb3lNREF3TURRMU5DeG1iM1Z5ZEdoMWMyVnlMREUyTWpBek1Dd3dNREF4TmpJeU15eFhSRklnTVRBM0xFSmhibXNnVkdWemREY3NNVEV3Tnk0d0xESXdNVGd3TVRNd0RRb3lNREF3TURRMU5DeDBaWE4wTERFMk1qQXpNQ3d3TURBeE5qSXlNeXhYUkZJZ01URXdMRUpoYm1zZ1ZHVnpkREV3TERFeE1UQXNNakF4T0RBeE16QT0=",
  • "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
}

Verify Payee

Retrieves a match between the payee owner name and account details provided, for purposes of verifying the owner of the account. Please note this functionality is only available to verify the owners of UK bank accounts.

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
ConsumerID
required
integer <int32>

Unique identifier of the consumer.

AccountNumber
required
string [ 1 .. 8 ] characters

Payee's account number, used by an Account Servicing Payment Service Provider (ASPSP) to identify the account.

SortCode
required
string [ 1 .. 6 ] characters

Payee's sort code, used by an Account Servicing Payment Service Provider (ASPSP) to identify the account.

AccountOwnerName
required
string [ 1 .. 140 ] characters

Payee's name, used by an Account Servicing Payment Service Provider (ASPSP) to identify the account.

LegalOwnerType
required
string [ 0 .. 140 ] characters

Nature of funds held in the account. Valid options are Personal or Business.

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/Transfer/VerifyPayee
Request samples
application/json
{
  • "ConsumerID": 55320,
  • "AccountNumber": "string",
  • "SortCode": "string",
  • "AccountOwnerName": "string",
  • "LegalOwnerType": "string",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Matched": true,
  • "Name": "string",
  • "Reason": "string",
  • "MatchedBank": "string",
  • "ReasonCode": "string",
  • "ResponseWithinSla": true,
  • "LegalOwnerType": "string",
  • "ResponderRegistrationId": "string",
  • "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.