Page History
...
Subsequent operations can be initiated by the payer. These operations are called «Customer Initialized Transaction» (CIT).
The One Click program service is used to implement CIT COF operations in IPS Assist.
By participating in the program service, the company maintains its database of customers, giving them an unique number (CustomerNumber), while the Assist system stores the encrypted credit card data corresponding to those merchant customers (CustomerNumber).
While performing of order payment, the customer gets an offer to save the card for future payments using the One Click program service.
The One Click program allows service allows a regular customer of a merchant to make new purchases without entering card data. The payment requires only confirmation by the CVC2 code. However, for subsequent operations CIT COF with a saved card, CVC2 will usually not be requested (except the cases where special settings are made at the request of the merchant).
...
After the customer completes the payment for the order, a message with the payment parameters can be sent to the server of the merchant using the HTTP POST or SOAP method (for more details, see section 3.5 of the document «Setting up the technical interaction with IPS Assist») or the merchant can request the payment results by calling the orderresult web service.
...
When the merchant builds the next order, it is possible to redirect to the IPS Assist payment page to pay with the earlier saved card. In this case, the merchant must send order data with a unique customer number, i.e. in addition to the authorized request parameters, it is necessary to transfer the CustomerNumber.
| Note |
|---|
This parameter must not be transmitted simultaneously with the RecurringIndicator, RecurringMinAmount, RecurringMaxAmount, RecurringPeriod, RecurringMaxDate parameters. |
All actions related to payment by a saved card are performed on the Assist side.
...
Parameter | Mandatory field | Adopted values | Default value | Description |
RecurringIndicator | NoYes | 1 –recurring payment | 0 | Recurring payment indicator |
The remaining parameters related to the restrictions on the amount of payment and the frequency of their execution are optional.
| Note | ||
|---|---|---|
Payment will be made as a MIT COF operation only if the corresponding processing is set up for the merchant in the IPS Assist. Otherwise, the transaction will be carried out as a regular recurrent payment
|
Additional web services for COF
Getting a list of customer cards tokens
The web service allows to a merchant to receive a list of tokens of cards by the unique identifier of their client.
To access the web service send a request using the POST method to the request URL https://<SERVER_NAME>/pay/oneclick/v1/token.cfm with parameters in JSON format.
List of request parameters:
...
Parameter
...
Mandatory field
...
Adopted values
...
Default value
...
Description
...
Merchant
...
Merchant_ID
...
Yes
...
Number
...
The enterprise identifier in IPS Assist
...
Login
...
Yes
...
20 characters
...
Web service user login
...
Password
...
Yes
...
30 characters
...
Web service user password
...
CustomerNumber*
...
Yes
...
32 characters
...
Merchant's internal customer identification
...
Language
...
No
...
RU - Russian,
EN - English
...
Language of legal entity/enterprise
...
Language of authorized pages
| ||||||
RecurringMinAmount | Yes | Number, 15 digits, two digits after the delimiter (delimiter '.') | Min amount of recurrent payments. Mandatory if RecurringIndicator = 1
| |||
RecurringMaxAmount | Yes | Number, 15 digits, two digits after the delimiter (delimiter '.') | Max Amount of recurrent payments. Mandatory if RecurringIndicator = 1
| |||
RecurringCount | Yes | Number, 3 digits | Frequency of recurrent payments in days. Mandatory if RecurringIndicator = 1
| |||
RecurringMaxDate | Yes | Date as string in DD.MM.YYYY format | The end date of recurrent payments. Mandatory if RecurringIndicator = 1
|
| Note | ||
|---|---|---|
Payment will be made as a MIT COF operation only if the corresponding processing is set up for the merchant in the IPS Assist. Otherwise, the transaction will be carried out as a regular recurrent payment
|
Additional web services for COF
Getting a list of customer cards tokens
The web service allows to a merchant to receive a list of tokens of cards by the unique identifier of their client.
To access the web service send a request using the POST method to the request URL https://<SERVER_
*The parameter is automatically validated according to the rules.
An example of request:
...
| language | xml |
|---|
...
NAME>/pay/oneclick/v1/token.cfm with parameters in JSON format.
List of request parameters:
Parameter | Mandatory field | Adopted values | Default value | Description | |
Merchant | Merchant_ID | Yes | Number | The enterprise identifier in IPS Assist | |
Login | Yes | 20 characters | Web service user login | ||
Password | Yes | 30 characters | Web service user password | ||
CustomerNumber* | Yes | 32 characters | Merchant's internal customer identification | ||
Language | No | RU - Russian, EN - English | Language of legal entity/enterprise | Language of authorized pages | |
*The parameter is automatically validated according to the rules.
An example of request:
| Code Block | ||
|---|---|---|
| ||
POST https://<SERVER-NAME>/pay/oneclick/v1/token.cfm POST data:{"merchant" POST data:{"merchant":{"merchant_id":"452739", "login":"LOGIN", "password":"PASSWORD"}, "customernumber":"1234", "language":"RU"} |
...
Parameter | Adopted values | Description | |
assetType | BRAND_LOGO | Type of card design graphic component | |
altText | |||
paymentType | VISA | Payment system type | |
assetData | |||
url | URL of the file containing the image Type of card design graphic component | altText | |
paymentType | VISA | Payment system type | |
assetData | url | URL of the file containing the image of card design graphic component | |
mediaType | image/png | Image file format | width | Image dimensions in pixels | height |
In case of an error, the service returns the error data in JSON format.
{"fault":{"detail":"<error message>","faultcode":<first tcode>,"faultstring":<second code >}}.
Example of the response when the customer has several cards:
mediaType | image/png | Image file format |
width | Image dimensions in pixels | |
height |
In case of an error, the service returns the error data in JSON format.
{"fault":{"detail":"<error message>","faultcode":<first tcode>,"faultstring":<second code >}}.
Example of the response when the customer has several cards:
| Code Block | ||
|---|---|---|
| ||
[{"expire":"12.2025","token":"49D902C6-1CCF-4605-9228-11D0E8115C77","bank":"","brand":"VISA","bin":412362,"active":true,"needCVC":false,"post":"0028","assets":[{"assetType":"ICON","altText":"cardSymbol","paymentType":"VISA","assetData":[
{"url":"https://emvts-test-assets.s3.amazonaws.com/A5/VISA/aa3dcd69e8e8407fa2a59a1956994610/w100_h100.png","mediaType":"image/png","width":100,"height":100}
]},{"assetType":"CARD_BACKGROUND | ||
| Code Block | ||
| ||
[{"expire":"12.2025","token":"49D902C6-1CCF-4605-9228-11D0E8115C77","bank":"","brand":"VISA","bin":412362,"active":true,"needCVC":false,"post":"0028","assets":[{"assetType":"ICON","altText":"cardSymboldigitalCardArt","paymentType":"VISA","assetData":[ {"url":"https://emvts-testprod-assets.s3.eu-north-1.amazonaws.com/A5B5/VISA/aa3dcd69e8e8407fa2a59a1956994610fa0ff42cfa9e41b09ae8c2899d61394a/w100w1536_h100h969.png","mediaType":"image/png","width":1001536,"height":100969} ]}]},{"assetTypeexpire":"12.2025","token":"4D7F0B0D-B701-47B0-779A-BB0CB5F25A14","bank":"CARD_BACKGROUND","altTextbrand":"digitalCardArtMasterCard","paymentTypebin":518615,"VISAactive":true,"assetDataneedCVC":[ {"url":"https://emvts-prod-assets.s3.eu-north-1.amazonaws.com/B5/VISA/fa0ff42cfa9e41b09ae8c2899d61394a/w1536_h969.png","mediaType":"image/png","width":1536,"height":969} ]}]},{"expire":"12.2025","token":"4D7F0B0D-B701-47B0-779A-BB0CB5F25A14","bank":"","brand":"MasterCard","bin":518615,"active":true,"needCVC":false,"post":"1030","assets":[{"assetType":"BRAND_LOGOfalse,"post":"1030","assets":[{"assetType":"BRAND_LOGO","altText":null,"paymentType":"MC","assetData":[ {"url":"https://emvts-test-assets.s3.amazonaws.com/A5/MC/3789637f-32a1-4810-a138-4bf34501c509/w0_h0.pdf","mediaType":"image/pdf","width":null,"height":null} ]},{"assetType":"ICON","altText":null,"paymentType":"MC","assetData":[ {"url":"https://emvts-testprod-assets.s3.eu-north-1.amazonaws.com/A5B5/MC/3789637fa7556277-32a151e9-48104ef1-a138b503-4bf34501c509dd8989e7a8bf/w0w100_h0h100.pdfpng","mediaType":"image/pdfpng","width":null100,"height":null100} ]},{"assetType":"ICONCARD_BACKGROUND_COMBINED","altText":null,"paymentType":"MC","assetData":[ {"url":"https://emvts-prod-assets.s3.eu-north-1.amazonaws.com/B5/MC/a7556277eb50276e-51e97e28-4ef14cd1-b5039b95-dd8989e7a8bfc8dfbe595db6/w100w1536_h100h969.png","mediaType":"image/png","width":1001536,"height":100969} ]},{"assetType":"CARDISSUER_BACKGROUND_COMBINEDLOGO","altText":null,"paymentType":"MC","assetData":[ {"url":"https://emvts-prod-assets.s3.eu-north-1.amazonaws.com/B5/MC/eb50276ede7ce012-7e28641e-4cd1450c-9b958b4f-c8dfbe595db6a65d78062999/w1536w1372_h969h283.png","mediaType":"image/png","width":15361372,"height":969283} ]},{"assetType":"ISSUER_LOGO","altText":null,"paymentType":"MC","assetData":[ {"url":"https://emvts-prod-assets.s3.eu-north-1.amazonaws.com/B5/MC/de7ce012-641e-450c-8b4f-a65d78062999/w1372_h283.png","mediaType":"image/png","width":1372,"height":283} ]}]}] |
...
]}] |
An example of the response when there is no media data for the card:
| Code Block | ||
|---|---|---|
| ||
[{"expire":"12.2025","token":"91720736-CF93-469C-63A0-E5859815D6BA","bank":"Bank USA","brand":"MasterCard","bin":546792,"active":true,"needCVC":false,"post":"4128","assets":[]}] |
Deleting a stored card (token) of a merchant customer
...