Xpay API (V2)

Download OpenAPI specification:Download

XPay

Provides methods to manage XPay tokens.

Activate XPay Token

Activates a new XPay token.

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

ActivateTokenReq

CardID
required
integer <int32>

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

TokenID
required
integer <int32>

Unique identifier of the token.

Reason
required
string

Reason for changing status of token.

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

Delete XPay Token

Permanently removes the XPay token.

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

DeleteTokenReq

CardID
required
integer <int32>

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

TokenID
required
integer <int32>

Unique identifier of the token.

Reason
required
string

Reason for changing status of token.

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

Get Eligible Token Requestors

This API is used to retrieve information about Token Requestors that have been enabled for one or more of the Issuers account ranges.

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

GetEligibleTokenRequestorsReq

requestId
required
string [ 1 .. 64 ] characters

Unique identifier for the request.

accountRanges
required
Array of strings

Array of the starting numbers of the account ranges to retrieve the enabled Token Requestors for

supportsTokenConnect
boolean

A boolean parameter to receive only token requestors that support Token Connect or not.
Valid values are true or false.

ClientRequestReference
string [ 0 .. 50 ] characters

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

CultureID
integer <int32>

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

Responses
200

Success

400

Bad Request

500

Server Error

post/XPay/GetEligibleTokenRequestors
Request samples
application/json
{
  • "requestId": "123456",
  • "accountRanges": 182,
  • "supportsTokenConnect": true,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "responseId": "123456",
  • "tokenRequestors": [
    ],
  • "errors": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

GetTokenRequestorAsset

This API is used to retrieve static Assets from MDES repository, such as the Token Requestor logo. Every Asset in the repository is referenced using an Asset ID.

Request
path Parameters
assetId
required
string

string

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.

Responses
200

Success

400

Bad Request

500

Server Error

get/XPay/GetTokenRequestorAsset/{assetId}
Response samples
application/json
{
  • "mediaContents": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get XPay in app Activation PayLoad

GetXPayInAppActivationPayLoad method is used to generate In App activation payload.

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

ProvisioningPayLoadReq

CardID
integer <int32>

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

TokenRequestorCode
string

Token requestor code here we only support Apple Pay(APLPAY)

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/XPay/GetXPayInAppActivationPayLoad
Request samples
application/json
{
  • "CardID": 14023,
  • "TokenRequestorCode": "APLPAY",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ActivationData": "bmV0d29yayBzcGVjaWZpYw==",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get XPay in app Provisioning PayLoad

GetXPayInAppProvisioningPayLoad method is used to generate In App provisioning payload.

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

ProvisioningPayLoadReq

CertificateLeaf
string

Leaf Certificate provided by Apple.

CertificateSubCA
string

SubCA Certificate provided by Apple.

Nonce
string

Nonce provided by Apple in hexadecimal string format.

NonceSignature
string

NonceSignature provided by Apple in hexadecimal string format.

CardID
integer <int32>

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

TokenRequestorCode
string

Token requestor code whether this request is for Google Pay(GGLPAY) / Samsung Pay(SAMPAY) / Apple Pay(APLPAY)

AppID
string

Unique identifier for the client application

DeviceID
string

Unique identifier of the mobile device.

WalletAccountID
string

Client-provided consumer ID that identifies the Wallet Account Holder entity.

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/XPay/GetXPayInAppProvisioningPayLoad
Request samples
application/json
{
  • "CertificateLeaf": "MIID/TCCA6OgAwIBAgIIGM2CpiS9WyYwCgYIKoZIzj0EAwIwgYAxNDAyBgNVBAMMK0FwcGxlIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENBIC0gRzIxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xODA2MDEyMjE0MTVaFw0yMDA2MzAyMjE0MTVaMGwxMjAwBgNVBAMMKWVjYy1jcnlwdG8tc2VydmljZXMtZW5jaXBoZXJtZW50X1VDNi1QUk9EMRQwEgYDVQQLDAtpT1MgU3lzdGVtczETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAASzCVyQGX3syyW2aI6nyfNQe+vjjzjU4rLO0ZiWiVZZSmEzYfACFI8tuDFiDLv9XWrHEeX0/yNtGVjwAzpanWb/o4ICGDCCAhQwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBSEtoTMOoZichZZlOgao71I3zrfCzBHBggrBgEFBQcBAQQ7MDkwNwYIKwYBBQUHMAGGK2h0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDMtYXBwbGV3d2RyY2EyMDUwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxld3dkcmNhMi5jcmwwHQYDVR0OBBYEFI5aYtQKaJCRpvI1Dgh+Ra4x2iCrMA4GA1UdDwEB/wQEAwIDKDASBgkqhkiG92NkBicBAf8EAgUAMAoGCCqGSM49BAMCA0gAMEUCIAY/9gwN/KAAw3EtW3NyeX1UVM3fO+wVt0cbeHL8eM/mAiEAppLm5O/2Ox8uHkxI4U/kU5vDhJA21DRbzm2rsYN+EcQ=",
  • "CertificateSubCA": "MIIC9zCCAnygAwIBAgIIb+/Y9emjp+4wCgYIKoZIzj0EAwIwZzEbMBkGA1UEAwwSQXBwbGUgUm9vdCBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwHhcNMTQwNTA2MjM0MzI0WhcNMjkwNTA2MjM0MzI0WjCBgDE0MDIGA1UEAwwrQXBwbGUgV29ybGR3aWRlIERldmVsb3BlciBSZWxhdGlvbnMgQ0EgLSBHMjEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE3fC3BkvP3XMEE8RDiQOTgPte9nStQmFSWAImUxnIYyIHCVJhysTZV+9tJmiLdJGMxPmAaCj8CWjwENrp0C7JGqOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUhLaEzDqGYnIWWZToGqO9SN863wswDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDwQCBQAwCgYIKoZIzj0EAwIDaQAwZgIxANmxxzHGI/ZPTdDZR8V9GGkRh3En02it4Jtlmr5s3z9GppAJvm6hOyywUYlBPIfSvwIxAPxkUolLPF2/axzCiZgvcq61m6oaCyNUd1ToFUOixRLal1BzfF7QbrJcYlDXUfE6Wg==",
  • "Nonce": "ea07fc0a",
  • "NonceSignature": "40a37b279e5da4c0a86119b7581312a122c424ed13571a550e0e4270aeed35b2078db329b92b4997a51d90a7f8b10104e545427901d392113eb58310cde304d793d40937de3794f5ff8951b26ee0cf27c4",
  • "CardID": 14023,
  • "TokenRequestorCode": "APLPAY",
  • "AppID": "solaris-canvas-androidapp",
  • "DeviceID": "000000000000000000000000000000000000000000000000",
  • "WalletAccountID": "Zmn0D_WHF6BuLGaGYceiq1Zl",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "EncryptedData": "4+9rov+gW2mF/hKePLaEXE6h6UrpjTGlOKTiSQb7cg12TWQIlM2d587AARQ5ZlGhzK7c9IDFepWeklwESSuc + F / HEfqzy + 0Q3CupmiuwY87 /jeE =",
  • "EphemeralPublicKey": "BJmm9C6D6k8VCnh4D/tWLJzbm3UHvF0oy/v4zD7wr2izbmDLENtpEngw9/iZSSAXCJ47c8g/zw698sBrYTw / iLc = ",
  • "ActivationData": "bmV0d29yayBzcGVjaWZpYw==",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List XPay Tokens

Returns list of XPay tokens based on the search criteria.

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

ListTokensReq

DeviceID
string

Unique identifier of the mobile device.

WalletAccountID
string

Client-provided consumer ID that identifies the Wallet Account Holder entity.

TokenRequestorCode
string

Token requestor code whether consumer wants to get list of tokens for GooglePay(GGLPAY) / SamsungPay(SAMPAY) / ApplePay(APLPAY)

CardID
required
integer <int32>

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

ClientRequestReference
string [ 0 .. 50 ] characters

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

CultureID
integer <int32>

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

Responses
200

Success

400

Bad Request

500

Server Error

post/XPay/ListXPayTokens
Request samples
application/json
{
  • "DeviceID": "000000000000000000000000000000000000000000000000",
  • "WalletAccountID": "Zmn0D_WHF6BuLGaGYceiq1Zl",
  • "TokenRequestorCode": "GGLPAY",
  • "CardID": 14023,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "XPayTokenResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Push Mutiple Accounts

This API is used to Push multiple Cards and/or multiple Financial Account to a given Token Requestor.

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

PushAccountsPayLoadReq

requestId
required
string [ 1 .. 64 ] characters

Unique identifier for the request.

CardID
integer <int32>

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

TokenRequestorCode
string

Token requestor code whether this request is for Google Pay(GGLPAY) / Samsung Pay(SAMPAY) / Apple Pay(APLPAY)

AppID
string

Unique identifier for the client application

DeviceID
string

Unique identifier of the mobile device.

WalletAccountID
string

Client-provided consumer ID that identifies the Wallet Account Holder entity.

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/XPay/PushMultipleAccounts
Request samples
application/json
{
  • "requestId": "123456",
  • "CardID": 14023,
  • "TokenRequestorCode": "APLPAY",
  • "AppID": "solaris-canvas-androidapp",
  • "DeviceID": "000000000000000000000000000000000000000000000000",
  • "WalletAccountID": "Zmn0D_WHF6BuLGaGYceiq1Zl",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "responseId": "123456",
  • "pushAccountReceipts": [
    ],
  • "availablePushMethods": [],
  • "tokenRequestorSignatureSupport": true,
  • "signature": "ew0KImFsZyI6ICJSUzI1NiIsDQoNCiJraWQiOiAiYXNkZmctcXdlcnR5LXp4Y3ZiIg0KfQ.ew0KDQrCoCJwdXNoQWNjb3VudFJlY2VpcHQiOiAiTUNDLVNUTC0xMzQzMTNCRi01NTg1LTRFNzEtQUIyNC1FQ0RCQzI4RjIzRjEiLA0KImlzc3VlckNhbGxCYWNrIjogImh0dHBzOi8vaXNzdWVyY2FsbGJhY2sudXJsIiwNCiJjYWxsYmFja1JlcXVpcmVkIjogdHJ1ZSwNCiJjb21wbGV0ZVdlYnNpdGVBY3RpdmF0aW9uIjogdHJ1ZSwNCiJhY2NvdW50SG9sZGVyRGF0YVN1cHBsaWVkIjogdHJ1ZSwNCiJsb2NhbGUiOiAiZW5fVVMiDQoNCn0.dBjftJeZ4CVP-",
  • "Errors": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Resend Activation Code

Sends a new activation code for the specified token to the account holder.

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

ActivateTokenReq

CardID
required
integer <int32>

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

TokenID
required
integer <int32>

Unique identifier of the token.

Reason
required
string

Reason for changing status of token.

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

Resume XPay Token

Changes the status of the XPay token from inactive/suspended to active.

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

ResumeTokenReq

CardID
required
integer <int32>

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

TokenID
required
integer <int32>

Unique identifier of the token.

Reason
required
string

Reason for changing status of token.

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

Suspend XPay Token

Suspends the specified XPay token without deleting it.

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

SuspendTokenReq

CardID
required
integer <int32>

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

TokenID
required
integer <int32>

Unique identifier of the token.

Reason
required
string

Reason for changing status of token.

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/XPay/SuspendXPayToken
Request samples
application/json
{
  • "CardID": 16263,
  • "TokenID": 182,
  • "Reason": "",
  • "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.