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. You can create as many customers as you want. But only one account per customer can be created in the Sandbox — this restriction is added to simplify the Sandbox logic. In a real project you would be able to create as many accounts per customer as required for your business.
Request parameters
Required
Name
Type
Description
Mandatory
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.
Mandatory
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
Mandatory
parameters.name
string
Identify a parameter in the customer template for which the corresponding value is set.
Mandatory
parameters.value
string
The value to be set for the specific parameter.
The following parameters with their values should be transferred for a customer creation in the Sandbox:
institutionId You got the value in the e-mail after the registration.
agent_number Same as institutionId.
customer_number Any text. Has to be unique in your sandbox project.
product_id You got the value in the e-mail after the registration.
start_date Any date in the past. YYYY-MM-DD format.
service_id_acc You got the value in the e-mail after the registration.
surnamefirstNamesecondNameemailmobile_phoneregioncitystreethouseapartment8 postal_code Customer data parameters. Can be any text.
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
Required
Name
Type
Description
Mandatory
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.
Mandatory
cardIdentification.cardNumber
string
Card number. You will get it in CreateVirtualCard() response.
Optional
cardIdentification.encryptedCardNumber
ByteArray
Encrypted card number. Not for the Sandbox.
Optional
cardIdentification.cardNumberMask
string
Masked card number. Not for the Sandbox.
Optional
cardIdentification.cardLastDigitMask
string
Last digits of the card number. Not for the Sandbox.
Optional
cardIdentification.cardId
string
Card id. Not for the Sandbox.
Optional
cardIdentification.expDate
string
Card expiration date. Not for the Sandbox.
Optional
cardIdentification.plasticNumber
integer
Plastic number Not for the Sandbox.
Optional
cardIdentification.phoneNumber
string
Client phone number. Not for the Sandbox.
Optional
cardIdentification.cardholderId
string
Cardholder id. Not for the Sandbox.
Optional
cardIdentification.customerId
string
Client id. Not for the Sandbox.
Optional
cardIdentification.customerNumber
string
Client number in SVB02. Not for the Sandbox.
Optional
cardIdentification.barCode
string
Bar code. Not for the Sandbox.
Optional
cardIdentification.cvv2
string
CVV2. Not for the Sandbox.
Optional
cardIdentification.externalCardId
string
Card id in the bank's external system. Not for the Sandbox.
Optional
cardIdentification.token
string
Token. Not for the Sandbox.
Optional
cardIdentification.cardTypeCode
string
Card type code. Not for the Sandbox.
Optional
cardIdentification.email
string
E-mail. Not for the Sandbox.
Optional
cardIdentification.institutionId
string
Internal institution id.
Mandatory
hotCardStatus
integer
Card status. Should be '6' for the Sandbox. This means the card is blocked and should be captured on usage attempt.
Card identification parameters. Possible identification options: (cardNumber) or (cardId) or (cardNumberMask and cardholderId) or (cardNumberMask and phoneNumber).
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
Required
Name
Type
Description
Mandatory
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.
Mandatory
cardIdentification.cardNumber
string
Card number. You will get it in CreateVirtualCard() response.
Optional
cardIdentification.encryptedCardNumber
ByteArray
Encrypted card number. Not for the Sandbox.
Optional
cardIdentification.cardNumberMask
string
Masked card number. Not for the Sandbox.
Optional
cardIdentification.cardLastDigitMask
string
Last digits of the card number. Not for the Sandbox.
Optional
cardIdentification.cardId
string
Card id. Not for the Sandbox.
Optional
cardIdentification.expDate
string
Card expiration date. Not for the Sandbox.
Optional
cardIdentification.plasticNumber
integer
Plastic number Not for the Sandbox.
Optional
cardIdentification.phoneNumber
string
Client phone number. Not for the Sandbox.
Optional
cardIdentification.cardholderId
string
Cardholder id. Not for the Sandbox.
Optional
cardIdentification.customerId
string
Client id. Not for the Sandbox.
Optional
cardIdentification.customerNumber
string
Client number in SVB02. Not for the Sandbox.
Optional
cardIdentification.barCode
string
Bar code. Not for the Sandbox.
Optional
cardIdentification.cvv2
string
CVV2. Not for the Sandbox.
Optional
cardIdentification.externalCardId
string
Card id in the bank's external system. Not for the Sandbox.
Card identification parameters. Possible identification options: (cardNumber) or (cardId) or (barCode) or (cardNumberMasked and cardholderId) or (cardNumberMasked and phoneNumber).
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
Required
Name
Type
Description
Mandatory
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.
Mandatory
cardIdentification.cardNumber
string
Card number. You will get it in CreateVirtualCard() response.
Optional
cardIdentification.encryptedCardNumber
ByteArray
Encrypted card number. Not for the Sandbox.
Optional
cardIdentification.cardNumberMask
string
Masked card number. Not for the Sandbox.
Optional
cardIdentification.cardLastDigitMask
string
Last digits of the card number. Not for the Sandbox.
Optional
cardIdentification.cardId
string
Card id. Not for the Sandbox.
Optional
cardIdentification.expDate
string
Card expiration date. Not for the Sandbox.
Optional
cardIdentification.plasticNumber
integer
Plastic number. Not for the Sandbox.
Optional
cardIdentification.phoneNumber
string
Client phone number. Not for the Sandbox.
Optional
cardIdentification.cardholderId
string
Cardholder id. Not for the Sandbox.Not for the Sandbox.
Optional
cardIdentification.customerId
string
Client id. Not for the Sandbox.
Optional
cardIdentification.customerNumber
string
Client number in SVB02. Not for the Sandbox.
Optional
cardIdentification.barCode
string
Bar code. Not for the Sandbox.
Optional
cardIdentification.cvv2
string
CVV2. Not for the Sandbox.
Optional
cardIdentification.externalCardId
string
Card id in the bank's external system. Not for the Sandbox.
Optional
cardIdentification.token
string
Token. Not for the Sandbox.
Optional
cardIdentification.cardTypeCode
string
Card type code. Not for the Sandbox.
Optional
cardIdentification.email
string
E-mail. Not for the Sandbox.
Optional
cardIdentification.institutionId
string
Internal institution id. Not for the Sandbox.
Mandatory
limit
Object
Limit parameters.
Mandatory
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.
Card identification parameters. Possible identification options: (cardNumber) or (cardId) or (barCode) or (cardNumberMask and cardholderId) or (cardNumberMask and phoneNumber).
Card identification parameters. (encryptedCardNumber) or (cardNumberMask and phoneNumber) or external card id are required.
Mandatory
cardIdentification.encryptedCardNumber
ByteArray
Encrypted card number.
Mandatory
cardIdentification.cardNumberMask
string
Masked card number.
Mandatory
cardIdentification.cardLastDigitMask
string
Last digits of the card number.
Mandatory
cardIdentification.cardNumber
string
Card number.
Optional
cardIdentification.cardId
string
Card id.
Optional
cardIdentification.expDate
string
Card expiration date.
Optional
cardIdentification.plasticNumber
integer
Plastic number
Optional
cardIdentification.phoneNumber
string
Client phone number.
Optional
cardIdentification.cardholderId
string
Cardholder id.
Optional
cardIdentification.customerId
string
Client id.
Optional
cardIdentification.customerNumber
string
Client number in SVB02.
Optional
cardIdentification.barCode
string
Bar code.
Optional
cardIdentification.cvv2
string
CVV2.
Optional
cardIdentification.externalCardId
string
Card id in the bank's external system.
Optional
cardIdentification.token
string
Token.
Optional
cardIdentification.cardTypeCode
string
Card type code.
Optional
cardIdentification.email
string
E-mail.
Optional
cardIdentification.institutionId
string
Internal institution id.
Optional
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]
Optional
encryptedPinValue
ByteArray
Encrypted PIN.
Optional
pinValue
string
PIN.
Optional
cardAcceptorParameters
Object
Terminal parameters.
Mandatory
cardAcceptorParameters.terminalIdentification
string
Terminal id.
Mandatory
cardAcceptorParameters.merchantIdentification
string
Merchant id.
Mandatory
cardAcceptorParameters.merchantType
string
Merchant category code.
Optional
cardAcceptorParameters.nameAndLocation
string
Terminal location address.
Optional
parameters
Object
List of arbitrary parameters.
Optional
parameters.name
string
Optional
parameters.value
string
Optional
checkCardOnly
boolean
Flag, showing whether it is necessary to only check existence and card status and not form and change PIN.
Card identification parameters. Possible identification options: (cardNumber) or (cardId) or (barCode) or (cardNumberMask and cardholderId) or (cardNumberMask and phoneNumber).
Mandatory
cardIdentification.encryptedCardNumber
ByteArray
Encrypted card number.
Mandatory
cardIdentification.cardNumberMask
string
Masked card number.
Mandatory
cardIdentification.cardLastDigitMask
string
Last digits of the card number.
Mandatory
cardIdentification.cardNumber
string
Card number.
Optional
cardIdentification.cardId
string
Card id.
Optional
cardIdentification.expDate
string
Card expiration date.
Optional
cardIdentification.plasticNumber
integer
Plastic number
Optional
cardIdentification.phoneNumber
string
Client phone number. Must be passed if deliveryMethod is SMS and phoneNumber is NOT used as identification option.
Optional
cardIdentification.cardholderId
string
Cardholder id.
Optional
cardIdentification.customerId
string
Client id.
Optional
cardIdentification.customerNumber
string
Client number in SVB02.
Optional
cardIdentification.barCode
string
Bar code.
Optional
cardIdentification.cvv2
string
CVV2.
Optional
cardIdentification.externalCardId
string
Card id in the bank's external system.
Optional
cardIdentification.token
string
Token.
Optional
cardIdentification.cardTypeCode
string
Card type code.
Optional
cardIdentification.email
string
E-mail.
Optional
cardIdentification.institutionId
string
Internal institution id.
Optional
deliveryMethod
string
Code delivery method. Possible values: [SMS, WS, HALF_AND_HALF, WS_ENCRYPTED, NONE]
Restriction status. Possible values: [ENABLED, DISABLED]
Optional
restrictions.startDate
DateTime
The date when restrictions come into effect.
Optional
restrictions.endDate
DateTime
The date when restrictions are removed.
Response example
{"regions":{"region":[{"id":1,"description":"NETHERLANDS"},{"id":2,"description":"EUROPEAN UNION"}]},"countries":{"country":[{"id":978,"description":"NETHERLANDS"},{"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
Required
Name
Type
Description
Mandatory
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).
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
Required
Name
Type
Description
Mandatory
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.
Mandatory
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.
Optional
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.
Optional
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.
Optional
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.
Optional
cardIdentification.cardId
string
Card id. Not for the Sandbox.
Optional
cardIdentification.expDate
string
Card expiration date. Frequently used with some other card attributes. Not for the Sandbox.
Optional
cardIdentification.plasticNumber
integer
Plastic number. Not for the Sandbox.
Optional
cardIdentification.phoneNumber
string
Client phone number. Frequently used with some other card attributes. Not for the Sandbox.
Optional
cardIdentification.cardholderId
string
Cardholder id. Not for the Sandbox.
Optional
cardIdentification.customerId
string
Client id. Not for the Sandbox.
Optional
cardIdentification.customerNumber
string
Client number in SVB02. Not for the Sandbox.
Optional
cardIdentification.barCode
string
Bar code. Not for the Sandbox.
Optional
cardIdentification.cvv2
string
CVV2. Not for the Sandbox.
Optional
cardIdentification.externalCardId
string
Card id in the bank's external system. Not for the Sandbox.
Optional
cardIdentification.token
string
Token. Not for the Sandbox.
Optional
cardIdentification.cardTypeCode
string
Card type code. Not for the Sandbox.
Optional
cardIdentification.email
string
E-mail. Not for the Sandbox.
Optional
cardIdentification.institutionId
string
Internal institution id. Not for the Sandbox.
Mandatory
virtualCardIdentification
Object
Virtual card parameters. expDate and productType are required.
Mandatory
virtualCardIdentification.expDate
string
Card expiration date. Any future date in "YYYYMM" format.
Mandatory
virtualCardIdentification.productType
string
Product type. Identifies the card product for a card. In the Sandbox should always be constant number '5C' as we set up a one product for you.
Optional
virtualCardIdentification.cardNumber
string
Card number. Not for the Sandbox.
Optional
virtualCardIdentification.cardNumberMask
string
Masked card number. Not for the Sandbox.
Optional
virtualCardIdentification.cardId
string
Card id. Not for the Sandbox.
Optional
virtualCardIdentification.barCode
string
Bar code. Not for the Sandbox.
Optional
virtualCardIdentification.cvv2
string
CVV2/CVC2. Not for the Sandbox.
Mandatory
amount
integer
Default limit for newly created virtual cards. Should be constant number '0' in the Sandbox.
Mandatory
currency
integer
Currency. ISO 4217 numeric currency code. Use '978' for the Sandbox.
Mandatory
accountNumber
string
Account number for primary card identification. Use the account number you got from registerCustomer().
Optional
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.
Returns you the data about the cards you created. Can be used after creating a card with createVirtualCard.
Request parameters
Required
Name
Type
Description
Mandatory
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.
Mandatory
cardIdentification.cardNumber
string
Card number. You will get it in CreateVirtualCard() response.
Optional
cardIdentification.encryptedCardNumber
ByteArray
Encrypted card number. Not for the Sandbox.
Optional
cardIdentification.cardNumberMask
string
Masked card number. Not for the Sandbox.
Optional
cardIdentification.cardLastDigitMask
string
Last digits of the card number. Not for the Sandbox.
Optional
cardIdentification.cardId
string
Card id. Not for the Sandbox.
Optional
cardIdentification.expDate
string
Card expiration date. Not for the Sandbox.
Optional
cardIdentification.plasticNumber
integer
Plastic number Not for the Sandbox.
Optional
cardIdentification.phoneNumber
string
Client phone number. Not for the Sandbox.
Optional
cardIdentification.cardholderId
string
Cardholder id. Not for the Sandbox.
Optional
cardIdentification.customerId
string
Client id. Not for the Sandbox.
Optional
cardIdentification.customerNumber
string
Client number in SVB02. Not for the Sandbox.
Optional
cardIdentification.barCode
string
Bar code. Not for the Sandbox.
Optional
cardIdentification.cvv2
string
CVV2. Not for the Sandbox.
Optional
cardIdentification.externalCardId
string
Card id in the bank's external system. Not for the Sandbox.
Optional
cardIdentification.token
string
Token. Not for the Sandbox.
Optional
cardIdentification.cardTypeCode
string
Card type code. Not for the Sandbox.
Optional
cardIdentification.email
string
E-mail. Not for the Sandbox.
Optional
cardIdentification.institutionId
string
Internal institution id. Not for the Sandbox.
Optional
rsaPublicKey
ByteArray
Open key for card number encryption in return message. Not for the Sandbox.
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.
Mandatory
cardIdentification.cardNumber
string
Card number. You will get it in CreateVirtualCard() response.
Optional
cardIdentification.encryptedCardNumber
ByteArray
Encrypted card number. Not for the Sandbox.
Optional
cardIdentification.cardNumberMask
string
Masked card number. Not for the Sandbox.
Optional
cardIdentification.cardLastDigitMask
string
Last digits of the card number. Not for the Sandbox.
Optional
cardIdentification.cardId
string
Card id. Not for the Sandbox.
Optional
cardIdentification.expDate
string
Card expiration date. Not for the Sandbox.
Optional
cardIdentification.plasticNumber
integer
Plastic number Not for the Sandbox.
Optional
cardIdentification.phoneNumber
string
Client phone number. Not for the Sandbox.
Optional
cardIdentification.cardholderId
string
Cardholder id. Not for the Sandbox.
Optional
cardIdentification.customerId
string
Client id. Not for the Sandbox.
Optional
cardIdentification.customerNumber
string
Client number in SVB02. Not for the Sandbox.
Optional
cardIdentification.barCode
string
Bar code. Not for the Sandbox.
Optional
cardIdentification.cvv2
string
CVV2. Not for the Sandbox.
Optional
cardIdentification.externalCardId
string
Card id in the bank's external system. Not for the Sandbox.
Optional
cardIdentification.token
string
Token. Not for the Sandbox.
Optional
cardIdentification.cardTypeCode
string
Card type code. Not for the Sandbox.
Optional
cardIdentification.email
string
E-mail. Not for the Sandbox.
Optional
cardIdentification.institutionId
string
Internal institution id. Not for the Sandbox.
Mandatory
amount
integer
Amount.
Mandatory
currency
integer
Currency. ISO 4217 numeric currency code. Use '978' for the Sandbox.
Optional
tds
Object
3DS transaction parameters.
Optional
tds.xid
string
VISA 3DS transaction id. Not for the Sandbox.
Optional
tds.cavv
string
VISA authentication check value. Not for the Sandbox.
Optional
tds.ucaf
string
Mastercard universal authentification field. Not for the Sandbox.
Optional
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.
Card identification parameters. Possible identification options: (cardNumber) or (cardId) or (barCode) or (cardNumberMask and cardholderId) or (cardNumberMask and phoneNumber).
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.
Mandatory
sourceCardIdentification.cardNumber
string
Card number. You will get it in CreateVirtualCard() response.
Mandatory
sourceCardIdentification.expDate
string
Card expiration date. YYYYMM format.
Optional
sourceCardIdentification.encryptedCardNumber
ByteArray
Encrypted card number. Not for the Sandbox.
Optional
sourceCardIdentification.cardNumberMask
string
Masked card number. Not for the Sandbox.
Optional
sourceCardIdentification.cardLastDigitMask
string
Last digits of the card number. Not for the Sandbox.
Optional
sourceCardIdentification.cardId
string
Card id. Not for the Sandbox.
Optional
sourceCardIdentification.plasticNumber
integer
Plastic number. Not for the Sandbox.
Optional
sourceCardIdentification.phoneNumber
string
Client phone number. Not for the Sandbox.
Optional
sourceCardIdentification.cardholderId
string
Cardholder id. Not for the Sandbox.
Optional
sourceCardIdentification.customerId
string
Client id. Not for the Sandbox.
Optional
sourceCardIdentification.customerNumber
string
Client number in SVB02. Not for the Sandbox.
Optional
sourceCardIdentification.barCode
string
Bar code. Not for the Sandbox.
Optional
sourceCardIdentification.cvv2
string
CVV2. Not for the Sandbox.
Optional
sourceCardIdentification.externalCardId
string
Card id in the bank's external system. Not for the Sandbox.
Optional
sourceCardIdentification.token
string
Token. Not for the Sandbox.
Optional
sourceCardIdentification.cardTypeCode
string
Card type code. Not for the Sandbox.
Optional
sourceCardIdentification.email
string
E-mail. Not for the Sandbox.
Optional
sourceCardIdentification.institutionId
string
Internal institution id. Not for the Sandbox.
Mandatory
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.
Mandatory
destinationCardIdentification.cardNumber
string
Card number. You will get it in CreateVirtualCard() response.
Optional
destinationCardIdentification.encryptedCardNumber
ByteArray
Encrypted card number. Not for the Sandbox.
Optional
destinationCardIdentification.cardNumberMask
string
Masked card number. Not for the Sandbox.
Optional
destinationCardIdentification.cardLastDigitMask
string
Last digits of the card number. Not for the Sandbox.
Optional
destinationCardIdentification.cardId
string
Card id. Not for the Sandbox.
Optional
destinationCardIdentification.expDate
string
Card expiration date. Not for the Sandbox.
Optional
destinationCardIdentification.plasticNumber
integer
Plastic number Not for the Sandbox.
Optional
destinationCardIdentification.phoneNumber
string
Client phone number. Not for the Sandbox.
Optional
destinationCardIdentification.cardholderId
string
Cardholder id. Not for the Sandbox.
Optional
destinationCardIdentification.customerId
string
Client id. Not for the Sandbox.
Optional
destinationCardIdentification.customerNumber
string
Client number in SVB02. Not for the Sandbox.
Optional
destinationCardIdentification.barCode
string
Bar code. Not for the Sandbox.
Optional
destinationCardIdentification.cvv2
string
CVV2. Not for the Sandbox.
Optional
destinationCardIdentification.externalCardId
string
Card id in the bank's external system. Not for the Sandbox.
Optional
destinationCardIdentification.token
string
Token. Not for the Sandbox.
Optional
destinationCardIdentification.cardTypeCode
string
Card type code. Not for the Sandbox.
Optional
destinationCardIdentification.email
string
E-mail. Not for the Sandbox.
Optional
destinationCardIdentification.institutionId
string
Internal institution id. Not for the Sandbox.
Mandatory
amount
integer
Amount.
Mandatory
currency
integer
Currency. ISO 4217 numeric currency code. Use '978' for the Sandbox.
Optional
sourceAccountNumber
string
Card number for the card being debited. Not for the Sandbox.
Optional
destinationAccountNumber
string
Card number for the card being credited. Not for the Sandbox.
Optional
tds
Object
3DS transaction parameters. Not for the Sandbox.
Optional
tds.xid
string
VISA 3DS transaction id. Not for the Sandbox.
Optional
tds.cavv
string
VISA authentication check value. Not for the Sandbox.
Optional
tds.ucaf
string
Mastercard universal authentification field. Not for the Sandbox.
Optional
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.
Mandatory
senderReceiverInfo
Object
Information about the sender and recipient of the payment. Not for the Sandbox.
Mandatory
senderReceiverInfo.senderName
string
Sender name in 'Lastname, Firstname' format.
Mandatory
senderReceiverInfo.senderAddress
string
Sender address.
Optional
senderReceiverInfo.senderCity
string
Sender city. Not for the Sandbox.
Optional
senderReceiverInfo.senderCountry
string
Sender country code. Not for the Sandbox.
Optional
senderReceiverInfo.senderPostalCode
string
Sender postcode. Not for the Sandbox.
Optional
senderReceiverInfo.receiverName
string
Recipient name in 'Lastname, Firstname' format. Not for the Sandbox.
Optional
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.
Mandatory
pointOfServiceConditionCode
string
A code that defines the conditions for conducting a transaction at a service point. Any text.
Optional
cardAcceptorParameters
Object
Terminal parameters. Not for the Sandbox.
Optional
cardAcceptorParameters.terminalIdentification
string
Terminal id. Not for the Sandbox.
Optional
cardAcceptorParameters.merchantIdentification
string
Merchant id. Not for the Sandbox.
Optional
cardAcceptorParameters.merchantType
string
Merchant category code. Not for the Sandbox.
Optional
cardAcceptorParameters.nameAndLocation
string
Terminal location address. Not for the Sandbox.
Optional
securityLevelIndicator
string
Security level indicator. Not for the Sandbox.
Optional
originalTransactionParameters
Object
Initial transaction parameters. Must be included in transaction status check request. Not for the Sandbox.
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.
Mandatory
cardIdentification.cardNumber
string
Card number. You will get it in CreateVirtualCard() response.
Optional
cardIdentification.encryptedCardNumber
ByteArray
Encrypted card number. Not for the Sandbox.
Optional
cardIdentification.cardNumberMask
string
Masked card number. Not for the Sandbox.
Optional
cardIdentification.cardLastDigitMask
string
Last digits of the card number. Not for the Sandbox.
Optional
cardIdentification.cardId
string
Card id. Not for the Sandbox.
Optional
cardIdentification.expDate
string
Card expiration date. Not for the Sandbox.
Optional
cardIdentification.plasticNumber
integer
Plastic number. Not for the Sandbox.
Optional
cardIdentification.phoneNumber
string
Client phone number. Not for the Sandbox.
Optional
cardIdentification.cardholderId
string
Cardholder id. Not for the Sandbox.
Optional
cardIdentification.customerId
string
Client id. Not for the Sandbox.
Optional
cardIdentification.customerNumber
string
Client number in SVB02. Not for the Sandbox.
Optional
cardIdentification.barCode
string
Bar code. Not for the Sandbox.
Optional
cardIdentification.cvv2
string
CVV2. Not for the Sandbox.
Optional
cardIdentification.externalCardId
string
Card id in the bank's external system. Not for the Sandbox.
SVBO write-off time and date. Not for the Sandbox.
Mandatory
transactions.authorizationDate
DateTime
Authorization date/time.
Mandatory
transactions.transactionType
string
Transaction type.
Mandatory
transactions.operationDirection
string
Transaction direction. Possible values: [CREDIT, DEBIT, NOOP]
Mandatory
transactions.amount
integer
Transaction amount.
Mandatory
transactions.currency
integer
Currency.
Mandatory
transactions.amountInAccountCurrency
integer
Transaction amount in account currency.
Mandatory
transactions.utrnno
long
Transaction id in SVFE (SmartVista internal ID).
Optional
transactions.boUtrnno
long
Transaction ID in SVBO. (SmartVista internal ID).
Optional
transactions.transactionDescription
string
Transaction description.
Optional
transactions.feeDirection
string
Fee direction. Possible values: [CREDIT, DEBIT, NOOP]
Optional
transactions.acquireFeeAmount
integer
Acquirer fee amount.
Optional
transactions.feIssuerFeeAmount
integer
Issuer online fee amount.
Optional
transactions.boIssuerFeeAmount
integer
Issuer offline fee amount.
Optional
transactions.mcc
long
MCC.
Optional
transactions.merchantCountry
string
Merchant country.
Optional
transactions.merchantCity
string
Merchant city.
Optional
transactions.merchantName
string
Merchant name.
Optional
transactions.merchantId
string
Merchant id.
Optional
transactions.terminalAddress
string
Terminal address.
Optional
transactions.posDataCode
string
POS data code.
Optional
transactions.authorizationIdResponse
string
Authorization id.
Optional
transactions.reversalDate
DateTime
Reversal date/time.
Optional
transactions.reversal
boolean
Reversal flag.
Optional
transactions.requestAmount
integer
Requested amount for the transaction.
Optional
transactions.terminalId
string
Terminal id.
Optional
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":"NLD","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":"NLD","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":"NLD","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":"NLD","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":"NLD","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":"NLD","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}]}