You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

To pay with a token, you need to send a request to the IPS Assist server in JSON format (swagger description: https://docs.belassist.by/swagger/ ).  

The request URL for transfer the encrypted payment data block:

https://<SERVER_NAME>/pay/tokenpay.cfm  ,

As  <SERVER_NAME> you should use the received from support service value as the domain name.

List of request parameters:

Parameter

Mandatory   field

Adopted   values

Default   value

Description

Merchant_ID

Yes

Number


The enterprise identifier in IPS Assist

Login

Yes

8-20 characters


Login in IPS Assist (Latin letters, digits and symbol _)

Password

Yes

8-20 characters


Password in IPS Assist (Latin letters and digits)

OrderNumber

Yes

128 characters


Order number in the merchant payments system

OrderAmount

Yes

Number, 15 digits, two digits after the delimiter (delimiter '.')


Payment amount, in original currency (e.g., 10.34).

OrderCurrency

No

3 characters

Currency of legal entity/enterprise

Code of currency of the  OrderAmount

Order Comment

No

4000 characters


Comment.

Delay

No

0 – one-stage operation

1 – double-stage operation

0

Attribute of a bankcard authorization for the double-stage operation mode.

Language

No

RU – Russian,

EN – English

Language of legal entity/enterprise

Language of authorized pages

ClientIP

No

Maximum of 15 digits, 4 delimiters «.»


IP-address of the customer

TokenType

No

1 – Apple Pay;
2 – Google Pay;
3 – Samsung Pay;
5 – Assist.

1

Payment Token Type Identifier

5 - payment token Assist is used for CIT COF operations

PaymentToken

No

JSON


For token types 1-3 - provider payment token (Apple Pay, Google Pay; Samsung Pay).

For Assist payment token (token type 5) - {"Token": "<UUID>", "CustomerNumber": "<CustomerNumber>"}

Lastname

No

70 characters


Customer's last name.

Firstname

No

70 characters


Customer's first name.

Middlename

No

70 characters


Customer's middle name.

Email

No

128 characters


Customer's e-mail.

Address

No

256 characters


Customer's address.

HomePhone

No

64 characters


Customer's home phone number.

WorkPhone

No

20 characters


Customer's work phone number.

MobilePhone

No

20 characters


Customer's mobile phone number.

Fax

No

20 characters


Customer's fax number.

Country

No

3 characters


Customer's country.

State

No

3 characters


Customer's region.

City

No

70 characters


Customer's city.

Zip

No

25 characters


Customer's post zip code.

isConvert

No

0 – do not convert to the base currency

1 - do not convert to the base currency if possible

2 – always convert to the base currency

1

Currency conversion indicator

Format

No

4 – SOAP
5 – JSON

5

Results format.

Signature

No

String


The   string   is   joined   from   the   following   order   parameters:

Merchant_ID;OrderNumber;OrderAmount;OrderCurrency

with   semicolon   as   delimiter.

Then  the  MD5   hash   prepared   from   this   string.   Hash   is   signed   by   private   RSA   key   of   the   merchant.   Key   length   -   1024.   Received   bit   sequence   is   a   signature.   Signature   is   transferred   BASE64   coded   string.

Attention! The parameter is necessary in order to protect the transmitted data from the possibility of their substitution by intruders. You should also enable the  setting  for check value or signature in the Personal account.

RecurringIndicator

No

1 –recurring payment

0 – standard payment

0

Recurring payment indicator

RecurringMinAmount

No/Yes

Number, 15 digits, two digits after the delimiter (delimiter '.')


Minimum payment amount for recurring payments

Mandatory when RecurringIndicator = 1

RecurringMaxAmount

No/Yes

Number, 15 digits, two digits after the delimiter (delimiter '.')


Maximum payment amount for recurring payments

Mandatory when RecurringIndicator = 1

RecurringPeriod

No/Yes

10 digits number


Recurring interval in days

Mandatory when RecurringIndicator = 1

RecurringMaxDate

No/Yes

Date in string representation DD.MM.YYYY


Finish date of recurring payments

Mandatory when RecurringIndicator = 1

The   list   of   response   parameters:

Name

Description

Order parameters

ordernumber

Order number

billnumber

Unique order number in IPS Assist

testmode

Test mode

ordercomment

Comment

orderamount

Original amount of order

ordercurrency

Original currency of order

firstname

Payer's first name

lastname

Payer's last name

middlename

Payer's middle name

Email

Payer's e-mail

orderdate

Date of order (GMT)

orderstate

Order status

packetdate

Request issue date (GMT)

signature

·         For signature type 'MD5' - empty

·         For signature type 'PGP' – value X signed by secured key of IPS Assist, BASE64 encoded

checkvalue

uppercase(md5(uppercase(md5(SALT) + md5(Х)))),  where  SALT –  secret word ; Х –  result of the following parameters string concatenation  merchant_id, ordernumber, orderamount, ordercurrency, orderstate ( without delimiters), + - means string concatenation

Operation parameters

billnumber

Extended format of Billnumber: billnumber.<operation number>

operationtype

Operation type

operationstate

Operation status

amount

Operation amount

currency

Currency of operation

ipaddress

Payer's IP-address

clientip

Client's IP-address

meantype_id

Payment means ID

meantypename

Type of payment means

meansubtype

Payment means subtype

meannumber

Number of payment means

cardholder

Payment means holder

issuebank

Name of issue bank

bankcountry

Country of issue bank

responsecode

Response code

message

Operation result message

customermessage

Result message for a customer

recommendation

Recommendation

approvalcode

Authorization code

protocoltypename

Protocol

processingname

Processing name

operationdate

Operation date and time(GMT)

authresult

3Ds authorization result (Y – success, N - fail, A - Attempt, U – unknown)

authrequired

The card involvement in 3Ds check result (1 – involved, 0 – not involved, -1 – unknown, null – error appear during involvement check)

slipno

Financial transaction identifier

firstcode*

The first code of automated interfaces error

secondcode*

The second code of automated interfaces error

continueurl*

The address to redirect to the authentication page for the buyer

*Parameters are responsed only if the payment is made with a non- tokenized card for ECOM operations with customer redirection to the CVC2 entry page and, if necessary, additional 3DSecure authentication. In this case, the parameters firstcode and secondcode take the values "3" and "115", respectively.


Attention! Please, note that several operations can be created within one order (payment, payment confirmation, cancellation). Furthermore, there can be several payment operations within one order, if some of them were unsuccessful. The order can have the only one successful payment operation. Thus there can be several enclosed operations within one order number in the response to a request for the operations results.