Unique identifier of the primary consumer. The field is required while adding additional or junior consumer and to establish its relationship with Parent Consumer account.

Consumer detail request object is used for adding personal details of a consumer.

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

Unique identifier of the primary consumer. The field is required while adding additional or junior consumer and to establish its relationship with Parent Consumer account.

Consumer detail request object is used for adding personal details of a consumer.

Unique identifier of an agreement. Agreement code is same for primary and secondary account(s).

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

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

List of consumers to be created, including primary and secondary.

Series of letters and numbers that enable a consumer to get discount.

Unique identifier of an agreement. Agreement code is same for primary and secondary account(s).

The language used in the scheme settings. If language look up value is not provided then default language is considered.

1 = English
2 = Russian
3 = Latvian
4 = EnglishLatvian
5 = Polish
6 = Lithuanian
8 = Chinese
9 = Albanian
10 = French
11 = Romanian
12 = German
13 = Italian
14 = Spanish

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

Payee reference of an account to identify an account for future transfer

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

ClientReferenceID. Auto generated field, Received at time Consumer/AddConsumer API called when W2Gbolal as Service Provider configured against program.

DocumentTypeID.

1 = Passport
2 = Driving Licence
3 = Identity Card

DocumentFrontSide.

DocumentBackImage.

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

ClientReferenceID. Auto generated field, Received at time Consumer/AddConsumer API called when W2Gbolal as Service Provider configured against program.

DocumentTypeID.

1 = Passport
2 = Driving Licence
3 = Identity Card

DocumentFrontSide.

DocumentBackImage.

DocumentBackImage.

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

ClientReferenceID. Auto generated field, Received at time Consumer/AddConsumer API called when W2Gbolal as Service Provider configured against program.

DocumentBackImage.

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

Series of numbers or letters, or both, that uniquely identify the location or area.

Three-digit, CountryA3Code. This filed is require to get address for Non UK Country.

Unique code specific to each scheme.

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

Unique identifier of the consumer.

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

Unique identifier of the consumer.

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

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.

Eight-digit account number.

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

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.

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

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

Set Account Type
Note: For getting available standard agreement (2-PersonalTopup, 4-MerchantBusiness, 6-PayOnOrder, 7-Junior, 8-NominalAccount) no need to pass this parameter

1 = Virtual
2 = Personal Topup
3 = Business
4 = Merchant Business
6 = Pay On Order
7 = Junior
8 = Nominal Account
9 = Direct Debit

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

Unique identifier of the primary consumer.

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

Unique identifier of the primary consumer.

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

Unique identifier of the primary consumer.

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

Unique identifier of the consumer.

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

The mobile number of the consumer should be passed if consumer wishes to update it.

Mobile number country code in three-digit ISO 3166-1 numeric code format.

Email address of the consumer should be passed if consumer wishes to update the email address.
Regex :
^(([\w-+]+.)+[\w-+.]+|([a-zA-Z]{1}|[\w-+]{2,64}))@((([0-1]?[0-9]{1,2}|25[0-5]|2[0-4][0-9]).([0-1]? [0-9]{1,2}|25[0-5]|2[0-4][0-9]).([0-1]?[0-9]{1,2}|25[0-5]|2[0-4][0-9]).([0-1]? [0-9]{1,2}|25[0-5]|2[0-4][0-9])){1}|(a-zA-Z0-9+.)+[a-zA-Z]{1}[a-zA-Z0-9-]{1,23})$

Unique identifier of the consumer.

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

Get or Set card display name which is display on card.

The title is preceding the name of consumer.

1 = Mr
2 = Mrs
3 = Miss
4 = Ms
5 = Dr
6 = Prof
8 = Sir
9 = Other
10 = Master

The first name of the consumer.

The last name of the consumer.

The gender of the consumer. Options ‘M’ for Male, ‘F’ for Female and ‘U’ for Unknown.

Date of birth of the consumer. Required minimum age is configurable at scheme settings and validated against provided DOB of a consumer.
Format of date is 'yyyy-MM-dd', e.g. 24-May-1960 as 1960-05-24.

The consumer's preferred language is set in the scheme settings and agreement. All communication with the consumer will be done in preferred set language. The language should be set by consumer, else default langauge for the scheme will be set.

