P2P API (V2)

Download OpenAPI specification:Download

P2P

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

Accept Payment

AcceptPayment method is used to accept money transfer request from payee account. It validates and transfers the payment from payer to payee account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

The object req information.

TransactionReferenceID
required
integer <int32>

Unique identifier of the transaction.

RecipientAccountIdentifier
integer <int32>

Unique identifier of recipient account.
Note:Either RecipientAccountIdentifier or combination of RecipientAccountNumber and RecipientSortCode or combination of RecipientIBAN and RecipientBIC must be provided. For international account (outside UK) provide the combination of RecipientIBAN and RecipientBIC only. For account within UK  provide either of the three combinations.

RecipientAccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number of the recipient.

RecipientSortCode
string [ 0 .. 6 ] characters

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

RecipientIBAN
string [ 0 .. 34 ] characters

Recipient IBAN. 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.

RecipientBIC
string [ 0 .. 11 ] characters

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

IsApplyAutomaticallyReceiveToAccountNumber
boolean

Boolean that identifies whether to automatically credit money to the recipient account or not. If "IsApplyAutomaticallyReceiveToAccountNumber" value is "false" or "0" then money is not automatically credited to payee account. If "IsApplyAutomaticallyReceiveToAccountNumber" value is "true" or "1" then money is automatically credited to payee account.
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/P2P/AcceptPayment
Request samples
application/json
{
  • "TransactionReferenceID": 3421,
  • "RecipientAccountIdentifier": 44857,
  • "RecipientAccountNumber": "00877278",
  • "RecipientSortCode": "623053",
  • "RecipientIBAN": "GB35CNFV60837000000570",
  • "RecipientBIC": "CNFVGB21XXX",
  • "IsApplyAutomaticallyReceiveToAccountNumber": false,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Add Recipient

AddRecipient method is used to add details of recipient and link the recipient bank account to consumer account for fund transfer. Add recipient method can add recipient only if agreement allows transfer for that recipient.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json
ConsumerID
required
integer <int32>

Unique identifier of the consumer who wishes to add recipient for his account.

RecipientAccountNumber
string [ 0 .. 8 ] characters

The recipieint account number.
Note:Either combination of RecipientAccountNumber and RecipientSortCode or combination of RecipientIBAN and RecipientBIC must be provided. For international account (outside UK) provide the combination of RecipientIBAN and RecipientBIC only. For account within UK  provide either of the two combinations.

RecipientSortCode
string [ 0 .. 6 ] characters

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

RecipientIBAN
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.

RecipientBIC
string [ 0 .. 11 ] characters

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

RecipientFriendlyName
string [ 0 .. 50 ] characters

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

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/P2P/AddRecipient
Request samples
application/json
{
  • "ConsumerID": 44497,
  • "RecipientAccountNumber": "04121718",
  • "RecipientSortCode": "623053",
  • "RecipientIBAN": "GB35CNFV60837000000570",
  • "RecipientBIC": "CNFVGB21XXX",
  • "RecipientFriendlyName": "CARD",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "RecipientReferenceID": 39415,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Delete Recent Payee

DeleteRecentPayee method is used to delete recent payee details from RecentSendReceiveMoney permanently.

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.

RecentSendMoneyReferenceID
required
integer <int32>

Unique identifier of the Recent Payee from SendReceiveMoney.

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

Delete Recipient

DeleteRecipient method is used to unlink the recipient account which is linked with a Solaris consumer's account and stops further fund transfer.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

The object req information.

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

RecipientReferenceID
required
integer <int32>

Unique reference identifier of the recipient linked with consumer for fund transfer.

ClientRequestReference
string [ 0 .. 50 ] characters

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

CultureID
integer <int32>

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

Responses
200

Success

400

Bad Request

500

Server Error

post/P2P/DeleteRecipient
Request samples
application/json
{
  • "ConsumerID": 44497,
  • "RecipientReferenceID": 52093,
  • "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 Recipient

GetSpecificRecipient method is used to get the details of specific recipient linked against consumer provided in API request. It returns bank account related informations like Account Number, Sortcode, IBAN, BIC, Friendly Name, Beneficiary status and Last transfer date of recipient linked to a consumer (payer) 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
ConsumerID
required
integer <int32>

Unique identifier of the consumer.

RecipientReferenceID
required
integer <int32>

Unique reference identifier of the recipient linked with consumer for fund transfer.

ClientRequestReference
string [ 0 .. 50 ] characters

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

CultureID
integer <int32>

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

Responses
200

Success

400

Bad Request

500

Server Error

post/P2P/GetSpecificRecipient
Request samples
application/json
{
  • "ConsumerID": 44497,
  • "RecipientReferenceID": 52093,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "RecipientRes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Consumers by Email Addess

ListConsumersByEmailAddess method is used to get list of consumer(s) details based on email address provided in request. It returns details of consumers account of same scheme and who have email address linked is same as provided in 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

The object req information.

EmailAddress
required
string [ 0 .. 100 ] characters

Valid email address registered in system is required to be provided to find details of consumer(s).

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/P2P/ListConsumersByEmailAddess
Request samples
application/json
{
  • "EmailAddress": "auser@demoexample.com",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ConsumersByEmailAddessResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Consumers by Phone Number

ListConsumersByPhoneNumber method is used to get list of consumer(s) details based on phone number provided in request. It returns details of consumers account of same scheme and who have contact number as phone number provided in 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

The object req information.

PhoneNumber
required
string [ 6 .. 15 ] characters

Valid phone number registered in system without country code is required to be provided to find details of consumer(s).

CountryCode
string [ 0 .. 3 ] characters

Associated Country code with phone number should be provided. If Country code is not provided then default value "44" is considered which is UK region mobile country 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/P2P/ListConsumersByPhoneNumber
Request samples
application/json
{
  • "PhoneNumber": "9876543210",
  • "CountryCode": "44",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ConsumersByPhoneNumberRes": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Consumers by UserName

ListConsumersByUserName method is used to get list of consumer(s) details based on User Name provided in request. It returns details of consumers account of same scheme and who have associated user name is same as provided in 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

The object req information.

UserName
required
string [ 0 .. 100 ] characters

Registered user name in system is required to be provided to find details of consumer(s).

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/P2P/ListConsumersByUserName
Request samples
application/json
{
  • "UserName": "Name of the user",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ConsumersByUserNameResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Payments Sent

ListPaymentsSent method is used to get list of payments sent to a payee. It returns information of the payer and payee accounts for each listed payment.

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

GetSendMoneyRequestInfo

PayeeConsumerID
required
integer <int32>

Unique identifier of the payee.

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

List Recent Payees

ListRecentPayees method is used to get list of all recent payee(s) whom money is sent or money received by the consumer account provided in 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

ListRecentPayeesReq

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

List Recipients

ListRecipients method is used to get list of details for multiple recipients linked against consumer provided in API request. It returns bank account related informations like Account Number, Sortcode, IBAN, BIC, Friendly Name, Beneficiary status and Last transfer date of recipients linked to a consumer (payer) account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

The object req information.

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

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

List Rejected Money Requests

ListRejectedMoneyRequests method returns list of rejected money requests by payer.

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.

PayeeAccountIdentifier
required
integer <int32>

Unique identifier of payee account.

IsIncludeFromAndToRequest
boolean

Boolean that identifies whether to fetch details of request money rejected for consumer and request money rejected by consumer. If "IsIncludeFromAndToRequest" set to "true" will fetch details of request money rejected by consumer and for consumer. Else "IsIncludeFromAndToRequest" set to "false" will fetch details of request money rejected for consumer(payee) provided in request for whom money requested.
Valid values are true or false.

FromDate
required
string <date-time>

Date from which request money rejected requires to fetch.
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>

Date up to which request money rejected requires to fetch.
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/P2P/ListRejectedMoneyRequests
Request samples
application/json
{
  • "PayeeAccountIdentifier": 88551,
  • "IsIncludeFromAndToRequest": false,
  • "FromDate": "2021-01-01T00:00:00+05:30",
  • "ToDate": "2021-01-01T00:00:00+05:30",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "RejectedMoneyRequestList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Request Money

ListRequestMoney method returns list of consumers who have sent money request. It returns details of both payee and payer account details.

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.

PayerConsumerID
required
integer <int32>

Unique identifier of the payer.

IsIncludeFromAndToRequest
boolean

Boolean that identifies whether to fetch details of money request made by consumer and money request received by consumer. If "IsIncludeFromAndToRequest" set to "true" will fetch details of consumer provided in request who have raised or received money request.
Else "IsIncludeFromAndToRequest" set to "false" will fetch details of consumer provided in request who have money requested.
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/P2P/ListRequestMoney
Request samples
application/json
{
  • "PayerConsumerID": 21,
  • "IsIncludeFromAndToRequest": false,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "RequestMoneyResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Pay Requested Money

PayRequestedMoney method is used to transfer requested money from the payer account to payee account. It will be a transaction when payer AcceptsPayment and transfers requested money to payee. It also changes the status of money request like unpaid to paid/rejected/cancelled.

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.

RequestReferenceID
required
integer <int32>

Unique identifier of request money. Payee requests money from the payer.

PayerAccountIdentifier
integer <int32>

Unique identifier of payer account.
Note: Either PayerAccountIdentifier or combination of PayerAccountNumber and PayerSortCode or combination of PayerIBAN and PayerBIC must be provided. For international account (outside UK) provide the combination of PayerIBAN and PayerBIC only. For account within UK provide either of the three combinations.

PayerAccountNumber
string [ 0 .. 8 ] characters

Eight-digit payer account number.

PayerSortCode
string [ 0 .. 6 ] characters

Sort code of payer. Sort code to identify both the bank and the branch where the Payer account is held.

PayerIBAN
string [ 0 .. 34 ] characters

Payer IBAN. 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.

PayerBIC
string [ 0 .. 11 ] characters

Payer BIC. Bank Identifier Code (BIC) identifies the Payer'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/P2P/PayRequestedMoney
Request samples
application/json
{
  • "RequestReferenceID": 987,
  • "PayerAccountIdentifier": 88551,
  • "PayerAccountNumber": "00354336",
  • "PayerSortCode": "623053",
  • "PayerIBAN": "GB35CNFV60837000000570",
  • "PayerBIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Reject Payment

RejectPayment method rejects request of money transfer from the payee.

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.

RequestReferenceID
required
integer <int32>

The unique identifier of the request money.

PayerAccountIdentifier
integer <int32>

Unique identifier of payer account.
Note: Either PayerAccountIdentifier or combination of PayerAccountNumber and PayerSortCode or combination of PayerIBAN and PayerBIC must be provided. For international account (outside UK) provide the combination of PayerIBAN and PayerBIC only. For account within UK provide either of the three combinations.

PayerAccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number of payer.

PayerSortCode
string [ 0 .. 6 ] characters

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

PayerIBAN
string [ 0 .. 34 ] characters

Payer IBAN. 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.

PayerBIC
string [ 0 .. 11 ] characters

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

RejectReason
string [ 0 .. 200 ] characters

Rejection reason of the request.

ClientRequestReference
string [ 0 .. 50 ] characters

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

CultureID
integer <int32>

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

Responses
200

Success

400

Bad Request

500

Server Error

post/P2P/RejectPayment
Request samples
application/json
{
  • "RequestReferenceID": 987,
  • "PayerAccountIdentifier": 88551,
  • "PayerAccountNumber": "00354336",
  • "PayerSortCode": "623053",
  • "PayerIBAN": "GB35CNFV60837000000570",
  • "PayerBIC": "CNFVGB21XXX",
  • "RejectReason": "Reject request money",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Request Payment by Account Number

RequestPaymentByAccountNumber method is used to place request for money transfer. Payee place a request for payer using account number of both payee and payer, to pay requested amount.

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.

AccountNumber
required
string [ 0 .. 8 ] characters

Eight-digit account number of the consumer (payee) who sends request for money transfer.

SortCode
required
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held. Sort code of payee account who sends request for money transfer.

PayerAccountNumber
required
string [ 0 .. 8 ] characters

Eight-digit account number of the payer, who receives the request for money transfer.

PayerSortCode
required
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the payer account is held. Sort code of the payer's account who receives request for money transfer.

PayerName
string [ 0 .. 50 ] characters

Full name of the payer, who receives request for transfer money.

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

The look up value that identifies the purpose of money transfer.

1 = Auction (eBay)
2 = Auction (QXL)
3 = Auction (Other)
4 = I.O.U
5 = Goods
6 = Service
7 = Auction (eBid)
8 = Mail order
9 = Bill
10 = Other
11 = Days Out
12 = Eating Out
13 = Nights Out
14 = Taxi
15 = Gifts

Enum: "Auction_eBay" "Auction_QXL" "Auction_Other" "IOU" "Goods" "Service" "Auction_eBid" "Mail_order" "Bill" "Other" "Days_Out" "Eating_Out" "Nights_Out" "Taxi" "Gifts"
TypeDescription
string [ 0 .. 200 ] characters

Description of money transfer type. If RequestTypeID "10 = Other" is selected then description should be provided.

DeliveryMethodID
required
integer <int32> [ 0 .. 32767 ]

The look up value that identifies the method of delivery.

0 = None
1 = Royal mail - recorded delivery
2 = Royal mail - special delivery
3 = Courier next day
4 = Other

Enum: "None" "Royal_mail_recorded_delivery" "Royal_mail_special_delivery" "Courier_next_day" "Other"
DeliveryChargeAmount
integer <int32>

The fee charged for delivery.

DeliveryInDays
required
integer <int32>

Number of days required for delivery.

Tax
integer <int32>

The amount to be deducted for tax.

Description
string [ 0 .. 200 ] characters

Description of money request.

Message
string [ 0 .. 250 ] characters

The message containing the information about requested money.

ReferenceNumber
string [ 0 .. 20 ] characters

Unique reference number of the money transfer request.

Amount
required
integer <int32>

The amount that is requested to transfer in payee account. It is required to be provided in smaller denomination unit of amount. For e.g. if the amount to be transferred is 51 then the value for amount should be (51 X 100) = 5100 needs to be provided. If amount to be transferred is 5.1 then the value for amount should be (5.1 X 100) = 510 needs to be provided.

ISOCurrencyCode
required
string [ 0 .. 3 ] characters

Three-digit, ISO numeric currency code.

SendMailCopyToRequester
boolean

Boolean that identifies whether payee requires copy of requested money in mail or not. If "SendMailCopyToRequester" is set to "true" then mail copy of money request is to be sent to requestor. If "SendMailCopyToRequester" is set to "false" then mail copy of money request is not to be sent to requestor.
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/P2P/RequestPaymentByAccountNumber
Request samples
application/json
{
  • "AccountNumber": "00877278",
  • "SortCode": "623053",
  • "PayerAccountNumber": "00354336",
  • "PayerSortCode": "623053",
  • "PayerName": "Nichola",
  • "RequestTypeID": 2,
  • "TypeDescription": "string",
  • "DeliveryMethodID": 1,
  • "DeliveryChargeAmount": 0,
  • "DeliveryInDays": 13,
  • "Tax": 0,
  • "Description": "send money description",
  • "Message": "sending money message",
  • "ReferenceNumber": "RN - 123",
  • "Amount": 324,
  • "ISOCurrencyCode": "826",
  • "SendMailCopyToRequester": true,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "RequestReferenceID": 989,
  • "ExpiryDate": "2021-01-02T12:22:20.5871383+05:30",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Request Payment by Email Address

RequestPaymentByEmailAddress method is used to place request for money transfer. Payee place a request using payer's unique Email address, to pay requested amount. The request for money transfer is sent to the payer's Email Address.

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.

PayerEmailAddress
required
string [ 0 .. 100 ] characters

Email address of the payer, who receives the request for money transfer.

PayerName
string [ 0 .. 50 ] characters

Full name of the payer, who receives request for transfer money.

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

The look up value that identifies the purpose of money transfer.

1 = Auction (eBay)
2 = Auction (QXL)
3 = Auction (Other)
4 = I.O.U
5 = Goods
6 = Service
7 = Auction (eBid)
8 = Mail order
9 = Bill
10 = Other
11 = Days Out
12 = Eating Out
13 = Nights Out
14 = Taxi
15 = Gifts

Enum: "Auction_eBay" "Auction_QXL" "Auction_Other" "IOU" "Goods" "Service" "Auction_eBid" "Mail_order" "Bill" "Other" "Days_Out" "Eating_Out" "Nights_Out" "Taxi" "Gifts"
TypeDescription
string [ 0 .. 200 ] characters

Description of money transfer type. If RequestTypeID "10 = Other" is selected then description should be provided.

DeliveryMethodID
required
integer <int32> [ 0 .. 32767 ]

The look up value that identifies the method of delivery.

0 = None
1 = Royal mail - recorded delivery
2 = Royal mail - special delivery
3 = Courier next day
4 = Other

Enum: "None" "Royal_mail_recorded_delivery" "Royal_mail_special_delivery" "Courier_next_day" "Other"
DeliveryChargeAmount
integer <int32>

The fee charged for delivery.

DeliveryInDays
required
integer <int32>

Number of days required for delivery.

Tax
integer <int32>

The amount to be deducted for tax.

Description
string [ 0 .. 200 ] characters

Description of money request.

Message
string [ 0 .. 250 ] characters

The message containing the information about requested money.

ReferenceNumber
string [ 0 .. 20 ] characters

Unique reference number of the money transfer request.

Amount
required
integer <int32>

The amount that is requested to transfer in payee account. It is required to be provided in smaller denomination unit of amount. For e.g. if the amount to be transferred is 51 then the value for amount should be (51 X 100) = 5100 needs to be provided. If amount to be transferred is 5.1 then the value for amount should be (5.1 X 100) = 510 needs to be provided.

ISOCurrencyCode
required
string [ 0 .. 3 ] characters

Three-digit, ISO numeric currency code.

SendMailCopyToRequester
boolean

Boolean that identifies whether payee requires copy of requested money in mail or not. If "SendMailCopyToRequester" is set to "true" then mail copy of money request is to be sent to requestor. If "SendMailCopyToRequester" is set to "false" then mail copy of money request is not to be sent to requestor.
Valid values are true or false.

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/P2P/RequestPaymentByEmailAddress
Request samples
application/json
{
  • "PayerEmailAddress": "demo.email@demogroup.com",
  • "PayerName": "payer name",
  • "RequestTypeID": 2,
  • "TypeDescription": "",
  • "DeliveryMethodID": 1,
  • "DeliveryChargeAmount": 0,
  • "DeliveryInDays": 13,
  • "Tax": 0,
  • "Description": "send money description",
  • "Message": "sending money message",
  • "ReferenceNumber": "RN - 123",
  • "Amount": 324,
  • "ISOCurrencyCode": "826",
  • "SendMailCopyToRequester": true,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "RequestReferenceID": 989,
  • "ExpiryDate": "2021-01-02T12:22:20.5871383+05:30",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Request Payment by IBAN

RequestPaymentByIBAN method is used to place request for money transfer. Payee place a request using payer's IBAN and BIC, to pay requested amount.

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.

IBAN
required
string [ 0 .. 34 ] characters

Payee (Requestor) IBAN. 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
required
string [ 0 .. 11 ] characters

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

PayerIBAN
required
string [ 0 .. 34 ] characters

Payer IBAN. 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.

PayerBIC
required
string [ 0 .. 11 ] characters

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

PayerName
string [ 0 .. 50 ] characters

Full name of the payer, who receives request for transfer money.

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

The look up value that identifies the purpose of money transfer.

1 = Auction (eBay)
2 = Auction (QXL)
3 = Auction (Other)
4 = I.O.U
5 = Goods
6 = Service
7 = Auction (eBid)
8 = Mail order
9 = Bill
10 = Other
11 = Days Out
12 = Eating Out
13 = Nights Out
14 = Taxi
15 = Gifts

Enum: "Auction_eBay" "Auction_QXL" "Auction_Other" "IOU" "Goods" "Service" "Auction_eBid" "Mail_order" "Bill" "Other" "Days_Out" "Eating_Out" "Nights_Out" "Taxi" "Gifts"
TypeDescription
string [ 0 .. 200 ] characters

Description of money transfer type. If RequestTypeID "10 = Other" is selected then description should be provided.

DeliveryMethodID
required
integer <int32> [ 0 .. 32767 ]

The look up value that identifies the method of delivery.

0 = None
1 = Royal mail - recorded delivery
2 = Royal mail - special delivery
3 = Courier next day
4 = Other

Enum: "None" "Royal_mail_recorded_delivery" "Royal_mail_special_delivery" "Courier_next_day" "Other"
DeliveryChargeAmount
integer <int32>

The fee charged for delivery.

DeliveryInDays
required
integer <int32>

The time limit in days required to complete the delivery.

Tax
integer <int32>

The amount to be deducted for tax.

Description
string [ 0 .. 200 ] characters

Description of the money request.

Message
string [ 0 .. 250 ] characters

The message containing the information about requested money.

ReferenceNumber
string [ 0 .. 20 ] characters

Unique reference number of the money transfer request.

Amount
required
integer <int32>

The amount that is requested to transfer in payee account. It is required to be provided in smaller denomination unit of amount. For e.g. if the amount to be transferred is 51 then the value for amount should be (51 X 100) = 5100 needs to be provided. If amount to be transferred is 5.1 then the value for amount should be (5.1 X 100) = 510 needs to be provided.

ISOCurrencyCode
required
string [ 0 .. 3 ] characters

Three-digit, ISO numeric currency code.

SendMailCopyToRequester
boolean

Boolean that identifies whether payee requires copy of requested money in mail or not. If "SendMailCopyToRequester" is set to "true" then mail copy of money request is to be sent to requestor. If "SendMailCopyToRequester" is set to "false" then mail copy of money request is not to be sent to requestor.
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/P2P/RequestPaymentByIBAN
Request samples
application/json
{
  • "IBAN": "GB63CNFV60837000000066",
  • "BIC": "CNFVGB21XXX",
  • "PayerIBAN": "GB98CNFV60837000000309",
  • "PayerBIC": "CNFVGB21XXX",
  • "PayerName": "Nichola",
  • "RequestTypeID": 2,
  • "TypeDescription": "string",
  • "DeliveryMethodID": 1,
  • "DeliveryChargeAmount": 0,
  • "DeliveryInDays": 13,
  • "Tax": 0,
  • "Description": "send money description",
  • "Message": "sending money message",
  • "ReferenceNumber": "RN - 123",
  • "Amount": 324,
  • "ISOCurrencyCode": "826",
  • "SendMailCopyToRequester": true,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "RequestReferenceID": 989,
  • "ExpiryDate": "2021-01-02T12:22:20.5871383+05:30",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Request Payment by Mobile Number

RequestPaymentByMobileNumber method is used to place request for money transfer. Payee place a request using payer's mobile number, to pay requested amount. The request for money transfer is sent to the payer's mobile 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

The object req information.

PayerMobileNumber
required
string [ 0 .. 50 ] characters

Mobile number of the consumer (payer), who receives the request for transfer money.

PayerName
string [ 0 .. 50 ] characters

Full name of the payer,who receives request for transfer money.

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

The look up value that identifies the purpose of money transfer.

1 = Auction (eBay)
2 = Auction (QXL)
3 = Auction (Other)
4 = I.O.U
5 = Goods
6 = Service
7 = Auction (eBid)
8 = Mail order
9 = Bill
10 = Other
11 = Days Out
12 = Eating Out
13 = Nights Out
14 = Taxi
15 = Gifts

Enum: "Auction_eBay" "Auction_QXL" "Auction_Other" "IOU" "Goods" "Service" "Auction_eBid" "Mail_order" "Bill" "Other" "Days_Out" "Eating_Out" "Nights_Out" "Taxi" "Gifts"
TypeDescription
string [ 0 .. 200 ] characters

Description of money transfer type. If RequestTypeID "10 = Other" is selected then description should be provided.

DeliveryMethodID
required
integer <int32> [ 0 .. 32767 ]

The look up value that identifies the method of delivery.

0 = None
1 = Royal mail - recorded delivery
2 = Royal mail - special delivery
3 = Courier next day
4 = Other

Enum: "None" "Royal_mail_recorded_delivery" "Royal_mail_special_delivery" "Courier_next_day" "Other"
DeliveryChargeAmount
integer <int32>

The fee charged for delivery.

DeliveryInDays
required
integer <int32>

Number of days required for delivery.

Tax
integer <int32>

The amount to be deducted for tax.

Description
string [ 0 .. 200 ] characters

Description of money request.

Message
string [ 0 .. 250 ] characters

The message containing the information about requested money.

ReferenceNumber
string [ 0 .. 20 ] characters

Unique reference number of the money transfer request.

Amount
required
integer <int32>

The amount that is requested to transfer in payee account. It is required to be provided in smaller denomination unit of amount. For e.g. if the amount to be transferred is 51 then the value for amount should be (51 X 100) = 5100 needs to be provided. If amount to be transferred is 5.1 then the value for amount should be (5.1 X 100) = 510 needs to be provided.

ISOCurrencyCode
required
string [ 0 .. 3 ] characters

Three-digit, ISO numeric currency code.

SendMailCopyToRequester
boolean

Boolean that identifies whether payee requires copy of money request in mail or not. If "SendMailCopyToRequester" is set to "true" then mail copy of money request is to be sent to requestor. If "SendMailCopyToRequester" is set to "false" then mail copy of money request is not to be sent to requestor.
Valid values are true or false.

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/P2P/RequestPaymentByMobileNumber
Request samples
application/json
{
  • "PayerMobileNumber": "443739037971",
  • "PayerName": "Nichola",
  • "RequestTypeID": 2,
  • "TypeDescription": "",
  • "DeliveryMethodID": 1,
  • "DeliveryChargeAmount": 0,
  • "DeliveryInDays": 13,
  • "Tax": 0,
  • "Description": "send money description",
  • "Message": "sending money message",
  • "ReferenceNumber": "RN - 123",
  • "Amount": 324,
  • "ISOCurrencyCode": "826",
  • "SendMailCopyToRequester": true,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "RequestReferenceID": 989,
  • "ExpiryDate": "2021-01-02T12:22:20.5871383+05:30",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Request Payment by UserName

RequestPaymentByUserName method is used to place request for money transfer. Payee place a request using payer's User Name, to pay requested amount.

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.

PayerUserName
required
string [ 0 .. 100 ] characters

User name of the payer, who receives request for money transfer.

PayerName
string [ 0 .. 50 ] characters

Full name of the payer, who receives request for transfer money.

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

The look up value that identifies the purpose of money transfer.

1 = Auction (eBay)
2 = Auction (QXL)
3 = Auction (Other)
4 = I.O.U
5 = Goods
6 = Service
7 = Auction (eBid)
8 = Mail order
9 = Bill
10 = Other
11 = Days Out
12 = Eating Out
13 = Nights Out
14 = Taxi
15 = Gifts

Enum: "Auction_eBay" "Auction_QXL" "Auction_Other" "IOU" "Goods" "Service" "Auction_eBid" "Mail_order" "Bill" "Other" "Days_Out" "Eating_Out" "Nights_Out" "Taxi" "Gifts"
TypeDescription
string [ 0 .. 200 ] characters

Description of money transfer type. If RequestTypeID "10 = Other" is selected then description should be provided.

DeliveryMethodID
required
integer <int32> [ 0 .. 32767 ]

The look up value that identifies the method of delivery.

0 = None
1 = Royal mail - recorded delivery
2 = Royal mail - special delivery
3 = Courier next day
4 = Other

Enum: "None" "Royal_mail_recorded_delivery" "Royal_mail_special_delivery" "Courier_next_day" "Other"
DeliveryChargeAmount
integer <int32>

The fee charged for delivery.

DeliveryInDays
required
integer <int32>

Number of days required for delivery.

Tax
integer <int32>

The amount to be deducted for tax.

Description
string [ 0 .. 200 ] characters

Description of money request.

Message
string [ 0 .. 250 ] characters

The message containing the information about requested money.

ReferenceNumber
string [ 0 .. 20 ] characters

Unique reference number of the money transfer request.

Amount
required
integer <int32>

The amount that is requested to transfer in payee account. It is required to be provided in smaller denomination unit of amount. For e.g. if the amount to be transferred is 51 then the value for amount should be (51 X 100) = 5100 needs to be provided. If amount to be transferred is 5.1 then the value for amount should be (5.1 X 100) = 510 needs to be provided.

ISOCurrencyCode
required
string [ 0 .. 3 ] characters

Three-digit, ISO numeric currency code.

SendMailCopyToRequester
boolean

Boolean that identifies whether payee requires copy of requested money in mail or not. If "SendMailCopyToRequester" is set to "true" then mail copy of money request is to be sent to requestor. If "SendMailCopyToRequester" is set to "false" then mail copy of money request is not to be sent to requestor.
Valid values are true or false.

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/P2P/RequestPaymentByUserName
Request samples
application/json
{
  • "PayerUserName": "User name of Payer",
  • "PayerName": "payer name",
  • "RequestTypeID": 2,
  • "TypeDescription": "",
  • "DeliveryMethodID": 1,
  • "DeliveryChargeAmount": 0,
  • "DeliveryInDays": 13,
  • "Tax": 0,
  • "Description": "send money description",
  • "Message": "sending money message",
  • "ReferenceNumber": "RN - 123",
  • "Amount": 324,
  • "ISOCurrencyCode": "826",
  • "SendMailCopyToRequester": true,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "RequestReferenceID": 989,
  • "ExpiryDate": "2021-01-02T12:22:20.5871383+05:30",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Send Money

SendMoney method is used to transfer money from payer to payee account. Send money can be a response of RequestMoney when payer accepts the request and sends money to payee. Consumer (Payer) can send money to recipient (payee) without any request also.

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.

SenderAccountNumber
required
string [ 0 .. 8 ] characters

Eight-digit account number of payer's account.

SenderSortCode
required
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the sender (payer) account is held.

SenderName
required
string [ 0 .. 100 ] characters

Name of the payer.

RecipientAccountNumber
required
string [ 0 .. 8 ] characters

Eight-digit account number of recipient.

RecipientSortCode
required
string [ 0 .. 6 ] characters

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

ReasonID
required
integer <int32> [ 1 .. 2147483647 ]

The look up value to identify the reason of money transfer by sender (payer).

1 = Auction (ebay)
2 = Gifts
3 = Main Order
4 = Bill
5 = Other
6 = Auction (Other)
7 = Auction (QXL)
8 = Auction (ebid)
9 = I.O.U.
10 = Goods
11 = Service
12 = Days Out
13 = Eating Out
14 = Nights Out
15 = Taxi

Enum: "None" "Auction_Ebay" "Gifts" "Mail_Order" "Bill" "Other" "Auction_Other" "Auction_Qxl" "Auction_Ebid" "IOU" "Goods" "Service" "Days_Out" "Eating_Out" "Nights_Out" "Taxi"
Amount
required
integer <int32>

The amount that is to be transferred to recipient account. It is required to be provided in smaller denomination unit of amount. For e.g. if the amount to be transferred is 51 then the value for amount should be (51 X 100) = 5100 needs to be provided. If amount to be transferred is 5.1 then the value for amount should be (5.1 X 100) = 510 needs to be provided.

ReasonDescription
string [ 0 .. 200 ] characters

Description of money transfer type. If ReasonID "5 = Other" is selected then description should be provided.

Message
string [ 0 .. 250 ] characters

The message for money transfer.

Reference
string [ 0 .. 50 ] characters

Unique reference number of the send money transaction generated by payer.

SendMailCopytoSender
boolean

Boolean that identifies whether sender requires copy of money sent in mail or not. If "SendMailCopytoSender" is set to "true" then mail copy of send money is to be sent to sender. If "SendMailCopytoSender" is set to "false" then mail copy of send money is not to be sent to sender.
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/P2P/SendMoney
Request samples
application/json
{
  • "SenderAccountNumber": "00877278",
  • "SenderSortCode": "623053",
  • "SenderName": "Name of the sender",
  • "RecipientAccountNumber": "00354336",
  • "RecipientSortCode": "623053",
  • "ReasonID": 1,
  • "Amount": 324,
  • "ReasonDescription": "description",
  • "Message": "sending money message",
  • "Reference": "reference 123",
  • "SendMailCopytoSender": false,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "SendMoneyReferenceID": 3416,
  • "ExpiryDate": "2021-01-01T12:22:21.1266565+05:30",
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Send Money by Email Address

SendMoneyByEmailAddress method is used to transfer money from payer to payee account using recipient's email address.

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.

SenderAccountIdentifier
integer <int32>

Unique identifier of sender account.
Note: Either SenderAccountIdentifier or combination of SenderAccountNumber and SenderSortCode or combination of SenderIBAN and SenderBIC must be provided. For international account (outside UK) provide the combination of SenderIBAN and SenderBIC only. For account within UK provide either of the three combinations.

SenderAccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number of the payer.

SenderSortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the consumer (sender) account is held.

SenderIBAN
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.

SenderBIC
string [ 0 .. 11 ] characters

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

SenderName
required
string [ 0 .. 100 ] characters

Name of the payer.

RecipientEmailAddress
required
string [ 0 .. 100 ] characters

Email address of the recipient (payee), whom money to be sent.

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

The look up value that identifies the purpose of money transfer.

1 = Auction (ebay)
2 = Gifts
3 = Main Order
4 = Bill
5 = Other
6 = Auction (Other)
7 = Auction (QXL)
8 = Auction (ebid)
9 = I.O.U.
10 = Goods
11 = Service
12 = Days Out
13 = Eating Out
14 = Nights Out
15 = Taxi

Enum: "None" "Auction_Ebay" "Gifts" "Mail_Order" "Bill" "Other" "Auction_Other" "Auction_Qxl" "Auction_Ebid" "IOU" "Goods" "Service" "Days_Out" "Eating_Out" "Nights_Out" "Taxi"
Amount
required
integer <int32>

The amount that is to be transferred to recipient account. It is required to be provided in smaller denomination unit of amount. For e.g. if the amount to be transferred is 51 then the value for amount should be (51 X 100) = 5100 needs to be provided. If amount to be transferred is 5.1 then the value for amount should be (5.1 X 100) = 510 needs to be provided.

ReasonDescription
string [ 0 .. 200 ] characters

Description of money transfer type. If ReasonID "5 = Other" is selected then description should be provided.

Message
string [ 0 .. 250 ] characters

The message for money transfer.

Reference
string [ 0 .. 50 ] characters

Unique reference number of the send money transaction generated by payer.

SendMailCopytoSender
boolean

Boolean that identifies whether sender requires copy of money sent in mail or not. If "SendMailCopytoSender" is set to "true" then mail copy of send money is to be sent to sender. If "SendMailCopytoSender" is set to "false" then mail copy of send money is not to be sent to sender.
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/P2P/SendMoneyByEmailAddress
Request samples
application/json
{
  • "SenderAccountIdentifier": 88551,
  • "SenderAccountNumber": "00877278",
  • "SenderSortCode": "623053",
  • "SenderIBAN": "GB35CNFV60837000000570",
  • "SenderBIC": "CNFVGB21XXX",
  • "SenderName": "Name of the sender",
  • "RecipientEmailAddress": "demo.email@demogroup.com",
  • "ReasonID": 1,
  • "Amount": 324,
  • "ReasonDescription": "description",
  • "Message": "sending money message",
  • "Reference": "reference 123",
  • "SendMailCopytoSender": false,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "SendMoneyReferenceID": 3427,
  • "ExpiryDate": "2021-01-02T12:22:21.3081701+05:30",
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Send Money by IBAN

Transfers money from payer to payee account. The money is immediately credited in the account of the payee (beneficiary) using IBAN.

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.

SenderIBAN
required
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.

SenderBIC
required
string [ 0 .. 11 ] characters

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

SenderName
required
string [ 0 .. 100 ] characters

Name of the payer.

RecipientIBAN
required
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.

RecipientBIC
required
string [ 0 .. 11 ] characters

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

ReasonID
required
integer <int32> [ 1 .. 2147483647 ]

The look up value that identifies the purpose of money transfer.

1 = Auction (ebay)
2 = Gifts
3 = Main Order
4 = Bill
5 = Other
6 = Auction (Other)
7 = Auction (QXL)
8 = Auction (ebid)
9 = I.O.U.
10 = Goods
11 = Service
12 = Days Out
13 = Eating Out
14 = Nights Out
15 = Taxi

Enum: "None" "Auction_Ebay" "Gifts" "Mail_Order" "Bill" "Other" "Auction_Other" "Auction_Qxl" "Auction_Ebid" "IOU" "Goods" "Service" "Days_Out" "Eating_Out" "Nights_Out" "Taxi"
Amount
required
integer <int32>

The amount that is to be transferred to recipient account. It is required to be provided in smaller denomination unit of amount. For e.g. if the amount to be transferred is 51 then the value for amount should be (51 X 100) = 5100 needs to be provided. If amount to be transferred is 5.1 then the value for amount should be (5.1 X 100) = 510 needs to be provided.

ReasonDescription
string [ 0 .. 200 ] characters

Description of money transfer type. If ReasonID "5 = Other" is selected then description should be provided.

Message
string [ 0 .. 250 ] characters

The message for money transfer.

Reference
string [ 0 .. 50 ] characters

Unique reference number of the send money transaction generated by payer.

SendMailCopytoSender
boolean

Boolean that identifies whether sender requires copy of money sent in mail or not. If "SendMailCopytoSender" is set to "true" then mail copy of send money is to be sent to sender. If "SendMailCopytoSender" is set to "false" then mail copy of send money is not to be sent to sender.
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/P2P/SendMoneyByIBAN
Request samples
application/json
{
  • "SenderIBAN": "GB63CNFV60837000000066",
  • "SenderBIC": "CNFVGB21XXX",
  • "SenderName": "Name of the sender",
  • "RecipientIBAN": "GB98CNFV60837000000309",
  • "RecipientBIC": "CNFVGB21XXX",
  • "ReasonID": 1,
  • "Amount": 324,
  • "ReasonDescription": "description",
  • "Message": "sending money message",
  • "Reference": "reference 123",
  • "SendMailCopytoSender": false,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "SendMoneyReferenceID": 3416,
  • "ExpiryDate": "2021-01-01T12:22:21.1266565+05:30",
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Send Money by Mobile Number

SendMoneyByMobileNumber method is used to transfer money from payer to payee account using recipient's mobile 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

The object req information.

SenderAccountIdentifier
integer <int32>

Unique identifier of sender account.
Note: Either SenderAccountIdentifier or combination of SenderAccountNumber and SenderSortCode or combination of SenderIBAN and SenderBIC must be provided. For international account (outside UK) provide the combination of SenderIBAN and SenderBIC only. For account within UK provide either of the three combinations.

SenderAccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number of the payer.

SenderSortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the consumer (sender) account is held.

SenderIBAN
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.

SenderBIC
string [ 0 .. 11 ] characters

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

SenderName
required
string [ 0 .. 100 ] characters

Name of the payer.

RecipientMobileNumber
required
string [ 0 .. 50 ] characters

Mobile number of the recipient (payee), whom money to be sent.

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

The look up value that identifies the purpose of money transfer.

1 = Auction (ebay)
2 = Gifts
3 = Main Order
4 = Bill
5 = Other
6 = Auction (Other)
7 = Auction (QXL)
8 = Auction (ebid)
9 = I.O.U.
10 = Goods
11 = Service
12 = Days Out
13 = Eating Out
14 = Nights Out
15 = Taxi

Enum: "None" "Auction_Ebay" "Gifts" "Mail_Order" "Bill" "Other" "Auction_Other" "Auction_Qxl" "Auction_Ebid" "IOU" "Goods" "Service" "Days_Out" "Eating_Out" "Nights_Out" "Taxi"
Amount
required
integer <int32>

The amount that is to be transferred to recipient account. It is required to be provided in smaller denomination unit of amount. For e.g. if the amount to be transferred is 51 then the value for amount should be (51 X 100) = 5100 needs to be provided. If amount to be transferred is 5.1 then the value for amount should be (5.1 X 100) = 510 needs to be provided.

ReasonDescription
string [ 0 .. 200 ] characters

Description of money transfer type. If ReasonID "5 = Other" is selected then description should be provided.

Message
string [ 0 .. 250 ] characters

The message for money transfer.

Reference
string [ 0 .. 50 ] characters

Unique reference number of the send money transaction generated by payer.

SendMailCopytoSender
boolean

Boolean that identifies whether sender requires copy of money sent in mail or not. If "SendMailCopytoSender" is set to "true" then mail copy of send money is to be sent to sender. If "SendMailCopytoSender" is set to "false" then mail copy of send money is not to be sent to sender.
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/P2P/SendMoneyByMobileNumber
Request samples
application/json
{
  • "SenderAccountIdentifier": 68747,
  • "SenderAccountNumber": "00877278",
  • "SenderSortCode": "623053",
  • "SenderIBAN": "GB35CNFV60837000000570",
  • "SenderBIC": "CNFVGB21XXX",
  • "SenderName": "Name of the sender",
  • "RecipientMobileNumber": "443739037971",
  • "ReasonID": 1,
  • "Amount": 324,
  • "ReasonDescription": "description",
  • "Message": "sending money message",
  • "Reference": "reference 123",
  • "SendMailCopytoSender": false,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "SendMoneyReferenceID": 3417,
  • "ExpiryDate": "2021-01-02T12:22:21.2174468+05:30",
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Send Money by UserName

SendMoneyByUserName method is used to transfer money from payer to payee account using recipient's User name.

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 req object information.

SenderAccountNumber
string [ 0 .. 8 ] characters

Account number of the payer.
Note: Either combination of SenderAccountNumber and SenderSortCode or combination of SenderIBAN and SenderBIC must be provided. For international account (outside UK) provide the combination of SenderIBAN and SenderBIC only. For account within UK  provide either of the two combinations.

SenderSortCode
string [ 0 .. 6 ] characters

Sort code of payer's account.

SenderIBAN
string [ 0 .. 34 ] characters

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

SenderBIC
string [ 0 .. 11 ] characters

Bank Identifier Code that identifies the name, country and branch of the bank. Used for quick, accurate and automated money transfer.

SenderName
required
string [ 0 .. 100 ] characters

Name of the payer.

RecipientUserName
required
string [ 0 .. 100 ] characters

User name of payee.

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

The look up value of the reason of money transfer.

1 = Auction (ebay)
2 = Gifts
3 = Main Order
4 = Bill
5 = Other
6 = Auction (Other)
7 = Auction (QXL)
8 = Auction (ebid)
9 = I.O.U.
10 = Goods
11 = Service
12 = Days Out
13 = Eating Out
14 = Nights Out
15 = Taxi

Enum: "None" "Auction_Ebay" "Gifts" "Mail_Order" "Bill" "Other" "Auction_Other" "Auction_Qxl" "Auction_Ebid" "IOU" "Goods" "Service" "Days_Out" "Eating_Out" "Nights_Out" "Taxi"
Amount
required
integer <int32>

The amount that is to be transferred to recipient account. It is required to be provided in smaller denomination unit of amount. For e.g. if the amount to be transferred is 51 then the value for amount should be (51 X 100) = 5100 needs to be provided. If amount to be transferred is 5.1 then the value for amount should be (5.1 X 100) = 510 needs to be provided.

ReasonDescription
string [ 0 .. 200 ] characters

Description of the "other" reason, when "other" option is selected in the reason field.

Message
string [ 0 .. 250 ] characters

The message to be sent along with money transfer.

Reference
string [ 0 .. 50 ] characters

Unique identifier of the money transfer request.

SendMailCopytoSender
boolean

Identifies if payer requires transaction record in email or not. If value = 'false' then no email is generated. If value = 'true', then email is generated and sent to payer.
Valid values are true or false.

SenderAccountIdentifier
integer <int32>

Unique identifier of 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/P2P/SendMoneyByUserName
Request samples
application/json
{
  • "SenderAccountNumber": "00885511",
  • "SenderSortCode": "623053",
  • "SenderIBAN": "GB21CNFV60837000885511",
  • "SenderBIC": "CNFVGB21XXX",
  • "SenderName": "Name of the sender",
  • "RecipientUserName": "User name of recipient",
  • "ReasonID": 1,
  • "Amount": 324,
  • "ReasonDescription": "description",
  • "Message": "sending money message",
  • "Reference": "reference 123",
  • "SendMailCopytoSender": false,
  • "SenderAccountIdentifier": 88551,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "SendMoneyReferenceID": 3427,
  • "ExpiryDate": "2021-01-02T12:22:21.376986+05:30",
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Transfer

Transfer method is used to transfer the fund from Solaris consumer account to recipient account. It debits the specified amount from Solaris consumer account and credits the amount to recipient bank account if AvailableBalance in consumer account is sufficient for fund transfer.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

The request information.

RecipientReferenceID
required
integer <int32>

Unique reference identifier of the recipient linked with consumer for fund transfer.

Amount
required
integer <int64>

The amount that is to be transferred to recipient account. It is required to be provided in smaller denomination unit of amount. For e.g. if the amount to be transferred is 51 then the value for amount should be (51 X 100) = 5100 needs to be provided.
If amount to be transferred is 5.1 then the value for amount should be (5.1 X 100) = 510 needs to be provided.
Description
string [ 0 .. 200 ] characters

The description of fund transfer.

ReferenceNumber
string [ 0 .. 18 ] characters

Reference Number.

ClientReferenceNumber
string [ 0 .. 50 ] characters

Consumer provided reference number for tracking transfer request on the Solaris platform.

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/P2P/Transfer
Request samples
application/json
{
  • "RecipientReferenceID": 52093,
  • "Amount": 6937,
  • "Description": "transfer",
  • "ReferenceNumber": "",
  • "ClientReferenceNumber": "",
  • "RequesterConsumerID": 0,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "TransferReferenceID": 2422647,
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update Beneficiary Status

UpdateBeneficiaryStatus method is used to update the status of recipient account like trusted or untrusted based upon transfers performed to recipient account.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

The object req information.

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

required
Array of objects (BeneficiaryStatusReq)

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

ClientRequestReference
string [ 0 .. 50 ] characters

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

CultureID
integer <int32>

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

Responses
200

Success

400

Bad Request

500

Server Error

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