Standing Order API (V2)

Download OpenAPI specification:Download

StandingOrder

Provides methods to set up, manage and retrieve Standing Orders.

Activate SO

Activates an inactive Standing order.

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

ActivateSOReq

StandingOrderReferenceID
required
integer <int32>

Unique identifier of the Standing order. StandingOrderReferenceID along with account number and sort code MUST be passed.

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/StandingOrder/ActivateSO
Request samples
application/json
{
  • "StandingOrderReferenceID": 4906,
  • "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
}

Activate SO Execution

Executes a Standing order.

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

ActivateSOExecutionReq

SOExecutionReferenceID
required
integer <int32>

Unique identifier of the execution of Standing order.

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

Cancel SO

Cancels Standing order.

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

CancelSOReq

StandingOrderReferenceID
required
integer <int32>

Unique identifier of the Standing order.

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/StandingOrder/CancelSO
Request samples
application/json
{
  • "StandingOrderReferenceID": 4906,
  • "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
}

Deactivate SO

Deactivates an active Standing order.

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

DeactivateSOReq

StandingOrderReferenceID
required
integer <int32>

Unique identifier of the Standing order. StandingOrderReferenceID along with account number and sort code MUST be passed.

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/StandingOrder/DeactivateSO
Request samples
application/json
{
  • "StandingOrderReferenceID": 4906,
  • "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
}

Deactivate SO Execution

Stops execution of the specified Standing order.

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

ActivateSOExecutionReq

SOExecutionReferenceID
required
integer <int32>

Unique identifier of the Standing order.

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

Get Specific SO

Returns Standing order's description, status (active or inactive), amount, execution frequency, start and end date. Also returns the information of the payer and payee accounts, between which amount is transferred.

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

GetSpecificSOReq

StandingOrderReferenceID
required
integer <int32>

Unique identifier of the Standing order.

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

List Failed SO

Returns list of declined or failed Standing orders.

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

ListFailedSOReq

FromDate
required
string <date-time>

The start date of execution of the Standing order.
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>

