Saving Envelope API (V2)

Download OpenAPI specification:Download

SavingEnvelope

Provides methods for creating and managing Saving Envelope functionality.

Add Saving Envelope

Add a new saving envelope in the 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

AddEnvelopeDetailsReq

AccountIdentifier
required
integer <int32>

Unique identifier of the Account.

EnvelopeName
required
string [ 0 .. 50 ] characters

The name of the envelope in reference to the intent of use. Envelope can have name like "Tour Pot", "Holiday Spending", "My Target", etc.

TargetAmount
required
integer <int64>

The amount in the envelope.

TargetDate
string <date-time>

The target date for envelope.
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.

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/SavingEnvelope/AddSavingEnvelope
Request samples
application/json
{
  • "AccountIdentifier": 955970,
  • "EnvelopeName": "Envelope Test",
  • "TargetAmount": 300,
  • "TargetDate": "2021-05-13T18:17:06.1295351+05:30",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "EnvelopeReferenceID": 985,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Delete Saving Envelope

Deletes the saving envelope from the account. The envelope amount is automatically transferred to the account before saving envelope is deleted

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

DeleteEnvelopeReq

EnvelopeReferenceID
required
integer <int32>

Unique identifier of an envelope for an 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/SavingEnvelope/DeleteSavingEnvelope
Request samples
application/json
{
  • "EnvelopeReferenceID": 979,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Saving Envelope History

Returns transaction history of the saving envelope.

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

ListSavingEnvelopesReq

EnvelopeReferenceID
required
integer <int32>

Unique identifier of the Envelope.

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

List Saving Envelopes

Returns list of saving envelope(s) in the 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

ListSavingEnvelopesReq

AccountIdentifier
required
integer <int32>

Unique identifier of the Account.

ClientRequestReference
string [ 0 .. 50 ] characters

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

CultureID
integer <int32>

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

Responses
200

Success

400

Bad Request

500

Server Error

post/SavingEnvelope/ListSavingEnvelopes
Request samples
application/json
{
  • "AccountIdentifier": 955970,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "SavingEnvelopeList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Release Funds

Releases the amount from the saving account and transfers it to the 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

ReleaseFundsReq

Amount
required
integer <int64>

The amount to be released from an envelope to the main account for normal debit or transfer of funds.

EnvelopeReferenceID
required
integer <int32>

Unique identifier of an envelope for an 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/SavingEnvelope/ReleaseFunds
Request samples
application/json
{
  • "Amount": 500,
  • "EnvelopeReferenceID": 979,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Reserve Funds

Transfer specified amount from the account to the saving envelope.

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

ReserveFundsReq

Amount
required
integer <int64>

The amount to be reserved in the envelope.

EnvelopeReferenceID
required
integer <int32>

Unique identifier of an envelope for an 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/SavingEnvelope/ReserveFunds
Request samples
application/json
{
  • "Amount": 500,
  • "EnvelopeReferenceID": 979,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update Saving Envelope

Changes the name, amount and date of the envelope.

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

UpdateEnvelopeDetailsReq

EnvelopeReferenceID
required
integer <int32>

Unique identifier of the Envelope.

EnvelopeName
string [ 0 .. 50 ] characters

The name of the envelope in reference to the intent of use. Envelope can have name like "Tour Pot", "Holiday Spending", "My Target", etc.

TargetAmount
integer <int64>

The amount in the envelope.

TargetDate
string <date-time>

The target date for envelope.
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.

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/SavingEnvelope/UpdateSavingEnvelope
Request samples
application/json
{
  • "EnvelopeReferenceID": 952,
  • "EnvelopeName": "Envelope Test",
  • "TargetAmount": 300,
  • "TargetDate": "2021-05-13T18:17:06.1514768+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
}
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.