The look up value that identifies

1 = Self
2 = Family
3 = Friend
4 = Colleague

The nationality of the consumer in three-digit ISO 3166-1 numeric code format.

The passport number of the consumer. Must be provided as either a 7, 8 or 9-character passport number, or the full 44 characters of the second line of the passport machine-readable zone (MRZ).

The full MRZ is comprised as follows:

Passport number: (1 to 9)
Allowed values: a-z, A-Z,0-9

Passport Number check sum digit: (10)
Allowed values: 0-9

Country Code: (11 to 13)
Allowed values: a-z, A-Z,0-9

Birth Date with Check Sum: (14 to 20)
Allowed values: 0-9

Gender: (21)
Allowed values: M, m, F, f

Expiration date with Checksum: (22 to 28)
Allowed values: 0-9

Passport Number: (28 to 42)
Allowed values: a-z, A-Z ,0-9

PassportChecksum1: (43)
Allowed values: a-z, A-Z,0-9

PassportChecksum2: (44)
Allowed values: 0-9

The Expiry date of the valid passport. If consumer PassportNumber is provided then valid PassportExpiryDate should be passed along with PassportNumber.
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.

Valid driving licence number of a consumer. It should be an alphanumeric value.
Driving Licence logic :
1 to 16 string value require length of the Driving License.

NUMBER1: (1 to 5)
Allowed values: a-z, A-Z ,0-9

NUMBER2: (6 to 12)
Allowed values: a-z, A-Z ,0-9

NUMBER3: (12 to 14)
Allowed values: a-z, A-Z ,0-9

NUMBER4: (15 to 16)
Allowed values: a-z, A-Z ,0-9

The Expiry date of the valid DrivingLicense. If consumer DrivingLicense is provided then valid DrivingLicenceExpiryDate should be passed along with DrivingLicense.
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.

The information in the first line of the consumer's National identity card. If a value is provided it must conform to the following regex: for UK: ^[a-zA-Z0-9/ ,.+=\\<]{5,60}$, for all other countries: ^[a-zA-Z0-9/ ,.+=\\-]{5,60}$.

The information on the Line 2 of the consumer's national identity card.

The Expiry date of the valid NationalIDCard. If consumer NationalIDCard details is provided then valid NationalIDCardExpiryDate should be passed along with NationalIDCard.
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.

DesignCode for cards provided by Solaris.

ShipmentMethodCode is used for amend existing card shipment method. To amend existing card shipment method CardDesignCode is required.

The intended purpose of the account.

1 = Occasional day to day spending / Savings.
2 = Salary / Pension / Benefits.
3 = Budgeting.
4 = Expenses linked to employment.
5 = Current Account / Every day spend.
6 = Online shopping.
7 = Trading stocks / shares / goods.
8 = Overseas transactions / Travel.
9 = Day to day spending linked to Crypto.
10 = Gambling.
11 = Investment funding.
12 = Investment funding linked to Crypto.

The user's occupation.

1 = Employed
2 = Self Employed
3 = Student
4 = Unemployed
5 = Military
6 = Apprentice
7 = Housework
8 = Retired

The total amount the user expects to be spent from their account in a given year.

1 = Up to 5k
2 = 5,001 - 10,000
3 = 10,001 - 15,000
4 = 15,001 - 25,000
5 = 25,001 - 35,000
6 = 35,001 - 49,999
7 = 50k or over.

The number of monthly transactions the user expects to make from the account.

1 = 0 - 50
2 = 51 - 75
3 = 75+.

The description of the user's occupation.

The user's country of birth, provided in ISO 3166-1 numeric code format.

Lithuania Residents Person Code (mandatory for Lithuanian consumers).

The citizenship of the user provided in ISO 3166-1 numeric code format.

The name of the other document provided for purposes of consumer identity verification. Can contain alphanumeric characters and spaces.

The reference/reference number of the document referenced in OtherDocumentName, if provided. Must contain alphanumeric characters only.

The expiry date of the document referenced in OtherDocumentName, if provided.
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.

Unique identifier of the consumer.

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

Verification code for the consumer's main mobile number.

Unique identifier of the consumer.

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