External system client side requirements

outPaymentId

Payment operation identity number, which is assigned to the operation within the external system.

Integer (15)

outSystemId

External system ID.

Integer (15)

outMerchantId

Merchant identity number (external merchant ID).

Integer (15).

domainId

Application/service code.

Integer (15)

paymentTypeId

Payment type.

Integer (15)

Integer code from the table "Payment types".

e-commerce

1

MO/TO

2

POS

3

Type

paymentAttributes

Payment data (see table "Payment operation data" for details).

List of structures

clientAttributes

Data of client browser, which is used for payment.

List of structures

httpAttributes

Headers of HTTP-request from client browser to external system during the payment.

List of structures

serverAttributes

Variables of environment.

List of structures

timeOut

SOFI response time out (in milliseconds). If this parameter is not set then the default value 10 seconds is used. Negative value will indicate that there is no time-out.

NOTE. There is a possibility to switch off the SOFI notification about fraud-status when time-out expired (by default SOFI sends notifications even if time-out expired). Please, contact the support team to change this behavior.

Integer

sendNotification

True value enforces SOFI to mandatory notify the external system about payment fraud-status after the check finishes its work. By default notification is not send.

Logical (true, false)

paymentStatus

Data for payment status change (see more sect.5.4.1)

Structure of data

name

Parameter name

Sting (case-insensitive)

booleanValue

Filled when the parameter type is logical.

Logical (true, false)

doubleValue

Filled when the parameter type is numerical.

Decimal

stringValue

Filled when the parameter type is string.

String

intValue

Filled when the parameter type is integer.

Integer

dateValue

Filled when the parameter type is data.

Data

Meannumber

The encrypted card number* has to be passed as following string:

"IR_TOKEN=<irreversible token PAN> BIN=<6 first digits of PAN> POST==<4 last digits of PAN>".

Alternatively, you can pass the payment mean number in unencrypted form, but this ability will be removed in the future.

String (70 chars)

meanTypeGroup

Group of payment means: 1 - card (by default), 2 – E-wallet

Integer (1)

meanType

Type of E-wallet (required for E-wallets). Available types of electronic wallets are presented in the table «Type of E-wallets».

String (3 chars)

OutAmount

Payment amount in original currency

Decimal (15,2)

OutCurrencyCode

Currency code (ISO 42 17)

String (3 chars)

BillNumber

Bill number from external system

String (30 chars)

OrderNumber

Order number for payment operation

String (128 chars)

Email

Customer Email

String (128 chars)

Firstname

Customer name

String (128 chars)

Middlename

Customer middle name

String (70 chars)

Lastname

Customer second name

String (70 chars)

Regioncode

Customer region code

String (8 chars)

Regionname

Customer region name

String (70 chars)

City

City

String (70 chars)

Countrycode

Country code (ISO 3166 alpha-2)

String (2 chars)

Address

Customer postal address

String (256 chars)

Postcode

Postal index

String (25 chars)

Phone

Phone number

String (20 chars)

Workphone

Work phone number

String (20 chars)

Mobilephone

Mobile phone number

String (20 chars)

Fax

Fax number

String (20 chars)

Cardholder

Card-holder name

String (130 chars)

Bankname

Issuer-Bank name

String (100 chars)

Acquirer

Acquirer name (unique within the external system).

String (10 chars)

Date

Payment data (UTC data (GMT-0) or GMT+ hour-offset). If it is not provided then current date is used.

Data

Expiredate

Card expire date (month, year). UTC data (GMT-0) or GMT+ hour-offset when time is including.

Data

BillingNumberTag

Type of billing number in favor of which the payment is made as cell phone number, contract number for communication services, etc. Currently, the following types of billing are available for activation:

·         YBIL (Yota billing);

·         MTSBelBlN (MTS Belarussia BillNumber);

·         MTSBelPhN (MTS Belarussia PhoneNumber);

·         MTTPhN (MTT Phone Number);

·         MTTTel (MTT Telecommunication);

·         MTTInt (MTT Internet).

String (10 chars)

BillingNumber

Billing number in favor of which the payment is made.

String (10 chars)

TwoStepSchema

Double stage payment (separate authorization and charge operations are performed). If it is not provided then single stage (one operation assumes authorization and charge is performed).

Logical (true, false)

Additional fields for payments by American Express cards

billingPostalCode

Customer postal index

String (9 chars)

billingAddress

Customer postal address

String (20 chars)

billingFirstName

Customer name

String (15 chars)

billingLastName

Customer second name

String (30 chars)

billingPhoneNumber

Customer phone number

String (10 chars)

billingEMailAddress

Customer E-mail

String (60 chars)

TestMode

Test payment indicator.

Logical (true, false)

RecurringIndicator

Recurring payment indicator

Logical (true, false)

usedCSC

Card Secure Code was used

Logical (true, false)

3DSecAuthresult

3DSecure authorization result (Y - success, N - fail, A - attempt, U –unknown)

String (1 char)

AirData

XML with additional flight data (for air companies)**

Text

BookingData

XML with additional booking data***

Text

3DSecAuthrequired

Result of card 3dS involvement check (1 – involved, 0 – not involved, -1 – not-known, null – all rest)

Decimal (1)