The last date of execution of the Standing order.
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.

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/StandingOrder/ListFailedSO
Request samples
application/json
{
  • "FromDate": "2018-01-01T17:08:40+05:30",
  • "ToDate": "2018-07-02T17:08:40+05:30",
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "FailedStandingOrderResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List SO Executions

Returns list of Standing order's execution dates.

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

ListSOExecutionsReq

StandingOrderReferenceID
required
integer <int32>

Unique identifier of the Standing order.

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

List SOs

Returns list of active and inactive Standing orders.

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

ListSOsReq

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

Setup SO Receipent

Created internal and third party standing order by specifying receipent.

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

SetupSOReceipentReq

Description
required
string [ 0 .. 100 ] characters

Description of the Standing order.

Amount
integer <int64>

Staging order amount, 12 GBP will be 1200.

IsFullBalanceTransfer
boolean

Identifies if full amount is to be transferred. In case of Standing Order for Envelope, the value must be "false".
Valid values are true or false.

RecipientReferenceID
required
integer <int32>

Recipient reference id to setup standing order.

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

Standing Order execution frequency defined by a lookup value.

1 = Daily
2 = Weekly
3 = Monthly
4 = FourWeekly
7 = Fortnightly
8 = Quarterly

Enum: "None" "Daily" "Weekly" "Monthly" "FourWeekly" "Yearly" "Minutes" "Fortnightly" "Quarterly" "Second" "Hours"
EnvelopReferenceID
integer <int32>

Envelop's unique id to setup standing order for envelop.

FrequencyDay
string

The scheduled day of Standing order execution. For monthly execution Standing Order, value should be between 1 and 31. If frequency day is set as 31st of month, system will take last day of month. For weekly execution Standing order, value should be between 1 and 5, where 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday. For Fortnightly execution Standing order, value will be a weekly with a two-week execution frequency. Ex. For weekly, if two days need to be set than pass value 1, 2 and for one day pass the value 1. For four-weekly execution Standing order value should between 1 t0 5. For daily, always use 1.

StartDate
required
string <date-time>

The start date of Standing order's execution. Value must not be changed by client and will not be updated.
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.

EndDate
string <date-time>

The end date of the Standing order's execution.
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.

ReferenceNumber
string

Unique roll number made up numbers and letters. Can be null in case Internal and third-party transfer.

ClientReferenceNumber
string

Client provided unique reference number used for tracking of Standing order.

RequesterConsumerID
integer <int32>

Unique identifier of consumer if authorisation is required for SO.

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/StandingOrder/SetupSOReceipent
Request samples
application/json
{
  • "Description": "TEST-SO1912",
  • "Amount": 1200,
  • "IsFullBalanceTransfer": false,
  • "RecipientReferenceID": 33563,
  • "FrequencyID": 1,
  • "EnvelopReferenceID": 0,
  • "FrequencyDay": "1,2",
  • "StartDate": "2021-09-03T19:20:40.3211085+05:30",
  • "EndDate": "2021-09-12T19:20:40.3211085+05:30",
  • "ReferenceNumber": "REF123",
  • "ClientReferenceNumber": "CLIREF123",
  • "RequesterConsumerID": 0,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "StandingOrderReferenceID": 5012,
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Setup SO Recipient Bank

Create a Standing order for a specific recipient 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

SetupSORecipientBankReq

Description
required
string [ 0 .. 100 ] characters

Description of the Standing order.

Amount
integer <int64>

The amount to be transferred through Standing order. 12 GBP is represented as 1200.

IsFullBalanceTransfer
boolean

Boolean that identifies if full amount is to be transferred, or not. In case of Standing Order for Envelope, the value must be "false".
Valid values are true or false.

RecipientBankReferenceID
required
integer <int32>

Unique identifier of the recipient bank that will recieve the fund through Standing order.

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

Look up value that identifies the name of the method, which is used for money transfer.

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"
EnvelopReferenceID
integer <int32>

Unique identifier of the envelope.

ClientReferenceNumber
string [ 0 .. 50 ] characters

Client provided unique reference number used for tracking of Standing order.

ReferenceNumber
string [ 0 .. 18 ] characters

Unique roll number made up numbers and letters. Can be null in case Internal and third-party transfer.

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

The look up value that identifies the frequency of execution of the Standing order.

1 = Daily
2 = Weekly
3 = Monthly
4 = FourWeekly
7 = Fortnightly
8 = Quarterly

Enum: "None" "Daily" "Weekly" "Monthly" "FourWeekly" "Yearly" "Minutes" "Fortnightly" "Quarterly" "Second" "Hours"
FrequencyDay
string

The scheduled day of Standing order execution. For monthly execution of the Standing Order, value should be between 1 and 31. If frequency day is set as 31st of month, system will take last day of month. For weekly execution of the Standing order, value should be between 1 and 5, where "1" = Monday, "2" = Tuesday, "3" = Wednesday, "4" = Thursday, "5" = Friday. If SO is to be executed on Monday and Tuesday then select the relevant look values "1" and "2", respectively. If it is only Monday then select look up value "1". For Fortnightly execution of the Standing order, the look values are similar to the one used in Weekly execution. But the execution frequency is bi-weekly. For Four-Weekly execution, the look values remain the same as in weekly or fortnightly execution. But the execution frequency is four-weekly. For daily execution, always use "1".

StartDate
required
string <date-time>

The start date of Standing order's execution. Value must not be changed by client and will not be updated.
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.

EndDate
string <date-time>

The end date of the Standing order's execution.
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.

RequesterConsumerID
integer <int32>

Unique identifier of consumer if authorisation is required for transfer.

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/StandingOrder/SetupSORecipientBank
Request samples
application/json
{
  • "Description": "description string1",
  • "Amount": 1200,
  • "IsFullBalanceTransfer": false,
  • "RecipientBankReferenceID": 9219,
  • "TransferMethodID": 1,
  • "EnvelopReferenceID": 0,
  • "ClientReferenceNumber": "CLIREF123",
  • "ReferenceNumber": "REF123",
  • "FrequencyID": 1,
  • "FrequencyDay": "1",
  • "StartDate": "2021-09-03T19:20:40.5355842+05:30",
  • "EndDate": "2021-09-10T19:20:40.5355842+05:30",
  • "RequesterConsumerID": 0,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "StandingOrderReferenceID": 5011,
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update SO Details

Updates the specified Standing order.

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

StandingOrderRequestInfo

StandingOrderReferenceID
required
integer <int32>

Unique identifier of the Standing order.

Description
string [ 0 .. 100 ] characters

Description of the Standing order.

Amount
integer <int64>

The amount to be transferred using Standing order.

IsFullBalanceTransfer
boolean

Boolean that identifies if full amount is to be transferred or not. In case of Standing Order for Envelope, the value must be "false".
Valid values are true or false.

EndDate
string <date-time>

The last date of execution of the Standing order.
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.

ReferenceNumber
string [ 0 .. 18 ] characters

Reference number

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/StandingOrder/UpdateSODetails
Request samples
application/json
{
  • "StandingOrderReferenceID": 0,
  • "Description": "[Description]",
  • "Amount": 112,
  • "IsFullBalanceTransfer": false,
  • "EndDate": "2022-09-02T19:20:40.7011363+05:30",
  • "ReferenceNumber": "BSF Canvas3",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update SO Execution Date

Updates

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

ActivateSOExecutionReq

SOExecutionReferenceID
required
integer <int32>

Unqiue identifier of Standing order execution.

SOExecutionDate
required
string <date-time>

The date of execution of the Standing order.
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/StandingOrder/UpdateSOExecutionDate
Request samples
application/json
{
  • "SOExecutionReferenceID": 4906,
  • "SOExecutionDate": "2021-09-12T19:20:40.6477036+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.