Get Started
Sandbox
Use Sandbox to try API
You can download Postman collection of API requests to test some basic card management functions of SmartVista suite.
Download Postman collection
Common characteristics
All Methods are HTTP POST
Content-Type: application/json
for both Requests and Responses
Authentication
Basic access authentication is a method for an HTTP user to provide a user name and password when making a request.
In basic HTTP authentication, a request contains a header field in the form of Authorization: Basic <credentials>
, where credentials is the Base64 encoding of ID and password joined by a single colon :
.
Customers
registerCustomer
Registers a new customer in SmartVista and creates an account.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
productName |
string |
Customer template ID to be used for customer creation. The Sandbox has only one customer template and this value should always be "CRCU1001" for the Sandbox customers. |
Yes |
parameters |
Object |
Parameter list. The exact list depends on the customer creation template for a specific project. We have created one for the Sandbox and you can see the required parameters below this table |
Yes |
parameters.name |
string |
Identify a parameter in the customer template for which the corresponding value is set. |
Yes |
parameters.value |
string |
The value to be set for the specific parameter. |
Request example
{
"productName": "CRCU1001",
"parameters": [
{
"name": "institutionId",
"value": "3006"
},
{
"name": "agent_number",
"value": "3006"
},
{
"name": "customer_number",
"value": "3006P_0000003"
},
{
"name": "product_id",
"value": "70000304"
},
{
"name": "start_date",
"value": "2021-09-06"
},
{
"name": "service_id_acc",
"value": "70000305"
},
{
"name": "surname",
"value": "Smith"
},
{
"name": "firstName",
"value": "John"
},
{
"name": "secondName",
"value": "A."
},
{
"name": "email",
"value": "johnsmith@email.com"
},
{
"name": "mobile_phone",
"value": "319220977338"
},
{
"name": "country_code",
"value": "528"
},
{
"name": "region",
"value": "BJ"
},
{
"name": "city",
"value": "Utrecht"
},
{
"name": "street",
"value": "Papendorpseweg"
},
{
"name": "house",
"value": "99"
},
{
"name": "apartament",
"value": "1"
},
{
"name": "postal_code",
"value": "3528"
}
]
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
customerNumber |
string |
Client number. You will receive the one you send in the request as the Sandbox configured to set the requested number to a created customer. |
Yes |
accountNumber |
string |
Account number. The Sandbox returns the account number it creates for the Customer. |
Response example
{
"customerNumber": "3006P_0000003",
"accountNumber": "3006978700000000108"
}
getCustomerInfo
Get customer information.
Request parameters
Mandatory |
Name |
Type |
Description |
No |
accountNumber |
string |
Account number. |
Yes |
customerNumber |
string |
Client number. |
Request example
{
"customerNumber": "3210_P004"
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
customerNumber |
string |
Client number. |
Yes |
customerName |
string |
Client name. |
No |
limits |
Object |
Limit list. |
Yes |
limits.limitName |
string |
Limit name. |
Yes |
limits.limitType |
string |
Limit name. |
No |
limits.value |
long |
Limit value |
No |
limits.currentValue |
long |
Current value |
No |
accounts |
Object |
Account list. |
Yes |
accounts.accountNumber |
string |
Account number. |
Yes |
accounts.accountType |
string |
Account type. |
Yes |
accounts.product |
Object |
Product parameters. |
Yes |
product.productNumber |
string |
Product number. |
Yes |
product.productName |
string |
Product name. |
No |
accounts.balances |
Object |
Account balance list. |
Yes |
balances.type |
string |
Balance type. |
Yes |
balances.value |
long |
Balance value |
Response example
{
"customerNumber": "3210_P004",
"customerName": "Smith John A.",
"limits": [
{
"limitName": "Customer-level credit limit",
"limitType": "LMTP0901",
"value": 0,
"currentValue": 0
},
{
"limitName": "Customer-level cash advance credit limit",
"limitType": "LMTP0902",
"value": 0,
"currentValue": 0
}
],
"accounts": [
{
"accountNumber": "3210978700000000579",
"accountType": "ACTP0100",
"balances": []
}
]
}
isCustomerExist
Check whether customer id exists.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
customerNumber |
string |
Customer number. |
No |
institutionId |
integer |
Institution id |
Request example
{
"customerNumber": 1002,
"institutionId": 7001
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
result |
boolean |
Institution id. |
Response example
Accounts
changeAccountLimit
Change account limit.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
accountNumber |
string |
Account number. |
Yes |
limit |
Object |
Limit parameters. |
Yes |
limit.name |
string |
Limit name at SVBO. |
No |
limit.startDate |
DateTime |
Limit start date. format: date-time |
No |
limit.endDate |
DateTime |
Limit end date. |
No |
limit.value |
long |
Limit value |
No |
limit.cycleType |
integer |
Cycle type |
No |
limit.cycleLength |
integer |
Cycle length |
No |
limit.currency |
integer |
Currency |
No |
limit.currentValue |
long |
Current limit value |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Request example
{
"accountNumber": 4000010000000003,
"limit": {
"name": "LMTTC01",
"startDate": "2015-02-15",
"endDate": "2015-02-20",
"value": 10000000,
"cycleType": 4,
"cycleLength": 1
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
getAccountLimits
Get account limits list.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
accountNumber |
string |
account number. |
Request example
{
"accountNumber": 4000010000000003
}
Response example
{
"limits": [
{
"name": "LMTTC01",
"value": 10000000,
"cycleType": 4,
"cycleLength": 1,
"currency": 978,
"currentValue": 0,
"limitExceptions": [
{
"limitName": "LMTTA02",
"startDate": "2014-12-30",
"endDate": "2014-12-31",
"value": 10000,
"cycleType": 0,
"cycleLength": 0
}
]
}
changeAccountStatus
Change account status.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
accountNumber |
string |
Account number. |
Yes |
accountStatus |
integer |
Account status |
Request example
{
"accountNumber": 2652,
"accountStatus": 1
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
changeAccountStatusInFe
Change SVFE (SmartVista Front End) account status.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
accountNumber |
string |
Account number. |
Yes |
accountStatus |
integer |
Account status |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Request example
{
"accountNumber": 3210978700000000579,
"accountStatus": 1
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
{
"responseCode": "00",
"processingCode": "810000",
"systemTraceAuditNumber": 451959,
"localTransactionDate": "2021-11-11T11:45:03"
}
getAccountData
Get account details.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
accountNumber |
string |
Account number. |
No |
returnCardNumber |
boolean |
Shows whether or not it is necessary to include full card number in response. |
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
accountData |
Object |
Account parameters. |
Yes |
accountData.number |
string |
Account number. |
Yes |
accountData.currency |
integer |
Account currency |
No |
accountData.currencyAlphaCode |
string |
Account currency letter code. |
Yes |
accountData.balance |
integer |
Account balance. |
No |
accountData.creditLimit |
integer |
Credit limit. |
Yes |
accountData.customerId |
string |
Client id. |
No |
accountData.defaultAccount |
boolean |
Default account indicator. |
Yes |
accountData.cards |
Object |
Card list for the account. |
No |
cards.cardType |
string |
Card type. |
No |
cards.cardNumber |
string |
Card number. |
No |
cards.expiryDate |
string |
Card expiration date. |
No |
cards.cardStatus |
string |
Card status. |
No |
cards.accountNumber |
string |
Account number. |
No |
cards.accountStatus |
string |
Account status. |
No |
cards.gmfIndicator |
string |
Exempt GMF account indicator. |
No |
cards.productNumber |
string |
Product number. |
Yes |
cards.productId |
string |
Product id. |
Request example
{
"accountNumber": 3210978700000000579
}
Response example
{
"accountData": {
"number": "3210978700000000579",
"currency": 978,
"currencyAlphaCode": "EUR",
"balance": 0,
"customerId": "3210_P004",
"cards": [
{
"cardNumberMask": "414210******8086",
"expiryDate": "202301",
"cardId": "100000003347",
"hotCardStatus": 0,
"cardTypeName": "VISA - PLUS",
"embossedName": "GENERAL POOL",
"customerId": "3210_P004",
"personId": "3210P_0000001",
"pinDenialCounter": 0,
"plasticNumber": 1,
"hotCardStatusDescription": "VALID CARD",
"cardIsPrimary": false,
"cardBindToCustomer": false,
"customerIsCardholder": false
}
]
}
}
setAllowedBeneficiaries
Set a list of allowed beneficiaries for a card or an account.
Request example
{
"accountNumber": "4000010000000003",
},
"beneficiaries": [
"M0001"
]
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
getAllowedBeneficiaries
Get a list of allowed beneficiaries for a card or an account.
Request example
{
"accountNumber": 4000010000000003,
}
Response example
{
"beneficiaries": [
M0001
]
}
setAllowedMccList
Set a list of MCC allowed for a card or an account.
Request example
{
"accountNumber": "4000010000000003",
},
"mccList": [
1750
]
}
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
getAllowedMccList
Get a list of MCC allowed for a card or an account.
Request example
{
"accountNumber": "4000010000000003",
}
Response example
Merchants
changeMerchantStatus
Change merchant status.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
merchantNumber |
string |
Merchant number. |
Yes |
institutionId |
string |
Internal institution id. |
Yes |
agentId |
string |
Agent id. |
Yes |
customerNumber |
string |
Client number. |
Yes |
contractNumber |
string |
Contract number. |
Yes |
status |
string |
Merchant status. |
Request example
{
"merchantNumber": "M000001",
"institutionId": "3210",
"agentId": "32",
"customerNumber": "3210_P004",
"contractNumber": "201",
"status": "Valid Entity"
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVisa. |
Response example
{
"responseCode" : "00"
}
getMerchantTransactions
Get merchant's transaction list.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
merchantId |
string |
Merchant id. |
No |
terminalId |
string |
Terminal id. |
Yes |
institutionId |
string |
Internal institution id. |
Yes |
period |
Object |
Time span. |
No |
period.start |
DateTime |
Start date. |
No |
period.end |
DateTime |
End date. |
Request example
{
"merchantId": "M999101",
"institutionId": 2,
"period": {
"start": "2019-05-01",
"end": "2019-06-01"
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
transactions |
Object |
Transactions. |
Yes |
transactions.utrnno |
long |
Transaction id in SVFE |
No |
transactions.reversal |
boolean |
Reversal flag. |
Yes |
transactions.merchantId |
string |
Merchant id. |
Yes |
transactions.terminalId |
string |
Terminal id. |
Yes |
transactions.transactionDate |
DateTime |
Transaction date/time. |
No |
transactions.settlementDate |
DateTime |
Settlement date/time. |
Yes |
transactions.cardNumberMask |
string |
Masked card number. |
Yes |
transactions.cardNumber |
string |
Card number. |
No |
transactions.transactionAmount |
integer |
Transaction amount. |
No |
transactions.transactionCurrency |
integer |
Transaction currency code |
No |
transactions.submittedAmount |
integer |
Requested amount. |
No |
transactions.submittedCurrency |
integer |
Requested currency |
No |
transactions.responseCode |
integer |
Internal SVFE response code. |
No |
transactions.authorizationCode |
string |
Authorization code. |
No |
transactions.cashbackAmount |
integer |
Cashback amount. |
No |
transactions.transactionType |
string |
Transaction type. |
No |
transactions.networkType |
string |
Network type. |
No |
transactions.cardType |
string |
Card type. |
No |
transactions.orderNumber |
string |
Payment order number. |
No |
transactions.orderId |
string |
Payment order id. |
Response example
{
"transactions": {
"transaction": [
{
"utrnno": 7220355,
"reversal": false,
"merchantId": "M999101",
"terminalId": 999101,
"transactionDate": "2019-05-15T13:08:07+04:00",
"cardNumber": 4440010000000001,
"transactionAmount": 10000,
"transactionCurrency": 978,
"responseCode": 802,
"authorizationCode": 0,
"cashbackAmount": 0,
"transactionType": 736,
"networkType": 28,
"cardType": 0
},
{
"utrnno": 7220403,
"reversal": false,
"merchantId": "M999101",
"terminalId": 999101,
"transactionDate": "2019-05-15T13:11:38+04:00",
"cardNumber": 4440010000000001,
"transactionAmount": 10000,
"transactionCurrency": 978,
"responseCode": 802,
"authorizationCode": 0,
"cashbackAmount": 0,
"transactionType": 736,
"networkType": 28,
"cardType": "DEF"
},
{
"utrnno": 7220431,
"reversal": false,
"merchantId": "M999101",
"terminalId": 999101,
"transactionDate": "2019-05-15T13:12:55+04:00",
"cardNumber": 4440010000000001,
"transactionAmount": 10000,
"transactionCurrency": 978,
"responseCode": 801,
"authorizationCode": 0,
"cashbackAmount": 0,
"transactionType": 736,
"networkType": 44,
"cardType": "DEF"
}
]
}
}
changeTerminalStatus
Change terminal status.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
merchantNumber |
string |
Merchant number. |
Yes |
terminalNumber |
string |
Terminal number. |
Yes |
institutionId |
string |
Internal institution id. |
Yes |
agentId |
string |
Agent id. |
Yes |
customerNumber |
string |
Client number. |
Yes |
contractNumber |
string |
Contract number. |
Yes |
status |
string |
Terminal status. |
Request example
{
"merchantNumber": "M999201",
"terminalNumber": "00999201",
"institutionId": "3210",
"agentId": "32",
"customerNumber": "3210_P004",
"contractNumber": "201",
"status": "Valid Entity"
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVisa. |
Response example
{
"responseCode" : "00"
}
initMerchantSettlement
Initialize merchant settlement.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
merchantId |
string |
Merchant id. |
Yes |
institutionId |
string |
Internal institution id. |
No |
cutoverDate |
DateTime |
All transactions prior to this date should be included in the settlement. |
No |
excludeMagstripeTransactions |
boolean |
Exlude magnetic stripe transactions |
No |
excludeFallbackTransactions |
boolean |
Exclude chip card transactions performed over the magnetic stripe. |
No |
excludeKeyEnteredTransactions |
boolean |
Exclude transactions with manual input of card details. |
No |
includeAllUnpaidTransactions |
boolean |
Include all unpaid transactions from previous banking days. |
Request example
{
"merchantId": "M000001",
"institutionId": "3210",
"cutoverDate": "2015-02-20",
"excludeMagstripeTransactions": true,
"excludeFallbackTransactions": true,
"excludeKeyEnteredTransactions": true,
"includeAllUnpaidTransactions": true
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
id |
long |
Payment order id |
Yes |
amount |
integer |
Payment order amount. |
Yes |
status |
string |
Payment order status. |
Yes |
affectedOrders |
Object |
List of affected paymnet orders. |
Yes |
affectedOrders.id |
long |
Payment order id |
Yes |
affectedOrders.amount |
integer |
Payment order amount. |
Yes |
affectedOrders.status |
string |
Payment order status. |
Response example
{
"amount" : 6,
"affectedOrders" : [ {
"amount" : 5,
"id" : 1,
"status" : "status"
}, {
"amount" : 5,
"id" : 1,
"status" : "status"
} ],
"id" : 0,
"status" : "status"
}
generateKey
Generate key.
Request parameters
Mandatory |
Name |
Type |
Description |
No |
terminalId |
long |
SVFE terminal internal id (pid) |
No |
terminalNumber |
string |
Terminal id. |
No |
merchantNumber |
string |
Merchant id. |
Yes |
hostId |
integer |
ZMK key internal id (PID), which should be used to export generated key. |
Yes |
keyType |
string |
Key type. |
Yes |
keyLength |
string |
Length of the generated key. Possible values: [ENKL_0016, ENKL_0032, ENKL_0048] |
Request example
{
"hostId": 54329,
"keyType": "string",
"keyLength": "ENKL_0016",
"keySerialNumber": "string",
"dukptId": 0
}
Response parameters
Mandatory |
Name |
Type |
Description |
No |
keyValue |
string |
Generated key (encrypted by ZMK). |
No |
checkValue |
string |
Check value |
No |
lmkHsmKeyValue |
string |
Generated key (encrypted by LMK). |
Response example
{
"keyValue" : "keyValue",
"lmkHsmKeyValue" : "lmkHsmKeyValue",
"checkValue" : "checkValue"
}
setKey
Set key.
Request parameters
Mandatory |
Name |
Type |
Description |
No |
terminalId |
long |
SVFE terminal internal id (pid) |
No |
terminalNumber |
string |
Terminal id. |
No |
merchantNumber |
string |
Merchant id. |
Yes |
hostId |
integer |
Host PID |
Yes |
keyType |
string |
Key type. Possible values: [ENKTTMKA, ENKTTMKP, ENKTTAK, ENKTIKEY] |
No |
inputKeyPrefix |
string |
Input key prefix. Possible values: [U, T, X, Y] |
Yes |
key |
string |
Key. |
No |
keyCheckValue |
string |
Check value |
Yes |
newKeyPrefix |
string |
New key prefix. Possible values: [U, T, X, Y] |
Request example
{
"terminalId": 0,
"terminalNumber": "string",
"merchantNumber": "string",
"hostId": 0,
"keyType": "ENKTTMKA",
"inputKeyPrefix": "U",
"key": "string",
"keyCheckValue": "string",
"newKeyPrefix": "U"
}
Response parameters
Response example
serviceAction
Perform an action on the service.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
serviceIdentification |
Object |
Service identification data. |
Yes |
serviceIdentification.serviceType |
string |
Service type. |
Yes |
serviceIdentification.serviceId |
string |
Service id. |
Yes |
serviceIdentification.serviceObjectType |
string |
Object, which the service can be linked to. Possible values: [SERVICE_OBJECT_CARD, SERVICE_OBJECT_ACCOUNT] |
Yes |
actionCode |
string |
Action code. Possible values: [ACTION_CODE_ADD, ACTION_CODE_UPDATE, ACTION_CODE_DELETE, ACTION_CODE_CHECK, ACTION_CODE_CHANGE_ACCESS, ACTION_CODE_CHECK_PARAMETERS, ACTION_CODE_RESTORE_PARAMETERS, ACTION_CODE_INQUIRE, ACTION_CODE_ACTION] |
Yes |
cardIdentification |
Object |
Card identification parameters. expDate and (cardNumber ) or (barCode ) or (cardNumberMask and phoneNumber ) are required. |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
No |
accountNumber |
string |
Account number. |
No |
serviceParameters |
Object |
Service parameters. |
No |
serviceParameters.phoneNumber |
string |
Phone number. |
No |
serviceParameters.email |
string |
E-mail |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Request example
{
"serviceIdentification": {
"serviceType": 7,
"serviceId": 300,
"serviceObjectType": "SERVICE_OBJECT_CARD"
},
"actionCode": "ACTION_CODE_ADD",
"cardIdentification": {
"cardNumber": 4000010000000003
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVisa. |
Response example
Cards & Wallets
activateCard
Activate card.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. Possible identification options: (cardNumber ) or (cardId ) or (barCode ) or (cardNumberMasked and cardholderId ) or (cardNumberMasked and phoneNumber ). |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Request example
{
"cardIdentification": {
"cardNumber": 4000010000000003
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
blockCard
Block card. Within the Sandbox a card has to be in active status (status code '0') to be blocked. You can get a card status code with getCardData
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. For bit of details on other card identification options which can be used in the real project and not in this Sandbox - please check the createVirtualCard description. |
Yes |
cardIdentification.cardNumber |
string |
Card number. You will get it in CreateVirtualCard() response. |
No |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. Not for the Sandbox. |
No |
cardIdentification.cardNumberMask |
string |
Masked card number. Not for the Sandbox. |
No |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. Not for the Sandbox. |
No |
cardIdentification.cardId |
string |
Card id. Not for the Sandbox. |
No |
cardIdentification.expDate |
string |
Card expiration date. Not for the Sandbox. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number Not for the Sandbox. |
No |
cardIdentification.phoneNumber |
string |
Client phone number. Not for the Sandbox. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. Not for the Sandbox. |
No |
cardIdentification.customerId |
string |
Client id. Not for the Sandbox. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. Not for the Sandbox. |
No |
cardIdentification.barCode |
string |
Bar code. Not for the Sandbox. |
No |
cardIdentification.cvv2 |
string |
CVV2. Not for the Sandbox. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. Not for the Sandbox. |
No |
cardIdentification.token |
string |
Token. Not for the Sandbox. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. Not for the Sandbox. |
No |
cardIdentification.email |
string |
E-mail. Not for the Sandbox. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
Yes |
hotCardStatus |
integer |
Card status. Should be '6' for the Sandbox. This means the card is blocked and should be captured on usage attempt. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. Not for the Sandbox. |
No |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. Not for the Sandbox. |
No |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. Not for the Sandbox. |
No |
cardAcceptorParameters.merchantType |
string |
Merchant category code. Not for the Sandbox. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. Not for the Sandbox. |
Request example
{
"cardIdentification": {
"cardId": 100000000873
},
"hotCardStatus": 6
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVisa. '00' is for success. |
Response example
{
"responseCode": "00",
"processingCode": "910000",
"systemTraceAuditNumber": 620397,
"localTransactionDate": "2021-09-23T14:37:36"
}
validateCard
Unlock card.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. Possible identification options: (cardNumber ) or (cardId ) or (cardNumberMask and cardholderId ) or (cardNumberMask and phoneNumber ). |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Request example
{
"cardIdentification": {
"cardNumber": 4142100007657181
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
{
"responseCode": "00",
"processingCode": "980000",
"systemTraceAuditNumber": 453660,
"localTransactionDate": "2021-11-12T15:06:01"
}
bindCardToAccount
Bind card to an account.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. cardNumber and expDate are required. |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
Yes |
accountNumber |
string |
Account number to bind to. |
Yes |
accountType |
string |
Account type. Possible values: [ACCOUNT_TYPE_DEFAULT, ACCOUNT_TYPE_SAVING, ACCOUNT_TYPE_CHECKING, ACCOUNT_TYPE_CREDIT, ACCOUNT_TYPE_FIRST_OTHERS, ACCOUNT_TYPE_LOANS, ACCOUNT_TYPE_ENVELOPE, ACCOUNT_TYPE_ESCROW, ACCOUNT_TYPE_MONEY_MARKET, ACCOUNT_TYPE_LOYALTY] |
No |
accountCurrency |
integer |
Account currency ( only required for new accounts ). |
No |
personalData |
Object |
Cardholder personal information. |
No |
personalData.firstName |
string |
|
No |
personalData.lastName |
string |
|
No |
customerId |
string |
Client id. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Request example
{
"cardIdentification": {
"cardNumber": 4000010000000001,
"expDate": 202012
},
"accountNumber": 4000010000000001,
"accountType": "ACCOUNT_TYPE_DEFAULT",
"accountCurrency": 978,
"personalData": {
"firstName": "IVAN",
"lastName": "IVANOV"
},
"customerId": "3210_P004"
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
getCardLimits
Get limits for a specific card. The limits set is defined for the card product and is predefined in the Sandbox. Initially the limits for a specific card are inherited from the product setting. You can change the limit values for a specific card with changeCardLimits
.
The following limits are available (cycle types are specified for the default limit setting and can be changed with changeCardLimit
request):
LMTP0111 - MOTO\ECOM limit (amount) month.
LMTP0112 - MOTO\ECOM limit (amount) day.
LMTP0108 - purchase limit (amount) month.
LMTP0110 - purchase limit (amount) day.
LMTP0109 - cash disbursmenent limit (amount) month.
LMTP0107 - cash disbursmenent limit (amount) day. You can test this limit in the Sandbox with p2pTransfer request.
The following limits cycleType are available:
0 - day. A 1-day cycle starts every day at 00:00:00.
1 - week. A 1 week cycle starts every 7 days at 00:00:00.
2 - calendar week. A cycle of 1 calendar week starts every Monday at 00:00:00.
3 - month. A 1-month cycle starts on the same day of each month at the same time.
4 - calendar month. A cycle of 1 calendar month starts at 00:00:00 on the first day of each month.
5 - quarter (3 months). A cycle of 1 quarter starts on the same day every 3 months at the same time.
6 - calendar quarter. A cycle of 1 calendar quarter starts on January 1, April 1, July 1, October 1 at 00:00:00.
7 - year. A cycle of 1 year begins on the same day and at the same time exactly one year later.
8 - calendar year. A cycle of 1 calendar year begins on January 1st at 00:00:00.
11 - hour. A one-hour cycle starts at the same minute and second of every hour (i.e. every 3600 seconds).
12 - calendar hour. The calendar hour starts at 0 minutes and 0 seconds of each hour and ends at 59 minutes 59 seconds of the same hour.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. For bit of details on other card identification options which can be used in the real project and not in this Sandbox - please check the createVirtualCard description. |
Yes |
cardIdentification.cardNumber |
string |
Card number. You will get it in CreateVirtualCard() response. |
No |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. Not for the Sandbox. |
No |
cardIdentification.cardNumberMask |
string |
Masked card number. Not for the Sandbox. |
No |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. Not for the Sandbox. |
No |
cardIdentification.cardId |
string |
Card id. Not for the Sandbox. |
No |
cardIdentification.expDate |
string |
Card expiration date. Not for the Sandbox. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number Not for the Sandbox. |
No |
cardIdentification.phoneNumber |
string |
Client phone number. Not for the Sandbox. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. Not for the Sandbox. |
No |
cardIdentification.customerId |
string |
Client id. Not for the Sandbox. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. Not for the Sandbox. |
No |
cardIdentification.barCode |
string |
Bar code. Not for the Sandbox. |
No |
cardIdentification.cvv2 |
string |
CVV2. Not for the Sandbox. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. Not for the Sandbox. |
No |
cardIdentification.token |
string |
Token. Not for the Sandbox. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. Not for the Sandbox. |
No |
cardIdentification.email |
string |
E-mail. Not for the Sandbox. |
No |
cardIdentification.institutionId |
string |
Internal institution id. Not for the Sandbox. |
Request example
{
"cardIdentification": {
"cardId": 100000000873
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
limits |
Object |
List of card limits. |
Yes |
limits.name |
string |
Limit name. |
No |
limits.startDate |
DateTime |
Limit start date. Not for the Sandbox. |
No |
limits.endDate |
DateTime |
Limit end date. Not for the Sandbox. |
No |
limits.value |
long |
Limit value. |
No |
limits.cycleType |
integer |
Cycle type. There several possible types of limits cycles - daily, monthly etc. |
No |
limits.cycleLength |
integer |
Cycle length. For example, value 2 for monthly limit types means 2 months. |
No |
limits.currency |
integer |
Currency. |
No |
limits.currentValue |
long |
Current limit value. |
Yes |
limits.limitExceptions |
Object |
Limit exception list. Not for the Sandbox. |
Response example
{
"limits": [
{
"name": "LMTP0111",
"value": 999999999999,
"cycleType": 0,
"cycleLength": 1,
"currency": 978,
"currentValue": 0,
"limitExceptions": []
},
{
"name": "LMTP0112",
"value": 999999999999,
"cycleType": 3,
"cycleLength": 1,
"currency": 978,
"currentValue": 0,
"limitExceptions": []
},
{
"name": "LMTP0108",
"value": 999999999999,
"cycleType": 3,
"cycleLength": 1,
"currency": 978,
"currentValue": 0,
"limitExceptions": []
},
{
"name": "LMTP0110",
"value": 999999999999,
"cycleType": 3,
"cycleLength": 1,
"currency": 978,
"currentValue": 0,
"limitExceptions": []
},
{
"name": "LMTP0109",
"value": 999999999999,
"cycleType": 0,
"cycleLength": 1,
"currency": 978,
"currentValue": 0,
"limitExceptions": []
},
{
"name": "LMTP0107",
"value": 999999999999,
"cycleType": 0,
"cycleLength": 1,
"currency": 978,
"currentValue": 0,
"limitExceptions": []
}
]
}
addCardLimitException
Add card limit exception.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. Possible identification options: (cardNumber ) or (cardId ) or (barCode ) or (cardNumberMasked and cardholderId ) or (cardNumberMasked and phoneNumber ). |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
Yes |
limitException |
Object |
Limit exception parameters. |
Yes |
limitException.limitName |
string |
Limit name at SVBO. |
Yes |
limitException.startDate |
DateTime |
Exception start date. |
Yes |
limitException.endDate |
DateTime |
Exception end date. |
No |
limitException.value |
long |
Limit value |
No |
limitException.cycleType |
integer |
Cycle type |
No |
limitException.cycleLength |
integer |
Cycle length |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Request example
{
"cardIdentification": {
"cardNumber": 4000010000000003
},
"limitException": {
"limitName": "LMTTC01",
"startDate": "2015-04-20",
"endDate": "2015-04-30",
"value": 10000000,
"cycleType": 4,
"cycleLength": 1
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
changeCardLimit
Change the limit values for a specific card. The limits set is defined for the card product and is predefined in the Sandbox. Initially the limits for a specific card are inherited from the product setting. Use getCardLimits
to get limits names.
The following limits are available (cycle types are specified for the default limit setting and can be changed with changeCardLimit
request):
LMTP0111 - MOTO\ECOM limit (amount) month.
LMTP0112 - MOTO\ECOM limit (amount) day.
LMTP0108 - purchase limit (amount) month.
LMTP0110 - purchase limit (amount) day.
LMTP0109 - cash disbursmenent limit (amount) month.
LMTP0107 - cash disbursmenent limit (amount) day. You can test this limit in the Sandbox with p2pTransfer request.
The following limits cycleType
are available:
0 - day. A 1-day cycle starts every day at 00:00:00.
1 - week. A 1 week cycle starts every 7 days at 00:00:00.
2 - calendar week. A cycle of 1 calendar week starts every Monday at 00:00:00.
3 - month. A 1-month cycle starts on the same day of each month at the same time.
4 - calendar month. A cycle of 1 calendar month starts at 00:00:00 on the first day of each month.
5 - quarter (3 months). A cycle of 1 quarter starts on the same day every 3 months at the same time.
6 - calendar quarter. A cycle of 1 calendar quarter starts on January 1, April 1, July 1, October 1 at 00:00:00.
7 - year. A cycle of 1 year begins on the same day and at the same time exactly one year later.
8 - calendar year. A cycle of 1 calendar year begins on January 1st at 00:00:00.
11 - hour. A one-hour cycle starts at the same minute and second of every hour (i.e. every 3600 seconds).
12 - calendar hour. The calendar hour starts at 0 minutes and 0 seconds of each hour and ends at 59 minutes 59 seconds of the same hour.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. For bit of details on other card identification options which can be used in the real project and not in this Sandbox - please check the createVirtualCard description. |
Yes |
cardIdentification.cardNumber |
string |
Card number. You will get it in CreateVirtualCard() response. |
No |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. Not for the Sandbox. |
No |
cardIdentification.cardNumberMask |
string |
Masked card number. Not for the Sandbox. |
No |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. Not for the Sandbox. |
No |
cardIdentification.cardId |
string |
Card id. Not for the Sandbox. |
No |
cardIdentification.expDate |
string |
Card expiration date. Not for the Sandbox. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number. Not for the Sandbox. |
No |
cardIdentification.phoneNumber |
string |
Client phone number. Not for the Sandbox. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. Not for the Sandbox.Not for the Sandbox. |
No |
cardIdentification.customerId |
string |
Client id. Not for the Sandbox. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. Not for the Sandbox. |
No |
cardIdentification.barCode |
string |
Bar code. Not for the Sandbox. |
No |
cardIdentification.cvv2 |
string |
CVV2. Not for the Sandbox. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. Not for the Sandbox. |
No |
cardIdentification.token |
string |
Token. Not for the Sandbox. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. Not for the Sandbox. |
No |
cardIdentification.email |
string |
E-mail. Not for the Sandbox. |
No |
cardIdentification.institutionId |
string |
Internal institution id. Not for the Sandbox. |
Yes |
limit |
Object |
Limit parameters. |
Yes |
limit.name |
string |
Limit name. It is predefined in the Sandbox. You can get the limits list with getCardLimits() and get limit names from its response. |
No |
limit.startDate |
DateTime |
Limit start date. Not for the Sandbox. |
No |
limit.endDate |
DateTime |
Limit end date. Not for the Sandbox. |
No |
limit.value |
long |
Limit value. |
No |
limit.cycleType |
integer |
Cycle type. |
No |
limit.cycleLength |
integer |
Cycle length. |
No |
limit.currency |
integer |
Currency. Not for the Sandbox. |
No |
limit.currentValue |
long |
Current limit value. Not for the Sandbox. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. Not for the Sandbox. |
No |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. Not for the Sandbox. |
No |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. Not for the Sandbox. |
No |
cardAcceptorParameters.merchantType |
string |
Merchant category code. Not for the Sandbox. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. Not for the Sandbox. |
Request example
{
"cardIdentification": {
"cardId": 100000000873
},
"limit": {
"name": "LMTP0112",
"value": 13000000,
"cycleType": 4,
"cycleLength": 1
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. '00' is for success. |
Response example
{
"responseCode": "00",
"processingCode": "710000",
"systemTraceAuditNumber": 620394,
"localTransactionDate": "2021-09-23T14:35:24"
}
changeCardLimitException
Change card limit exception.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. cardNumber or cardId are required. |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
Yes |
limitException |
Object |
Limit exception parameters. |
Yes |
limitException.limitName |
string |
Limit name at SVBO. |
Yes |
limitException.startDate |
DateTime |
Exception start date. |
Yes |
limitException.endDate |
DateTime |
Exception end date. |
No |
limitException.value |
long |
Limit value |
No |
limitException.cycleType |
integer |
Cycle type |
No |
limitException.cycleLength |
integer |
Cycle length |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Response example
{
"cardIdentification": {
"cardNumber": 4000010000000003,
"expDate": 202012
},
"limitException": {
"limitName": "LMTTC01",
"startDate": "2015-04-20",
"endDate": "2015-04-30",
"value": 10000000
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
deleteCardLimitException
Delete card limit exception.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. Possible identification options: (cardNumber ) or (cardId ) or (barCode ) or (cardNumberMask and cardholderId ) or (cardNumberMask and phoneNumber ). |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
Yes |
limitException |
Object |
Limit exception parameters. |
Yes |
limitException.limitName |
string |
Limit name at SVBO. |
Yes |
limitException.startDate |
DateTime |
Exception start date. |
Yes |
limitException.endDate |
DateTime |
Exception end date. |
No |
limitException.value |
long |
Limit value |
No |
limitException.cycleType |
integer |
Cycle type |
No |
limitException.cycleLength |
integer |
Cycle length |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Request example
{
"cardIdentification": {
"cardNumber": 4000010000000003,
"expDate": 202012
},
"limitException": {
"limitName": "LMTTC01",
"startDate": "2015-02-15",
"endDate": "2015-02-20"
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
generatePin
Generate PIN.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. (encryptedCardNumber ) or (cardNumberMask and phoneNumber ) or external card id are required. |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
No |
pinDeliveryMethod |
string |
PIN delivery method. Possible values: [SMS - in SMS, WS - in Web Service response, HALF_AND_HALF - 1st two digits in WS response, 2nd two digits in SMS, WS_ENCRYPTED - in Web Service response using public RSA encryption in ECB mode, NONE - do not deliver PIN] |
No |
encryptedPinValue |
ByteArray |
Encrypted PIN. |
No |
pinValue |
string |
PIN. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
No |
parameters |
Object |
List of arbitrary parameters. |
No |
parameters.name |
string |
|
No |
parameters.value |
string |
|
No |
checkCardOnly |
boolean |
Flag, showing whether it is necessary to only check existence and card status and not form and change PIN. |
Request example
{
"cardIdentification": {
"cardNumberMask": "400001%0003",
"phoneNumber": 79021111111
},
"pinDeliveryMethod": "WS"
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista (00 - success). |
No |
pinValue |
string |
PIN. |
No |
encryptedPinValue |
ByteArray |
Encrypted PIN. |
Response example
{
"encryptedPinValue" : [ "encryptedPinValue", "encryptedPinValue" ],
"pinValue" : 1111,
"responseCode" : 00
}
changePin
Change PIN.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. cardNumber or cardId are required. |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
Yes |
newPinData |
string |
New PIN. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Request example
{
"cardIdentification": {
"cardNumber": 4000010000000003
},
"newPinData": "059B2AA97DF72557"
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
resetPinCounter
Reset incorrect PIN attempts counter.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. cardNumber or cardId are required. |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Request example
{
"cardIdentification": {
"cardNumber": 4142100007657181
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVisa. |
Response example
{
"responseCode": "00",
"processingCode": "890000",
"systemTraceAuditNumber": 452018,
"localTransactionDate": "2021-11-11T12:28:19",
"rrn": "000000224348",
"authorizationIdResponse": "224348"
}
generateCVC2
Generate CVC2.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. Possible identification options: (cardNumber ) or (cardId ) or (barCode ) or (cardNumberMask and cardholderId ) or (cardNumberMask and phoneNumber ). |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. Must be passed if deliveryMethod is SMS and phoneNumber is NOT used as identification option. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
No |
deliveryMethod |
string |
Code delivery method. Possible values: [SMS, WS, HALF_AND_HALF, WS_ENCRYPTED, NONE] |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Request example
{
"cardIdentification": {
"cardNumber": 4000010000000003
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
SVFE operation completion code. |
No |
cardNumberMask |
string |
Masked card number. |
No |
cardNumber |
string |
Card number. |
No |
cvc2 |
string |
Generated CVV2 value. |
Response example
{
"cvc2" : 123,
"cardNumber" : 4000010000000003,
"responseCode" : 00,
"cardNumberMask" : "400001******0003"
}
setGeoRestrictions
Set geo-restrictions for the card. Only the rules that can be changed are returned.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. Posible identification options: (cardNumber ) or (cardId ). |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
Yes |
restrictions |
Object |
Restriction list. |
Yes |
restrictions.countryId |
integer |
Country ID. |
Yes |
restrictions.regionId |
integer |
Region id. |
Yes |
restrictions.transactionGroupId |
integer |
Transaction group id. |
Yes |
restrictions.status |
string |
Restriction status. Possible values: [ENABLED, DISABLED] |
No |
restrictions.startDate |
DateTime |
The date when restrictions come into effect. |
No |
restrictions.endDate |
DateTime |
The date when restrictions are removed. |
Request example
{
"cardIdentification": {
"cardNumber": 4000010000000001
},
"restrictions": {
"restriction": [
{
"regionId": 5,
"transactionGroupId": 999,
"status": "DISABLED",
"startDate": "2021-05-01T00:00:00",
"endDate": "2021-05-09T23:59:59"
},
{
"regionId": 11,
"transactionGroupId": 3,
"status": "DISABLED"
}
]
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
getGeoRestrictions
Get geo-restrictions list for a card. Only the rules that impose limitations for the card are returned.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. Posible identification options: cardNumber or cardId . |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
Request example
{
"cardIdentification": {
"cardNumber": 4000010000000001
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
regions |
Object |
Region list. |
Yes |
regions.id |
integer |
Region id. |
Yes |
regions.description |
string |
Description. |
No |
countries |
Object |
Country list. |
Yes |
countries.id |
integer |
Country id. |
Yes |
countries.description |
string |
Description. |
Yes |
transactionGroups |
Object |
Transaction group list. |
Yes |
transactionGroups.id |
integer |
Group id |
Yes |
transactionGroups.description |
string |
Description. |
Yes |
restrictions |
Object |
Restriction list. |
Yes |
restrictions.countryId |
integer |
Country id. |
Yes |
restrictions.regionId |
integer |
Region id. |
Yes |
restrictions.transactionGroupId |
integer |
Transaction group id. |
Yes |
restrictions.status |
string |
Restriction status. Possible values: [ENABLED, DISABLED] |
No |
restrictions.startDate |
DateTime |
The date when restrictions come into effect. |
No |
restrictions.endDate |
DateTime |
The date when restrictions are removed. |
Response example
{
"regions": {
"region": [
{
"id": 1,
"description": "RUSSIAN FEDERATION"
},
{
"id": 2,
"description": "EUROPEAN UNION"
}
]
},
"countries": {
"country": [
{
"id": 978,
"description": "RUSSIAN FEDERATION"
},
{
"id": 840,
"description": "UNITED STATES"
}
]
},
"transactionGroups": {
"transactionGroup": [
{
"id": 1,
"description": "Purchase Or Payments"
},
{
"id": 2,
"description": "Cash Withdrawal"
}
]
},
"restrictions": {
"restriction": [
{
"regionId": 1,
"transactionGroupId": 1,
"status": "DISABLED"
},
{
"countryId": 640,
"transactionGroupId": 1,
"status": "DISABLED",
"startDate": "2021-05-01T00:00:00+03:00",
"endDate": "2021-05-09T23:59:59+03:00"
}
]
}
}
cardStatusInquiry
Make card status inquiry.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. Possible identification options: (cardNumber ) or (cardId ) or (barCode ) or (cardNumberMask and cardholderId ) or (cardNumberMask and phoneNumber ).Card identification parameters. Possible identification options: (cardNumber ) or (cardId ) or (barCode ) or (cardNumberMask and cardholderId ) or (cardNumberMask and phoneNumber ). |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
Request example
{
"cardIdentification": {
"cardNumber": 4000010000000003
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
hotCardStatus |
integer |
Card status |
Response example
changeCardStatus
Change card status. In the Sandbox you can change card status only for blocked cards (card status code is '6'). You can get the card status code with getCardData
request. To change card status from '0' to '6' (blocked) use blockCard
request.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. For bit of details on other card identification options which can be used in the real project and not in this Sandbox - please check the createVirtualCard description. |
Yes |
cardIdentification.cardNumber |
string |
Card number. You will get it in CreateVirtualCard() response. |
No |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. Not for the Sandbox. |
No |
cardIdentification.cardNumberMask |
string |
Masked card number. |
No |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. Not for the Sandbox. |
No |
cardIdentification.cardId |
string |
Card id. Not for the Sandbox. |
No |
cardIdentification.expDate |
string |
Card expiration date. Not for the Sandbox. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number. Not for the Sandbox. |
No |
cardIdentification.phoneNumber |
string |
Client phone number. Not for the Sandbox. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. Not for the Sandbox. |
No |
cardIdentification.customerId |
string |
Client id. Not for the Sandbox. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. Not for the Sandbox. |
No |
cardIdentification.barCode |
string |
Bar code. Not for the Sandbox. |
No |
cardIdentification.cvv2 |
string |
CVV2. Not for the Sandbox. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. Not for the Sandbox. |
No |
cardIdentification.token |
string |
Token. Not for the Sandbox. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. Not for the Sandbox. |
No |
cardIdentification.email |
string |
E-mail. Not for the Sandbox. |
No |
cardIdentification.institutionId |
string |
Internal institution id. Not for the Sandbox. |
Yes |
hotCardStatus |
integer |
Card status. For the Sandbox should be '0' to activate a blocked card. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. Not for the Sandbox. |
No |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. Not for the Sandbox. |
No |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. Not for the Sandbox. |
No |
cardAcceptorParameters.merchantType |
string |
Merchant category code. Not for the Sandbox. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. Not for the Sandbox. |
Request example
{
"cardIdentification": {
"cardId": 100000000873
},
"hotCardStatus": 0
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. '00' is for success. |
Response example
{
"responseCode": "00",
"processingCode": "950000",
"systemTraceAuditNumber": 620398,
"localTransactionDate": "2021-09-23T14:38:26"
}
createVirtualCard
Creates a virtual card for a registered customer. Use registerCustomer
to create a customer and an account if you haven't done it yet.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Primary card identification parameters. There are many card attributes and their combinations to identify a card, supported by SmartVista, but the Sandbox uses the most simple one - the card number. All other options are provided as examples. |
Yes |
cardIdentification.cardNumber |
string |
Card number. This is the way we will use in all Sandbox's requests to identify a card. For this request always use "visaBin0000000000" card number, where [visaBin] is the number from the e-mail you got after the registration. For the all other requests use card number you will get after creating a card with this request. |
No |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. It is commonly used as one of the possible card identification params, but not in this Sandbox project to avoid keys management. Do not use it here. |
No |
cardIdentification.cardNumberMask |
string |
Masked card number. Common way to identify the card combined with a phone number or some other card data, but not the one used in the Sandbox. Do not use it here. |
No |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. Common way to identify the card combined with a phone number, but not the one used in the Sandbox. Do not use it here. |
No |
cardIdentification.cardId |
string |
Card id. Not for the Sandbox. |
No |
cardIdentification.expDate |
string |
Card expiration date. Frequently used with some other card attributes. Not for the Sandbox. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number. Not for the Sandbox. |
No |
cardIdentification.phoneNumber |
string |
Client phone number. Frequently used with some other card attributes. Not for the Sandbox. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. Not for the Sandbox. |
No |
cardIdentification.customerId |
string |
Client id. Not for the Sandbox. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. Not for the Sandbox. |
No |
cardIdentification.barCode |
string |
Bar code. Not for the Sandbox. |
No |
cardIdentification.cvv2 |
string |
CVV2. Not for the Sandbox. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. Not for the Sandbox. |
No |
cardIdentification.token |
string |
Token. Not for the Sandbox. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. Not for the Sandbox. |
No |
cardIdentification.email |
string |
E-mail. Not for the Sandbox. |
No |
cardIdentification.institutionId |
string |
Internal institution id. Not for the Sandbox. |
Yes |
virtualCardIdentification |
Object |
Virtual card parameters. expDate and productType are required. |
Yes |
virtualCardIdentification.expDate |
string |
Card expiration date. Any future date in "YYYYMM" format. |
Yes |
virtualCardIdentification.productType |
string |
Product type. Identifies the card product for a card. In the Sandbox should always be constant number '16' as we set up a one product for you. |
No |
virtualCardIdentification.cardNumber |
string |
Card number. Not for the Sandbox. |
No |
virtualCardIdentification.cardNumberMask |
string |
Masked card number. Not for the Sandbox. |
No |
virtualCardIdentification.cardId |
string |
Card id. Not for the Sandbox. |
No |
virtualCardIdentification.barCode |
string |
Bar code. Not for the Sandbox. |
No |
virtualCardIdentification.cvv2 |
string |
CVV2/CVC2. Not for the Sandbox. |
Yes |
amount |
integer |
Default limit for newly created virtual cards. Should be constant number '0' in the Sandbox. |
Yes |
currency |
integer |
Currency. ISO 4217 numeric currency code. Use '978' for the Sandbox. |
Yes |
accountNumber |
string |
Account number for primary card identification. Use the account number you got from registerCustomer(). |
No |
deliveryMethod |
string |
Virtual card parameters delivery method. Possible values: [WS, HALF_AND_HALF] . WS - all parameters delivered in Web Service response. HALF_AND_HALF - some parameters delivered in Web Service response, some in SMS. For HALF_AND_HALF, the Web Service response will contain masked card number (for example **** 1111 1111 ****) and the SMS will contain the CVV2 and other half of the masked card number (for example 1111 **** **** 1111). Use 'WS' value for the Sandbox. |
No |
personalData |
Object |
Card owner personal data. Not for the Sandbox. |
No |
personalData.firstName |
string |
Not for the Sandbox. |
No |
personalData.lastName |
string |
Not for the Sandbox. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. Not for the Sandbox. |
No |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. Not for the Sandbox. |
No |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. Not for the Sandbox. |
No |
cardAcceptorParameters.merchantType |
string |
Merchant category code. Not for the Sandbox. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. Not for the Sandbox. |
Request example
{
"cardIdentification": {
"cardNumber": 4140050000000000,
"phoneNumber": "319220977337",
"customerId": "3006P_0000002"
},
"virtualCardIdentification": {
"expDate": 202201,
"productType": 16
},
"amount": 0,
"currency": 978,
"accountNumber": "3006978700000000108",
"deliveryMethod": "WS"
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
virtualCardIdentification |
Object |
Virtual card Parameters. |
No |
virtualCardIdentification.cardNumber |
string |
Card number. Here you will get the card number of the created card in the Sandbox. Save it for all further operations with the created card. |
No |
virtualCardIdentification.cardNumberMask |
string |
Masked card number. Not for the Sandbox. |
No |
virtualCardIdentification.cardId |
string |
Card id. Not for the Sandbox. |
Yes |
virtualCardIdentification.expDate |
string |
Card expiration date. Not for the Sandbox. |
Yes |
virtualCardIdentification.productType |
string |
Product type. Not for the Sandbox. |
No |
virtualCardIdentification.barCode |
string |
Bar code. Not for the Sandbox. |
No |
virtualCardIdentification.cvv2 |
string |
CVV2/CVC2. Not for the Sandbox. |
Response example
{
"virtualCardIdentification": {
"cardNumber": "4140050021658271",
"cardId": "100000000873",
"expDate": "202201",
"productType": "16"
}
}
getCardData
Returns you the data about the cards you created. Can be used after creating a card with createVirtualCard
.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. cardNumber is required. For bit of details on other card identification options which can be used in the real project and not in this Sandbox - please check the createVirtualCard description. |
Yes |
cardIdentification.cardNumber |
string |
Card number. You will get it in CreateVirtualCard() response. |
No |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. Not for the Sandbox. |
No |
cardIdentification.cardNumberMask |
string |
Masked card number. Not for the Sandbox. |
No |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. Not for the Sandbox. |
No |
cardIdentification.cardId |
string |
Card id. Not for the Sandbox. |
No |
cardIdentification.expDate |
string |
Card expiration date. Not for the Sandbox. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number Not for the Sandbox. |
No |
cardIdentification.phoneNumber |
string |
Client phone number. Not for the Sandbox. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. Not for the Sandbox. |
No |
cardIdentification.customerId |
string |
Client id. Not for the Sandbox. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. Not for the Sandbox. |
No |
cardIdentification.barCode |
string |
Bar code. Not for the Sandbox. |
No |
cardIdentification.cvv2 |
string |
CVV2. Not for the Sandbox. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. Not for the Sandbox. |
No |
cardIdentification.token |
string |
Token. Not for the Sandbox. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. Not for the Sandbox. |
No |
cardIdentification.email |
string |
E-mail. Not for the Sandbox. |
No |
cardIdentification.institutionId |
string |
Internal institution id. Not for the Sandbox. |
No |
rsaPublicKey |
ByteArray |
Open key for card number encryption in return message. Not for the Sandbox. |
Request example
{
"cardIdentification": {
"cardId": 100000000873
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardData |
Object |
Card parameters. |
No |
cardData.encryptedCardNumber |
ByteArray |
Encrypted card number. Not for the Sandbox. |
No |
cardData.cardNumberMask |
string |
Masked card number. Not for the Sandbox. |
Yes |
cardData.cardNumber |
string |
Card number. |
No |
cardData.expiryDate |
string |
Card expiration date. Comes in YYYYMM format. |
No |
cardData.formattedExpiryDate |
string |
User-formatted card expiration date. Not for the Sandbox. |
No |
cardData.cardId |
string |
Card id. This is internal SmartVista card ID that can be used to identify the card for non PCI DSS compliant apps. |
No |
cardData.hotCardStatus |
integer |
Card status. |
No |
cardData.cardTypeName |
string |
Card type. |
No |
cardData.embossedName |
string |
Embossed name. Would have a real value only for embossed plastic cards and not for virtual cards in the Sanbox. |
No |
cardData.customerId |
string |
Client id. |
No |
cardData.customerName |
string |
Client name. Not for the Sandbox. |
No |
cardData.personId |
string |
Cardholder id. Not for the Sandbox. |
No |
cardData.pinDenialCounter |
integer |
Incorrect PIN attempts count |
No |
cardData.plasticNumber |
integer |
Plastic number. Not for the Sandbox. |
No |
cardData.hotCardStatusDescription |
string |
Card status description. |
No |
cardData.cardIsPrimary |
boolean |
Primary card flag. Always false for the Sandbox. |
No |
cardData.cardBindToCustomer |
boolean |
Card binded to client flag. Always false for the Sandbox. |
No |
cardData.customerIsCardholder |
boolean |
Is client a cardholder flag. Always false for the Sandbox. |
No |
cardData.cardContractId |
string |
Card contract id. Not for the Sandbox. |
No |
cardData.cardPlasticId |
string |
Plastic type id. Not for the Sandbox. |
No |
cardData.cardPlasticDescription |
string |
Plastic type description. Not for the Sandbox. |
No |
cardData.memorableWord |
string |
Secret word. Not for the Sandbox. |
No |
cardData.email |
string |
E-mail. Not for the Sandbox. |
No |
cardData.lastWrongPinDate |
DateTime |
Last incorrect PIN attempt date/time. Not for the Sandbox. |
No |
cardData.cardCreationDate |
DateTime |
Card issue date. Not for the Sandbox. |
No |
cardData.cardBlockingDate |
DateTime |
Card lock date/time. Not for the Sandbox. |
No |
cardData.directDebitAccount |
string |
Account used for auto-payments. Not for the Sandbox. |
No |
cardData.cardholderMobilePhoneNumber |
string |
Cardholder's phone number. Not for the Sandbox. |
No |
cardData.accounts |
Object |
List of accounts for the card. There should be only one account in the Sandbox. |
Yes |
accounts.number |
string |
Account number. |
Yes |
accounts.currency |
integer |
Account currency |
No |
accounts.currencyAlphaCode |
string |
Account currency letter code. |
Yes |
accounts.balance |
integer |
Account balance. |
No |
accounts.creditLimit |
integer |
Credit limit. |
Yes |
accounts.customerId |
string |
Client id. |
No |
accounts.defaultAccount |
boolean |
Default account indicator. Always true for the Sandbox. |
Response example
{
"cardData": {
"cardNumber": "4140050021658271",
"expiryDate": "202301",
"cardId": "100000000873",
"hotCardStatus": 0,
"cardTypeName": "VISA - PLUS",
"embossedName": "GENERAL POOL",
"customerId": "3006P_0000003",
"personId": "3006P_0000002",
"pinDenialCounter": 0,
"plasticNumber": 1,
"hotCardStatusDescription": "VALID CARD",
"cardIsPrimary": false,
"cardBindToCustomer": false,
"customerIsCardholder": false,
"accounts": [
{
"number": "3006978700000000108",
"accountType": 1,
"currency": 978,
"currencyAlphaCode": "EUR",
"balance": 0,
"creditLimit": 0,
"customerId": "3006P_0000003",
"defaultAccount": true
}
],
"customParameters": []
}
}
getCardFees
Get card fees.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardNumber |
string |
Card number. |
Request example
{
"cardNumber": 4000010000000003
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
fees |
Object |
Fee list. |
Yes |
fees.feeType |
string |
Fee type. |
Yes |
fees.feeValue |
number |
Fee value. |
Response example
{
"fees" : [ {
"feeValue" : 1.46581298050294517310021547018550336360931396484375,
"feeType" : "feeType"
}, {
"feeValue" : 1.46581298050294517310021547018550336360931396484375,
"feeType" : "feeType"
} ]
}
getCardListByOwner
Get card list using client ID and/or cardholder ID.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. (customerId ) or (phoneNumber ) or (email ) are required. |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
Request example
{
"cardIdentification": {
"customerId": 10022830
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
No |
cards |
Object |
|
No |
cards.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cards.cardNumberMask |
string |
Masked card number. |
Yes |
cards.cardNumber |
string |
Card number. |
No |
cards.expiryDate |
string |
Card expiration date. |
No |
cards.formattedExpiryDate |
string |
User-formatted card expiration date. |
No |
cards.cardId |
string |
Card id. |
No |
cards.hotCardStatus |
integer |
Card status |
No |
cards.cardTypeName |
string |
Card type. |
No |
cards.embossedName |
string |
Embossed name. |
No |
cards.customerId |
string |
Client id. |
No |
cards.customerName |
string |
Client name. |
No |
cards.personId |
string |
Cardholder id. |
No |
cards.pinDenialCounter |
integer |
Incorrect PIN attempts count |
No |
cards.plasticNumber |
integer |
Plastic number |
No |
cards.hotCardStatusDescription |
string |
Card status description. |
No |
cards.cardIsPrimary |
boolean |
Primary card flag. |
No |
cards.cardBindToCustomer |
boolean |
Card binded to client flag. |
No |
cards.customerIsCardholder |
boolean |
Is client a cardholder flag. |
No |
cards.cardContractId |
string |
Card contract id. |
No |
cards.cardPlasticId |
string |
Plastic type id. |
No |
cards.cardPlasticDescription |
string |
Plastic type description. |
No |
cards.memorableWord |
string |
Secret word. |
No |
cards.email |
string |
E-mail. |
No |
cards.lastWrongPinDate |
DateTime |
Last incorrect PIN attempt date/time. |
No |
cards.cardCreationDate |
DateTime |
Card issue date. |
No |
cards.cardBlockingDate |
DateTime |
Card lock date/time. |
No |
cards.directDebitAccount |
string |
Account used for auto-payments. |
No |
cards.cardholderMobilePhoneNumber |
string |
Cardholder's phone number. |
No |
cards.accounts |
Object |
List of accounts for the card. |
Yes |
accounts.number |
string |
Account number. |
Yes |
accounts.currency |
integer |
Account currency |
No |
accounts.currencyAlphaCode |
string |
Account currency letter code. |
Yes |
accounts.balance |
integer |
Account balance. |
No |
accounts.creditLimit |
integer |
Credit limit. |
Yes |
accounts.customerId |
string |
Client id. |
No |
accounts.defaultAccount |
boolean |
Default account indicator. |
Response example
{
"cards": {
"card": [
{
"cardNumberMask": "400001******0004",
"expiryDate": 202012,
"cardId": 99,
"hotCardStatus": 0,
"cardTypeName": "EC/MC Virtual",
"embossedName": "TEST FOR_BO_TRANS1",
"customerId": 10022830,
"personId": 40000004,
"pinDenialCounter": 0,
"plasticNumber": 0,
"hotCardStatusDescription": "VALID CARD",
"cardIsPrimary": true,
"cardBindToCustomer": true,
"customerIsCardholder": false
},
{
"cardNumberMask": "400001******0008",
"expiryDate": 202012,
"hotCardStatus": 8,
"cardTypeName": "EC/MC Virtual",
"embossedName": "TEST FOR_BO_TRANS1",
"customerId": 10022830,
"personId": 40000008,
"pinDenialCounter": 0,
"plasticNumber": 0,
"hotCardStatusDescription": "CALL SECURITY, CAPTURE",
"cardIsPrimary": true,
"cardBindToCustomer": true,
"customerIsCardholder": false
},
{
"cardNumberMask": "400001******0017",
"expiryDate": 202012,
"hotCardStatus": 0,
"cardTypeName": "EC/MC Virtual",
"embossedName": "TEST FOR_BO_TRANS1",
"customerId": 10022830,
"personId": 40000017,
"pinDenialCounter": 0,
"plasticNumber": 0,
"hotCardStatusDescription": "VALID CARD",
"cardIsPrimary": true,
"cardBindToCustomer": true,
"customerIsCardholder": false
}
]
}
}
getTransactionSchemeAdditions
Get additional transaction scheme rules.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. Possible identification options: cardId . |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
No |
templateSchemeId |
long |
Id for the scheme used as a template |
Request example
{
"cardIdentification": {
"cardId": 1000
},
"templateSchemeId": 10
}
Response parameters
Mandatory |
Name |
Type |
Description |
No |
transactionSchemeAdditions |
Object |
Additional transaction scheme rules list. |
Yes |
transactionSchemeAdditions.id |
long |
Rule id |
Yes |
transactionSchemeAdditions.domain |
string |
Issuer institution id. |
Yes |
transactionSchemeAdditions.countryGroup |
integer |
Country group id |
Yes |
transactionSchemeAdditions.mccGroup |
integer |
MCC group id |
Yes |
transactionSchemeAdditions.transactionType |
integer |
Transaction type: format |
Yes |
transactionSchemeAdditions.posDataCode |
string |
POS data code value. |
Response example
{
"transactionSchemeAdditions": {
"addition": [
{
"id": 141,
"domain": 9999,
"countryGroup": 9987,
"mccGroup": -1,
"transactionType": 781,
"posDataCode": "************"
},
{
"id": 142,
"domain": 9999,
"countryGroup": 9987,
"mccGroup": -1,
"transactionType": 781,
"posDataCode": "************"
},
{
"id": 143,
"domain": 9999,
"countryGroup": 9987,
"mccGroup": -1,
"transactionType": 781,
"posDataCode": "************"
}
]
}
}
setTransactionSchemeAdditions
Set rules list for the additional transaction scheme.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. Possible identification options: cardId . |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
Yes |
transactionSchemeAdditions |
Object |
Additional transaction scheme rules list. |
Yes |
transactionSchemeAdditions.id |
long |
Rule id |
Yes |
transactionSchemeAdditions.domain |
string |
Issuer institution id. |
Yes |
transactionSchemeAdditions.countryGroup |
integer |
Country group id |
Yes |
transactionSchemeAdditions.mccGroup |
integer |
MCC group id |
Yes |
transactionSchemeAdditions.transactionType |
integer |
Transaction type: format |
Yes |
transactionSchemeAdditions.posDataCode |
string |
POS data code value. |
Request example
{
"cardIdentification": {
"cardId": 1000
},
"transactionSchemeAdditions": {
"addition": [
{
"id": 141,
"domain": 9999,
"countryGroup": 9987,
"mccGroup": -1,
"transactionType": 793,
"posDataCode": "************"
},
{
"id": 142,
"domain": 9999,
"countryGroup": 9987,
"mccGroup": -1,
"transactionType": 781,
"posDataCode": "************"
},
{
"id": 143,
"domain": 9999,
"countryGroup": 9987,
"mccGroup": -1,
"transactionType": 781,
"posDataCode": "************"
}
]
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code in SmartVista. |
Response example
topUp
Top up a card or an account.
Request example
{
"pan": "string",
"expiryMonth": "string",
"expiryYear": "string",
"cvc": "string",
"cardholderName": "string"
}
Response example
{
"preAuthorization": false,
"cardIdentification": {
"encryptedCardNumber": [
"string"
],
"cardNumberMask": "string",
"cardLastDigitMask": "string",
"cardNumber": "string",
"cardId": "string",
"expDate": "string",
"plasticNumber": 0,
"phoneNumber": "string",
"cardholderId": "string",
"customerId": "string",
"customerNumber": "string",
"barCode": "string",
"cvv2": "string",
"externalCardId": "string",
"token": "string",
"cardTypeCode": "string",
"email": "string",
"institutionId": "string"
},
"amount": 0,
"currency": 0,
"accountType": "ACCOUNT_TYPE_DEFAULT",
"accountIndex": 0,
"accountNumber": "string",
"account2Type": "ACCOUNT_TYPE_DEFAULT",
"account2Index": 0,
"account2Number": "string",
"tds": {
"xid": "string",
"cavv": "string",
"ucaf": "string",
"authenticationIndicator": "NOT_PERFORMED"
},
"senderReceiverInfo": {
"senderName": "string",
"senderAddress": "string",
"senderCity": "string",
"senderCountry": "string",
"senderPostalCode": "string",
"receiverName": "string"
},
"pointOfServiceDataCode": "string",
"pointOfServiceConditionCode": "string",
"fee": {
"feeAmount": 0,
"feeCurrency": 0
},
"cardAcceptorParameters": {
"terminalIdentification": "string",
"merchantIdentification": "string",
"merchantType": "string",
"nameAndLocation": "string"
},
"securityLevelIndicator": "string",
"fundingSource": 0,
"externalTransactionId": "string",
"originalTransactionParameters": {
"systemTraceAuditNumber": 0,
"localTransactionDate": "2021-10-29T11:57:14.481Z",
"rrn": "string"
},
"posCardholderPresence": 0,
"uniqueReferenceNumber": "string",
"otp": "string",
"serviceId": "string",
"paymentSpecificData": {
"f57": "string",
"f58": "string",
"f59": "string",
"f60": "string",
"f61": "string",
"f62": "string",
"f63": "string",
"f64": "string",
"f65": "string",
"f66": "string",
"f67": "string",
"f68": "string",
"f69": "string",
"f70": "string",
"f71": "string",
"f72": "string",
"f73": "string"
},
"transactionComment": "string",
"additionalAmounts": [
{
"accountType": "ACCOUNT_TYPE_DEFAULT",
"amountType": "string",
"currency": 0,
"amount": 0
}
]
}
Transactions
creditCard
Deposit funds to the card.
Request parameters
Mandatory |
Name |
Type |
Description |
No |
preAuthorization |
boolean |
Pre-authorization flag. |
Yes |
cardIdentification |
Object |
Card identification parameters. For bit of details on other card identification options which can be used in the real project and not in this Sandbox - please check the createVirtualCard description. |
Yes |
cardIdentification.cardNumber |
string |
Card number. You will get it in CreateVirtualCard() response. |
No |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. Not for the Sandbox. |
No |
cardIdentification.cardNumberMask |
string |
Masked card number. Not for the Sandbox. |
No |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. Not for the Sandbox. |
No |
cardIdentification.cardId |
string |
Card id. Not for the Sandbox. |
No |
cardIdentification.expDate |
string |
Card expiration date. Not for the Sandbox. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number Not for the Sandbox. |
No |
cardIdentification.phoneNumber |
string |
Client phone number. Not for the Sandbox. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. Not for the Sandbox. |
No |
cardIdentification.customerId |
string |
Client id. Not for the Sandbox. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. Not for the Sandbox. |
No |
cardIdentification.barCode |
string |
Bar code. Not for the Sandbox. |
No |
cardIdentification.cvv2 |
string |
CVV2. Not for the Sandbox. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. Not for the Sandbox. |
No |
cardIdentification.token |
string |
Token. Not for the Sandbox. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. Not for the Sandbox. |
No |
cardIdentification.email |
string |
E-mail. Not for the Sandbox. |
No |
cardIdentification.institutionId |
string |
Internal institution id. Not for the Sandbox. |
Yes |
amount |
integer |
Amount. |
Yes |
currency |
integer |
Currency. ISO 4217 numeric currency code. Use '978' for the Sandbox. |
No |
tds |
Object |
3DS transaction parameters. |
No |
tds.xid |
string |
VISA 3DS transaction id. Not for the Sandbox. |
No |
tds.cavv |
string |
VISA authentication check value. Not for the Sandbox. |
No |
tds.ucaf |
string |
Mastercard universal authentification field. Not for the Sandbox. |
No |
tds.authenticationIndicator |
string |
E-commerce transaction authentification type. Possible values: [NOT_PERFORMED, TDS_MERCHANT_ONLY, TDS_PERFORMED, ADDITIONAL_PROTOCOL_USED, RECURRENT_PAYMENT_AUTH]. Not for the Sandbox. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. Not for the Sandbox. |
No |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. Not for the Sandbox. |
No |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. Not for the Sandbox. |
No |
cardAcceptorParameters.merchantType |
string |
Merchant category code. Not for the Sandbox. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. Not for the Sandbox. |
Request example
{
"cardIdentification": {
"cardNumber": 4140050021658271,
"expDate": 202201
},
"amount": 10000,
"currency": 978
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
SVFE operation completion code. '00' is for success. |
Yes |
processingCode |
string |
processing code. |
Yes |
systemTraceAuditNumber |
integer |
Audit record number |
Yes |
localTransactionDate |
DateTime |
Transaction date. format: date-time |
Yes |
rrn |
string |
External id RNN. |
No |
authorizationIdResponse |
string |
Authorization id. |
No |
uniqueReferenceNumber |
string |
Unique reference number for the operation. |
No |
otp |
string |
One-time password. Not for the Sandbox. |
No |
acquirerFeeAmount |
string |
Acquirer fee amount. Not for the Sandbox. |
No |
issuerFeeAmount |
string |
Issuer fee amount. Not for the Sandbox. |
No |
paymentSpecificData |
Object |
Payment specific data. |
Response example
{
"responseCode": "00",
"processingCode": "270000",
"systemTraceAuditNumber": 620399,
"localTransactionDate": "2021-09-23T14:39:15",
"rrn": "000000154798",
"authorizationIdResponse": "154798",
"paymentSpecificData": {}
}
debitCard
Withdraw funds from the card.
Request parameters
Mandatory |
Name |
Type |
Description |
No |
preAuthorization |
boolean |
Pre-authorization flag. |
Yes |
cardIdentification |
Object |
Card identification parameters. Possible identification options: (cardNumber ) or (cardId ) or (barCode ) or (cardNumberMask and cardholderId ) or (cardNumberMask and phoneNumber ). |
Yes |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. |
Yes |
cardIdentification.cardNumberMask |
string |
Masked card number. |
Yes |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. |
Yes |
cardIdentification.cardNumber |
string |
Card number. |
No |
cardIdentification.cardId |
string |
Card id. |
No |
cardIdentification.expDate |
string |
Card expiration date. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number |
No |
cardIdentification.phoneNumber |
string |
Client phone number. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. |
No |
cardIdentification.customerId |
string |
Client id. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. |
No |
cardIdentification.barCode |
string |
Bar code. |
No |
cardIdentification.cvv2 |
string |
CVV2. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. |
No |
cardIdentification.token |
string |
Token. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. |
No |
cardIdentification.email |
string |
E-mail. |
No |
cardIdentification.institutionId |
string |
Internal institution id. |
Yes |
amount |
integer |
Amount. |
Yes |
currency |
integer |
Currency |
No |
fee |
Object |
Acquirer fee parameters. |
Yes |
fee.feeType |
string |
Fee type. |
Yes |
fee.feeValue |
number |
Fee value. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. |
Yes |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. |
Yes |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. |
Yes |
cardAcceptorParameters.merchantType |
string |
Merchant category code. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. |
No |
tds |
Object |
3DS transaction parameters. |
No |
tds.xid |
string |
VISA 3DS transaction id. |
No |
tds.cavv |
string |
VISA authentication check value. |
No |
tds.ucaf |
string |
Mastercard universal authentification field. |
No |
tds.authenticationIndicator |
string |
E-commerce transaction authentification type. Possible values: [NOT_PERFORMED, TDS_MERCHANT_ONLY, TDS_PERFORMED, ADDITIONAL_PROTOCOL_USED, RECURRENT_PAYMENT_AUTH] |
Request example
{
"cardIdentification": {
"cardNumber": 4000010000000003
},
"amount": 100000,
"currency": 978,
"fee": {
"feeAmount": 1000
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
SVFE operation completion code. |
Yes |
processingCode |
string |
processing code. |
Yes |
systemTraceAuditNumber |
integer |
Audit record number |
Yes |
localTransactionDate |
DateTime |
Transaction date. format: date-time |
Yes |
rrn |
string |
External id RNN. |
No |
authorizationIdResponse |
string |
Authorization id. |
No |
uniqueReferenceNumber |
string |
Unique reference number for the operation. |
No |
otp |
string |
One-time password. |
No |
acquirerFeeAmount |
string |
Acquirer fee amount. |
No |
issuerFeeAmount |
string |
Issuer fee amount. |
No |
paymentSpecificData |
Object |
Payment specific data. |
No |
paymentSpecificData.f57 |
string |
Specific field 57. |
No |
paymentSpecificData.f58 |
string |
Specific field 58. |
No |
paymentSpecificData.f59 |
string |
Specific field 59. |
No |
paymentSpecificData.f60 |
string |
Specific field 60. |
No |
paymentSpecificData.f61 |
string |
Specific field 61. |
No |
paymentSpecificData.f62 |
string |
Specific field 62. |
No |
paymentSpecificData.f63 |
string |
Specific field 63. |
No |
paymentSpecificData.f64 |
string |
Specific field 64. |
No |
paymentSpecificData.f65 |
string |
Specific field 65. |
No |
paymentSpecificData.f66 |
string |
Specific field 66. |
No |
paymentSpecificData.f67 |
string |
Specific field 67. |
No |
paymentSpecificData.f68 |
string |
Specific field 68. |
No |
paymentSpecificData.f69 |
string |
Specific field 69. |
No |
paymentSpecificData.f70 |
string |
Specific field 70. |
No |
paymentSpecificData.f71 |
string |
Specific field 71. |
No |
paymentSpecificData.f72 |
string |
Specific field 72. |
No |
paymentSpecificData.f73 |
string |
Specific field 73. |
Response example
{
"systemTraceAuditNumber" : 51106,
"paymentSpecificData" : {
"f61" : "f61",
"f72" : "f72",
"f60" : "f60",
"f71" : "f71",
"f63" : "f63",
"f62" : "f62",
"f73" : "f73",
"f65" : "f65",
"f64" : "f64",
"f67" : "f67",
"f66" : "f66",
"f58" : "f58",
"f69" : "f69",
"f57" : "f57",
"f68" : "f68",
"f59" : "f59",
"f70" : "f70"
},
"acquirerFeeAmount" : "acquirerFeeAmount",
"processingCode" : 170000,
"issuerFeeAmount" : "issuerFeeAmount",
"localTransactionDate" : "2000-01-23T04:56:07.000+00:00",
"otp" : "otp",
"authorizationIdResponse" : "123ABC",
"responseCode" : 00,
"rrn" : 987654321987,
"uniqueReferenceNumber" : "uniqueReferenceNumber"
}
p2pTransfer
p2pTransfer from a card to a card.
Request parameters
Mandatory |
Name |
Type |
Description |
No |
preAuthorization |
boolean |
Pre-authorization flag. |
Yes |
sourceCardIdentification |
Object |
Card identification parameters for the source card. For bit of details on other card identification options which can be used in the real project and not in this Sandbox - please check the createVirtualCard description. |
Yes |
sourceCardIdentification.cardNumber |
string |
Card number. You will get it in CreateVirtualCard() response. |
Yes |
sourceCardIdentification.expDate |
string |
Card expiration date. YYYYMM format. |
No |
sourceCardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. Not for the Sandbox. |
No |
sourceCardIdentification.cardNumberMask |
string |
Masked card number. Not for the Sandbox. |
No |
sourceCardIdentification.cardLastDigitMask |
string |
Last digits of the card number. Not for the Sandbox. |
No |
sourceCardIdentification.cardId |
string |
Card id. Not for the Sandbox. |
No |
sourceCardIdentification.plasticNumber |
integer |
Plastic number. Not for the Sandbox. |
No |
sourceCardIdentification.phoneNumber |
string |
Client phone number. Not for the Sandbox. |
No |
sourceCardIdentification.cardholderId |
string |
Cardholder id. Not for the Sandbox. |
No |
sourceCardIdentification.customerId |
string |
Client id. Not for the Sandbox. |
No |
sourceCardIdentification.customerNumber |
string |
Client number in SVB02. Not for the Sandbox. |
No |
sourceCardIdentification.barCode |
string |
Bar code. Not for the Sandbox. |
No |
sourceCardIdentification.cvv2 |
string |
CVV2. Not for the Sandbox. |
No |
sourceCardIdentification.externalCardId |
string |
Card id in the bank's external system. Not for the Sandbox. |
No |
sourceCardIdentification.token |
string |
Token. Not for the Sandbox. |
No |
sourceCardIdentification.cardTypeCode |
string |
Card type code. Not for the Sandbox. |
No |
sourceCardIdentification.email |
string |
E-mail. Not for the Sandbox. |
No |
sourceCardIdentification.institutionId |
string |
Internal institution id. Not for the Sandbox. |
Yes |
destinationCardIdentification |
Object |
Identification parameters for the card being credited. For bit of details on other card identification options which can be used in the real project and not in this Sandbox - please check the createVirtualCard description. |
Yes |
destinationCardIdentification.cardNumber |
string |
Card number. You will get it in CreateVirtualCard() response. |
No |
destinationCardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. Not for the Sandbox. |
No |
destinationCardIdentification.cardNumberMask |
string |
Masked card number. Not for the Sandbox. |
No |
destinationCardIdentification.cardLastDigitMask |
string |
Last digits of the card number. Not for the Sandbox. |
No |
destinationCardIdentification.cardId |
string |
Card id. Not for the Sandbox. |
No |
destinationCardIdentification.expDate |
string |
Card expiration date. Not for the Sandbox. |
No |
destinationCardIdentification.plasticNumber |
integer |
Plastic number Not for the Sandbox. |
No |
destinationCardIdentification.phoneNumber |
string |
Client phone number. Not for the Sandbox. |
No |
destinationCardIdentification.cardholderId |
string |
Cardholder id. Not for the Sandbox. |
No |
destinationCardIdentification.customerId |
string |
Client id. Not for the Sandbox. |
No |
destinationCardIdentification.customerNumber |
string |
Client number in SVB02. Not for the Sandbox. |
No |
destinationCardIdentification.barCode |
string |
Bar code. Not for the Sandbox. |
No |
destinationCardIdentification.cvv2 |
string |
CVV2. Not for the Sandbox. |
No |
destinationCardIdentification.externalCardId |
string |
Card id in the bank's external system. Not for the Sandbox. |
No |
destinationCardIdentification.token |
string |
Token. Not for the Sandbox. |
No |
destinationCardIdentification.cardTypeCode |
string |
Card type code. Not for the Sandbox. |
No |
destinationCardIdentification.email |
string |
E-mail. Not for the Sandbox. |
No |
destinationCardIdentification.institutionId |
string |
Internal institution id. Not for the Sandbox. |
Yes |
amount |
integer |
Amount. |
Yes |
currency |
integer |
Currency. ISO 4217 numeric currency code. Use '978' for the Sandbox. |
No |
sourceAccountNumber |
string |
Card number for the card being debited. Not for the Sandbox. |
No |
destinationAccountNumber |
string |
Card number for the card being credited. Not for the Sandbox. |
No |
tds |
Object |
3DS transaction parameters. Not for the Sandbox. |
No |
tds.xid |
string |
VISA 3DS transaction id. Not for the Sandbox. |
No |
tds.cavv |
string |
VISA authentication check value. Not for the Sandbox. |
No |
tds.ucaf |
string |
Mastercard universal authentification field. Not for the Sandbox. |
No |
tds.authenticationIndicator |
string |
E-commerce transaction authentification type. Possible values: [NOT_PERFORMED, TDS_MERCHANT_ONLY, TDS_PERFORMED, ADDITIONAL_PROTOCOL_USED, RECURRENT_PAYMENT_AUTH]. Not for the Sandbox. |
Yes |
senderReceiverInfo |
Object |
Information about the sender and recipient of the payment. Not for the Sandbox. |
Yes |
senderReceiverInfo.senderName |
string |
Sender name in 'Lastname, Firstname' format. |
Yes |
senderReceiverInfo.senderAddress |
string |
Sender address. |
No |
senderReceiverInfo.senderCity |
string |
Sender city. Not for the Sandbox. |
No |
senderReceiverInfo.senderCountry |
string |
Sender country code. Not for the Sandbox. |
No |
senderReceiverInfo.senderPostalCode |
string |
Sender postcode. Not for the Sandbox. |
No |
senderReceiverInfo.receiverName |
string |
Recipient name in 'Lastname, Firstname' format. Not for the Sandbox. |
No |
pointOfServiceDataCode |
string |
A set of codes that determine the capabilities of the terminal, the parameters of its environment and the use of security tools during a transaction. Not for the Sandbox. |
Yes |
pointOfServiceConditionCode |
string |
A code that defines the conditions for conducting a transaction at a service point. Any text. |
No |
cardAcceptorParameters |
Object |
Terminal parameters. Not for the Sandbox. |
No |
cardAcceptorParameters.terminalIdentification |
string |
Terminal id. Not for the Sandbox. |
No |
cardAcceptorParameters.merchantIdentification |
string |
Merchant id. Not for the Sandbox. |
No |
cardAcceptorParameters.merchantType |
string |
Merchant category code. Not for the Sandbox. |
No |
cardAcceptorParameters.nameAndLocation |
string |
Terminal location address. Not for the Sandbox. |
No |
securityLevelIndicator |
string |
Security level indicator. Not for the Sandbox. |
No |
originalTransactionParameters |
Object |
Initial transaction parameters. Must be included in transaction status check request. Not for the Sandbox. |
No |
originalTransactionParameters.systemTraceAuditNumber |
integer |
Audit record number. Not for the Sandbox. |
No |
originalTransactionParameters.localTransactionDate |
DateTime |
Transaction date. Not for the Sandbox. |
No |
originalTransactionParameters.rrn |
string |
External id RNN. Not for the Sandbox. |
No |
posCardholderPresence |
integer |
Cardholder presense at a service point type. Not for the Sandbox. |
No |
businessApplicationIdentifier |
string |
MC transaction type id. Not for the Sandbox. |
Request example
{
"sourceCardIdentification": {
"cardNumber": 4140050021658271,
"expDate": 202201
},
"destinationCardIdentification": {
"cardNumber": 4123940050955625
},
"amount": 1000,
"currency": 978,
"senderReceiverInfo": {
"senderName": "Rozshkovv, Valeriyy",
"senderAddress": "Moscow, Russia"
},
"pointOfServiceDataCode": 810
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
responseCode |
string |
Operation completion code. 00' is for success. |
Yes |
processingCode |
string |
processing code. |
Yes |
systemTraceAuditNumber |
integer |
Audit record number |
Yes |
localTransactionDate |
DateTime |
Transaction date. format: date-time |
Yes |
rrn |
string |
External id RNN. |
No |
authorizationIdResponse |
string |
Authorization id. |
No |
paymentSpecificData |
Object |
Payment specific data. |
Response example
{
"responseCode": "00",
"processingCode": "490000",
"systemTraceAuditNumber": 620400,
"localTransactionDate": "2021-09-23T14:40:05",
"rrn": "000000154799",
"authorizationIdResponse": "154801",
"paymentSpecificData": {}
}
getOrderDetails
Get payment order detailed information.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
orderId |
long |
Payment order id |
Request example
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
transactionList |
Object |
Transaction list. |
Yes |
transactionList.merchantId |
string |
Merchant id. |
Yes |
transactionList.terminalId |
string |
Terminal id. |
Yes |
transactionList.transactionDate |
DateTime |
Transaction date/time. |
No |
transactionList.cardNumber |
string |
Card number. |
No |
transactionList.transactionAmount |
integer |
Transaction amount. |
No |
transactionList.transactionCurrency |
integer |
Transaction currency code |
No |
transactionList.submittedAmount |
integer |
Requested amount. |
No |
transactionList.submittedCurrency |
integer |
Requested currency |
No |
transactionList.authorizationCode |
string |
Authorization code. |
No |
transactionList.cashbackAmount |
integer |
Cashback amount. |
No |
transactionList.transactionType |
string |
Transaction type. |
No |
transactionList.networkType |
string |
Network type. |
No |
transactionList.cardType |
string |
Card type. |
No |
transactionList.orderNumber |
string |
Payment order number. |
Response example
{
"transactionList" : [ {
"terminalId" : "00999201",
"transactionDate" : "2000-01-23T04:56:07.000+00:00",
"merchantId" : "M000001",
} ]
}
getPaymentOrders
Get payment orders list.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
merchantNumber |
string |
Merchant number. |
Yes |
institutionId |
string |
Internal institution id. |
Yes |
period |
Object |
Time span. |
No |
period.start |
DateTime |
Start date. |
No |
period.end |
DateTime |
End date. |
Request example
{
"merchantNumber": "M000001",
"institutionId": "3012",
"period": {
"start": "2020-04-20",
"end": "2020-04-30"
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
orderList |
Object |
Payment orders list. |
Yes |
orderList.id |
long |
Payment order id |
No |
orderList.eventDate |
DateTime |
Event date. |
No |
orderList.purpose |
string |
Purpose. |
No |
orderList.currency |
integer |
Currency code |
No |
orderList.amount |
integer |
Amount. |
No |
orderList.status |
string |
Date of the last status update. |
No |
orderList.orderNumber |
string |
Payment order number. |
Response example
{
"orderList" : [ {
"amount" : 1,
"orderNumber" : "2344552",
"id" : 3,
"eventDate" : "2020-04-30",
} ]
}
getTransactionDetails
Get transaction details.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
utrnno |
long |
Transaction id in SVFE |
No |
reversal |
boolean |
Reversal flag. |
Request example
{
"utrnno": 2203248,
"reversal": true
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
transaction |
Object |
Transaction parameters. |
No |
transaction.boWriteOffDate |
DateTime |
SVBO write-off time and date. |
Yes |
transaction.authorizationDate |
DateTime |
Authorization date/time. |
Yes |
transaction.transactionType |
string |
Transaction type. |
Yes |
transaction.operationDirection |
string |
Transaction direction. Possible values: [CREDIT, DEBIT, NOOP] |
Yes |
transaction.amount |
integer |
Transaction amount. |
Yes |
transaction.currency |
integer |
Operation currency |
Yes |
transaction.amountInAccountCurrency |
integer |
Transaction amount in account currency. |
Yes |
transaction.utrnno |
long |
Transaction id in SVFE |
No |
transaction.boUtrnno |
long |
Transaction ID in SVBO. |
No |
transaction.transactionDescription |
string |
Transaction description. |
No |
transaction.feeDirection |
string |
Fee direction. Possible values: [CREDIT, DEBIT, NOOP] |
No |
transaction.acquireFeeAmount |
integer |
Acquirer fee amount, calculated for SVFE operation. |
No |
transaction.feIssuerFeeAmount |
integer |
Issuer fee amount, calculated for SVFE operation. |
No |
transaction.boIssuerFeeAmount |
integer |
Issuer fee amount, calculated for SVBO operation. |
No |
transaction.mcc |
long |
MCC. |
No |
transaction.merchantCountry |
string |
Merchant country. |
No |
transaction.merchantCity |
string |
Merchant city. |
No |
transaction.merchantName |
string |
Merchant name. |
No |
transaction.merchantId |
string |
Merchant id. |
No |
transaction.terminalAddress |
string |
Terminal address. |
No |
transaction.posDataCode |
string |
POS data code. |
No |
transaction.authorizationIdResponse |
string |
Authorization id. |
No |
transaction.reversalDate |
DateTime |
Reversal date/time. |
No |
transaction.reversal |
boolean |
Reversal flag. |
No |
transaction.requestAmount |
integer |
Requested amount for the transaction. |
No |
transaction.terminalId |
string |
Terminal id. |
No |
transaction.payId |
string |
ID assigned by service provider. |
Response example
{
"transaction": {
"authorizationDate": "2015-04-09T11:15:35+04:00",
"transactionType": 774,
"operationDirection": "debit",
"amount": 10000,
"currency": 978,
"amountInAccountCurrency": 0,
"utrnno": 2203248,
"transactionDescription": "POS purchase",
"feeDirection": "debit",
"acquireFeeAmount": 0,
"feIssuerFeeAmount": 0,
"mcc": 5999,
"merchantCountry": "RUS",
"merchantCity": "MOSCOW1234512345123451234512345",
"merchantName": "PREDPRINIMATEL",
"merchantId": "M999101",
"terminalAddress": "MERCHANT2 RUS MOSCOW ZEMLYANOI VAL 50/A",
"authorizationIdResponse": 0,
"requestAmount": 10,
"terminalId": 1
}
}
getTransactions
Get transactions history for the specific card.
Request parameters
Mandatory |
Name |
Type |
Description |
Yes |
cardIdentification |
Object |
Card identification parameters. For bit of details on other card identification options which can be used in the real project and not in this Sandbox - please check the createVirtualCard description. |
Yes |
cardIdentification.cardNumber |
string |
Card number. You will get it in CreateVirtualCard() response. |
No |
cardIdentification.encryptedCardNumber |
ByteArray |
Encrypted card number. Not for the Sandbox. |
No |
cardIdentification.cardNumberMask |
string |
Masked card number. Not for the Sandbox. |
No |
cardIdentification.cardLastDigitMask |
string |
Last digits of the card number. Not for the Sandbox. |
No |
cardIdentification.cardId |
string |
Card id. Not for the Sandbox. |
No |
cardIdentification.expDate |
string |
Card expiration date. Not for the Sandbox. |
No |
cardIdentification.plasticNumber |
integer |
Plastic number. Not for the Sandbox. |
No |
cardIdentification.phoneNumber |
string |
Client phone number. Not for the Sandbox. |
No |
cardIdentification.cardholderId |
string |
Cardholder id. Not for the Sandbox. |
No |
cardIdentification.customerId |
string |
Client id. Not for the Sandbox. |
No |
cardIdentification.customerNumber |
string |
Client number in SVB02. Not for the Sandbox. |
No |
cardIdentification.barCode |
string |
Bar code. Not for the Sandbox. |
No |
cardIdentification.cvv2 |
string |
CVV2. Not for the Sandbox. |
No |
cardIdentification.externalCardId |
string |
Card id in the bank's external system. Not for the Sandbox. |
No |
cardIdentification.token |
string |
Token. Not for the Sandbox. |
No |
cardIdentification.cardTypeCode |
string |
Card type code. Not for the Sandbox. |
No |
cardIdentification.email |
string |
E-mail. Not for the Sandbox. |
No |
cardIdentification.institutionId |
string |
Internal institution id. Not for the Sandbox. |
Yes |
period |
Object |
Time span. |
No |
period.start |
DateTime |
Start date. YYYY-MM-DD format. |
No |
period.end |
DateTime |
End date. YYYY-MM-DD format. |
Request example
{
"cardIdentification": {
"cardId": 100000000873
},
"period": {
"start": "2020-04-01",
"end": "2022-05-01"
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
transactions |
Object |
Transactions. |
No |
transactions.boWriteOffDate |
DateTime |
SVBO write-off time and date. Not for the Sandbox. |
Yes |
transactions.authorizationDate |
DateTime |
Authorization date/time. |
Yes |
transactions.transactionType |
string |
Transaction type. |
Yes |
transactions.operationDirection |
string |
Transaction direction. Possible values: [CREDIT, DEBIT, NOOP] |
Yes |
transactions.amount |
integer |
Transaction amount. |
Yes |
transactions.currency |
integer |
Currency. |
Yes |
transactions.amountInAccountCurrency |
integer |
Transaction amount in account currency. |
Yes |
transactions.utrnno |
long |
Transaction id in SVFE (SmartVista internal ID). |
No |
transactions.boUtrnno |
long |
Transaction ID in SVBO. (SmartVista internal ID). |
No |
transactions.transactionDescription |
string |
Transaction description. |
No |
transactions.feeDirection |
string |
Fee direction. Possible values: [CREDIT, DEBIT, NOOP] |
No |
transactions.acquireFeeAmount |
integer |
Acquirer fee amount. |
No |
transactions.feIssuerFeeAmount |
integer |
Issuer online fee amount. |
No |
transactions.boIssuerFeeAmount |
integer |
Issuer offline fee amount. |
No |
transactions.mcc |
long |
MCC. |
No |
transactions.merchantCountry |
string |
Merchant country. |
No |
transactions.merchantCity |
string |
Merchant city. |
No |
transactions.merchantName |
string |
Merchant name. |
No |
transactions.merchantId |
string |
Merchant id. |
No |
transactions.terminalAddress |
string |
Terminal address. |
No |
transactions.posDataCode |
string |
POS data code. |
No |
transactions.authorizationIdResponse |
string |
Authorization id. |
No |
transactions.reversalDate |
DateTime |
Reversal date/time. |
No |
transactions.reversal |
boolean |
Reversal flag. |
No |
transactions.requestAmount |
integer |
Requested amount for the transaction. |
No |
transactions.terminalId |
string |
Terminal id. |
No |
transactions.payId |
string |
ID assigned by service provider. |
Response example
{
"transactions": [
{
"authorizationDate": "2021-09-23T14:35:24",
"transactionType": "578",
"operationDirection": "NOOP",
"amount": 0,
"currency": 0,
"amountInAccountCurrency": 0,
"utrnno": 154793,
"transactionDescription": "Change limit",
"feeDirection": "DEBIT",
"acquireFeeAmount": 0,
"feIssuerFeeAmount": 0,
"mcc": 6012,
"merchantCountry": "RUS",
"merchantCity": "BPC TEST ADDRESS N 2",
"merchantName": "Test Mobile Bank",
"merchantId": "TEST__MB",
"terminalAddress": "APIGATE FE TEST BPC TEST ADDRESS N 1",
"posDataCode": "600550U00110",
"reversal": false,
"requestAmount": 0,
"terminalId": "TEST__MB",
"internalResponseCode": -1
},
{
"authorizationDate": "2021-09-23T14:37:36",
"transactionType": "493",
"operationDirection": "NOOP",
"amount": 0,
"currency": 0,
"amountInAccountCurrency": 0,
"utrnno": 154796,
"transactionDescription": "Card blocking",
"feeDirection": "DEBIT",
"acquireFeeAmount": 0,
"feIssuerFeeAmount": 0,
"mcc": 6012,
"merchantCountry": "RUS",
"merchantCity": "BPC TEST ADDRESS N 2",
"merchantName": "Test Mobile Bank",
"merchantId": "TEST__MB",
"terminalAddress": "APIGATE FE TEST BPC TEST ADDRESS N 1",
"posDataCode": "600550U00110",
"authorizationIdResponse": "154796",
"reversal": false,
"requestAmount": 0,
"terminalId": "TEST__MB",
"internalResponseCode": -1
},
{
"authorizationDate": "2021-09-23T14:38:26",
"transactionType": "672",
"operationDirection": "NOOP",
"amount": 0,
"currency": 0,
"amountInAccountCurrency": 0,
"utrnno": 154797,
"transactionDescription": "Card status change",
"feeDirection": "DEBIT",
"acquireFeeAmount": 0,
"feIssuerFeeAmount": 0,
"mcc": 6012,
"merchantCountry": "RUS",
"merchantCity": "BPC TEST ADDRESS N 2",
"merchantName": "Test Mobile Bank",
"merchantId": "TEST__MB",
"terminalAddress": "APIGATE FE TEST BPC TEST ADDRESS N 1",
"posDataCode": "600550U00110",
"authorizationIdResponse": "154797",
"reversal": false,
"requestAmount": 0,
"terminalId": "TEST__MB",
"internalResponseCode": -1
},
{
"authorizationDate": "2021-09-23T14:39:15",
"transactionType": "760",
"operationDirection": "CREDIT",
"amount": 10000,
"currency": 978,
"amountInAccountCurrency": 10000,
"utrnno": 154798,
"transactionDescription": "Credit account presentment",
"feeDirection": "CREDIT",
"acquireFeeAmount": 0,
"feIssuerFeeAmount": 0,
"mcc": 6012,
"merchantCountry": "RUS",
"merchantCity": "BPC TEST ADDRESS N 2",
"merchantName": "Test Mobile Bank",
"merchantId": "TEST__MB",
"terminalAddress": "APIGATE FE TEST BPC TEST ADDRESS N 1",
"posDataCode": "600550U00110",
"authorizationIdResponse": "154798",
"reversal": false,
"requestAmount": 10000,
"terminalId": "TEST__MB",
"internalResponseCode": -1
},
{
"authorizationDate": "2021-09-23T14:40:05",
"transactionType": "781",
"operationDirection": "DEBIT",
"amount": 1000,
"currency": 978,
"amountInAccountCurrency": 1000,
"utrnno": 154800,
"transactionDescription": "P2P Debit part",
"feeDirection": "DEBIT",
"acquireFeeAmount": 0,
"feIssuerFeeAmount": 0,
"mcc": 6012,
"merchantCountry": "RUS",
"merchantCity": "BPC TEST ADDRESS N 2",
"merchantName": "Test Mobile Bank",
"merchantId": "TEST__MB",
"terminalAddress": "APIGATE FE TEST BPC TEST ADDRESS N 1",
"posDataCode": "600550U00110",
"authorizationIdResponse": "154800",
"reversal": false,
"requestAmount": 1000,
"terminalId": "TEST__MB",
"internalResponseCode": -1
},
{
"authorizationDate": "2021-09-23T14:40:05",
"transactionType": "689",
"operationDirection": "NOOP",
"amount": 1000,
"currency": 978,
"amountInAccountCurrency": 1000,
"utrnno": 154799,
"transactionDescription": "Card-to-Card money transfer",
"feeDirection": "DEBIT",
"acquireFeeAmount": 0,
"feIssuerFeeAmount": 0,
"mcc": 6012,
"merchantCountry": "RUS",
"merchantCity": "BPC TEST ADDRESS N 2",
"merchantName": "Test Mobile Bank",
"merchantId": "TEST__MB",
"terminalAddress": "APIGATE FE TEST BPC TEST ADDRESS N 1",
"posDataCode": "600550U00110",
"authorizationIdResponse": "154801",
"reversal": false,
"requestAmount": 1000,
"terminalId": "TEST__MB",
"internalResponseCode": -1
}
]
}
getTransactionCurrencies
Get transaction currencies.
Request example
{
"cardIdentification": {
"cardId": "1000"
}
}
Response parameters
Mandatory |
Name |
Type |
Description |
Yes |
transaction.currency |
integer |
Currency code |
Response example
{
"currencies": [
978
]
}