Card API (V2)

Download OpenAPI specification:Download

Card

Provides methods to request, activate, and manage cards and their usage.

Activate Card

ActivateCard method is used to activate the card for a new or inactive card.

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

ActivateCardReq

CardID
integer <int32>

Unique identifier of the card. Either CardID or Encrypted PAN MUST be entered.

EncryptedPAN
string

PAN Card number in the encrypted format. Either CardID or Encrypted PAN MUST be entered.

EncryptedCVV
required
string

Card Verification Value (CVV) of card in the encrypted format.

DOB
required
string <date-time>

Date of birth of the consumer.
Format of date is 'yyyy-MM-dd', e.g. 24-May-1960 as 1960-05-24.

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/Card/ActivateCard
Request samples
application/json
{
  • "CardID": 18099,
  • "EncryptedPAN": "",
  • "EncryptedCVV": "",
  • "DOB": "2021-12-21T14:57:24.4939251+05:30",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Add Virtual Card

AddVirtualCard method is used to Add a new virtual card and link it to the consumer account. Virtual card should always be linked with any consumer account and is valid for limited short period of time.

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

CardRequestInfo

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

AgreementCode
string [ 0 .. 8 ] characters

An agreement code for virtual card that specifies agreements of virtual card.

CardDesignCode
required
string [ 0 .. 8 ] characters

Virtual card's desgin code.

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/Card/AddVirtualCard
Request samples
application/json
{
  • "ConsumerID": 42603,
  • "AgreementCode": "M3RZQYKE",
  • "CardDesignCode": "VIRTNW",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CardID": 18102,
  • "EncryptedVirtualCardNumber": "6dDCuZjIOc5lrLyIyQ9YevCBzdS9qVPIWWH08TR5/elppKbv9y1wlKKHkC6pJSFu",
  • "CardExpiryDate": "2023-12-21T14:57:24.5500346+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
}

Cancel Card

CancelCard method is used to cancel the card to stop performing card related activities.

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

CancelCardReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's account.

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

Change Pending Cards Design

This method will update card design if card request is pending (Not 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

ChangePendingCardsDesignReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's account, should be provide when need to update design for specific card.

CardDesignCode
required
string [ 0 .. 8 ] characters

The card design code is use for amend existing card design.

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/Card/ChangePendingCardsDesign
Request samples
application/json
{
  • "CardID": 18080,
  • "CardDesignCode": "CECPLUS",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Disable MCC

DisableMCC method is used to disable MCC on card by CardID and MCC 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

EnableDisableMCCReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's account.

MCC
required
string [ 0 .. 4 ] characters

Merchant category code.

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/Card/DisableMCC
Request samples
application/json
{
  • "CardID": 19445,
  • "MCC": "3001",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Enable MCC

EnableMCC method is used to enable MCC on card by CardID and MCC 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

EnableDisableMCCReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's account.

MCC
required
string [ 0 .. 4 ] characters

Merchant category code.

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/Card/EnableMCC
Request samples
application/json
{
  • "CardID": 19445,
  • "MCC": "3001",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Allowed MCC

GetAllowedMCC method is used to fetch list of allowed MCC by CardDesignCode 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

GetAllowedMCCReq

CardDesignCode
required
string [ 0 .. 8 ] characters

Unique identifier of the card design.

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

Get Blocked MCC

GetBlockedMCC method is used to fetch list of blocked MCC on card by CardID 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

GetAllowedMCCReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's 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/Card/GetBlockedMCC
Request samples
application/json
{
  • "CardID": 19445,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "GetBlockedMCCResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Specific Card

GetSpecificCard method is used to get card details like Name, Status, Issue Date, Expiry Date, Activation Date etc. for a specific card 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

GetSpecificCardReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's 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/Card/GetSpecificCard
Request samples
application/json
{
  • "CardID": 14023,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CardRes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Specific Name Only Card

GetSpecificNameOnlyCard method is used to get card details like Name, Status, Issue Date, Expiry Date, Activation Date etc. for a specific card 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

GetSpecificNameOnlyCardReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's 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/Card/GetSpecificNameOnlyCard
Request samples
application/json
{
  • "CardID": 14023,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "NameOnlyCardRes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Specific Virtual Card

GetSpecificVirtualCard method is used to get card details like Name, Status, Issue Date, Expiry Date, Activation Date etc. for a specific virtual card 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

GetSpecificVirtualCardReq

CardID
integer <int32>

Unique identifier of the card linked to consumer's account.
Conditional: Either CardID or combination of (IBAN and BIC) or (AccountNumber and SortCode) must be specified.

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/Card/GetSpecificVirtualCard
Request samples
application/json
{
  • "CardID": 18080,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CardID": 18112,
  • "ConsumerID": 42603,
  • "EncryptedVirtualCardNumber": "6dDCuZjIOc5lrLyIyQ9YemQTd6EDsb06xT/kQhOUx+LRgGU5OEpA/N2y4CoZYzZz",
  • "ExpiryDate": "0521",
  • "CardStatus": 1,
  • "CardIssuedDate": "2021-12-14T14:57:25.2373823+05:30",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Virtual Card CVV

GetVirtualCardCVV method is used to return Card Verification Value (CVV) for the virtual card 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

GetVirtualCardCVVReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's 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/Card/GetVirtualCardCVV
Request samples
application/json
{
  • "CardID": 14023,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "EncryptedCVV": "nUuwbu7U7CQ=",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Issue Physical Card for Digital Card

IssuePhysicalCardForDigitalCard method is used to issue the card for the digital card.

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

IssuePhysicalCardForDigitalCardReq

CardID
integer <int32>

Unique identifier of the card. Either CardID or Encrypted PAN MUST be entered.

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

Link Preissued Card

LinkPreissuedCard method is used to link up the card with the consumer. Pre issued cards are non-personalized cards and assigned to respective primary or secondary 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

CardRequestInfo

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

EncryptedPAN
required
string

Card number in the encrypted format.

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/Card/LinkPreissuedCard
Request samples
application/json
{
  • "ConsumerID": 42631,
  • "EncryptedPAN": "c6T1M9hIAKr1K0qGCo7Ft5L4VupBuTbtYdhZ8zXHwAmzF2vREyDyMW/SzhHts0pA",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CardID": 18099,
  • "CardActivationCode": "033",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Link Preissued Card

LinkPreissuedCard method is used to link up the card with the consumer. Pre issued cards are non-personalized cards and assigned to respective primary or secondary 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

CardRequestInfo

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

EncryptedPAN
required
string

Card number in the encrypted format.

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

head/Card/LinkPreissuedCard
Request samples
application/json
{
  • "ConsumerID": 42631,
  • "EncryptedPAN": "c6T1M9hIAKr1K0qGCo7Ft5L4VupBuTbtYdhZ8zXHwAmzF2vREyDyMW/SzhHts0pA",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CardID": 18099,
  • "CardActivationCode": "033",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Card Features

ListCardFeatures method is used to Get Card Feature List

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

ListCardFeaturesReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's 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/Card/ListCardFeatures
Request samples
application/json
{
  • "CardID": 14023,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "FeatureDetails": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Cards

ListCards method is used to fetch list of primary and secondary cards linked to an 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

ListCardsReq

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/Card/ListCards
Request samples
application/json
{
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CardResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Pending Card Authorizations

ListPendingCardAuthorizations method is used to get list of pending transactions for a specified card. It retrieves the transactions which are pending for clearing and get details of the transactions like date, amount, currency,terminal etc.

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

ListPendingCardAuthorizationsReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's 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/Card/ListPendingCardAuthorizations
Request samples
application/json
{
  • "CardID": 14023,
  • "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 Transactions

ListTransactions method is used to get list of transactions between the specified start and end date, for an account detail provided for API request. This method retrieves transaction details like date, amount, type of transaction, sender account details etc.

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.

CardID
integer <int32>

Unique identifier of the card.

AccountIdentifier
integer <int32>

Unique identifier of account. Only AccountIdentifier is provided, it will give transactions including all cards associated with an account. Only CardId is provided, it will give transactions for the specific card. Both CardId and AccountIdentifier are provided, it will give transactions for a single card associated with an account.

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 .. 50 ] characters

Unique reference 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 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

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/Card/ListTransactions
Request samples
application/json
{
  • "CardID": 1,
  • "AccountIdentifier": 88551,
  • "FromDate": "2021-12-20T09:27:24.6502984Z",
  • "ToDate": "2021-12-21T09:27:24.6502984Z",
  • "Reference": "",
  • "RowIndex": 1,
  • "Pagesize": 5,
  • "TransactionAmount": 0,
  • "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
}

New Virtual Card at Physical Card Level

NewVirtualCardAtPhysicalCardLevel method is used to Add a virtual card to an existing consumer account. The Virtual Card Object will sit on the same Consumer as a Physical Card. The Virtual and physical cards will share the same limits set at agreement. The duration of the Virtual card will have pre-defined expiration as per your card program setup.

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

NewVirtualCardAtPhysicalCardLevelReq

ConsumerID
required
integer <int32>

Unique consumer identifier provided by Solaris.

AccountIdentifier
required
integer <int32>

Unique account identifier provided by Solaris. New virtual card will be created under this specific account identifier.

CardDesignCode
required
string [ 0 .. 8 ] characters

Unique card design code of card program design. To issue virtual card on provided card designs. Card program will be used by provided card design setup.

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/Card/NewVirtualCardAtPhysicalCardLevel
Request samples
application/json
{
  • "ConsumerID": 0,
  • "AccountIdentifier": 1234567,
  • "CardDesignCode": "DEGABC12",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CardID": 19507,
  • "EncryptedVirtualCardNumber": "MI7o02e2PajWJ/y+kWr0WyHWpwC97ns8TO3HH5yEeUfG6zI0ZjnNHEGo6RCdvhMK",
  • "CardExpiryDate": "2021-12-21T14:57:25.4736893+05:30",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Request New Card

RequestNewCard method is used to request a new card that is to be issued to the 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

RequestNewCardReq

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

CardDesignCode
required
string [ 0 .. 8 ] characters

Unique identifier of card's design code.

AccountIdentifier
integer <int32>

Unique identifier of an Account.

EncryptedPIN
string

Encrypted PIN is used when a consumer chooses their own PIN at point of card order

IssuePhysicalCard
boolean

For the digital card allow user to select they want to issue physical card or not
Valid values are true or false.

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/Card/RequestNewCard
Request samples
application/json
{
  • "ConsumerID": 42603,
  • "CardDesignCode": "AIRBENG",
  • "AccountIdentifier": 1234,
  • "EncryptedPIN": "BjImrEf/1Opj+AtX0B86kw==",
  • "IssuePhysicalCard": true,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CardID": 14023,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Reset Card Activation Attempts

This method will reset card activation attempts.

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

ResetCardActivationAttemptReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's 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/Card/ResetCardActivationAttempts
Request samples
application/json
{
  • "CardID": 19445,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Set Card as Block

SetCardAsBlock method is used to set the card status as block of a card Id and consumer Id 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

SetCardAsBlockReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's account.

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

Set Card as Damaged

SetCardAsDamaged method is used to update the card status as damaged and requests to issue replaced card.

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

SetCardAsDamagedReq

CardDesignCode
string [ 0 .. 8 ] characters

The card design code is use for amend existing card design.

ShipmentMethodCode
string [ 0 .. 7 ] characters

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

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's account.

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/Card/SetCardAsDamaged
Request samples
application/json
{
  • "CardDesignCode": "",
  • "ShipmentMethodCode": "BULK044",
  • "CardID": 18080,
  • "ConsumerID": 42603,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CardID": 14023,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Set Card as Lost

SetCardAsLost method is used to set the card status as lost.

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

SetCardAsLostReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's account.

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

Set Card as Lost with Replacement

SetCardAsLostWithReplacement method is used to set the card status as lost and requests for replacement of the card.

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

SetCardAsLostWithReplacementReq

CardDesignCode
string [ 0 .. 8 ] characters

The card design code is for amend card design.

ShipmentMethodCode
string [ 0 .. 7 ] characters

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

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's account.

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/Card/SetCardAsLostWithReplacement
Request samples
application/json
{
  • "CardDesignCode": "",
  • "ShipmentMethodCode": "BULK044",
  • "CardID": 18080,
  • "ConsumerID": 42603,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CardID": 14023,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Set Card as Normal

SetCardAsNormal method is used to set the card status as normal to get the card back in use again after being blocked.

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

SetCardAsNormalReq

CardID
required
integer <int32>

Unique identifier of the card linked to the consumer's account.

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

Update Auto Renew Feature of Card

This api is used to update auto renew feature of card.

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

AutoRenewCardReq

CardID
required
integer <int32>

Unique identifier of the card.

AutoRenew
required
boolean

This field is used to update auto renew feature of card.
Valid values are true or false.

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/Card/UpdateAutoRenewFeatureOfCard
Request samples
application/json
{
  • "CardID": 18099,
  • "AutoRenew": true,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update Card Feature

UpdateCardFeature method is used to enable or disable the card features.

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

UpdateCardFeatureReq

Array of objects (FeatureDataDetails)

Gets or sets Features Details

CardID
integer <int32>

Gets or Sets CardID

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

Validate Last 4 Digit

ValidateLast4Digit method validates the last 4 digits of a card number against the account number.

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

ValidateLast4DigitReq

L4D
required
string [ 0 .. 4 ] characters

Last 4 digits of the card number.

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/Card/ValidateLast4Digit
Request samples
application/json
{
  • "L4D": "4033",
  • "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
}

View PIN

ViewPin method returns encrypted PIN of the card.

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

ViewPinReq

CardID
integer <int32>

Unique identifier of the card. Either CardID or EncryptedPAN MUST be passed.
Note: Either CardID or EncryptedPAN MUST be provided for API request.

EncryptedPAN
string

Card number in the encrypted format.

EncryptedCVV
required
string

Card Verification Value (CVV) in the encrypted format.

DOB
required
string <date-time>

Date of birth of the consumer.
Format of date is 'yyyy-MM-dd', e.g. 24-May-1960 as 1960-05-24.

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/Card/ViewPin
Request samples
application/json
{
  • "CardID": 18080,
  • "EncryptedPAN": "",
  • "EncryptedCVV": "489",
  • "DOB": "0001-01-01T00:00:00",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "EncryptedPin": "JuEdQC30rJBWAC8Iz4LWfQ==",
  • "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.