Page History
...
- financial transaction - with card verification and following payment;
- registration transaction - with card verification without a following payment.
...
The One Click 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).
...
*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":{"merchant_id":"452739", "login":"LOGIN", "password":"PASSWORD"}, "customernumber":"1234", "language":"RU"} |
The request result is sent in JSON format and contains the following parameters.
List of response parameters:
Parameter | Value |
token | Token of stored card |
post | Last 4 digits of the card number |
bin | First 6 digits of the card number |
brand | Payment system of the card |
bank | Name of Bank-Issuer |
expire | Month and year of card expiration (MM.YYYY) |
active | Whether the card is valid |
needCVC | Entering of CVC is required for authorization |
assets* | Media data array of the card (determine the appearance of the card) |
*If IPS Assist does not have media data for the card, then this parameter is returned with an empty value in the response.
Contents of the media data array
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 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:
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","altText":"digitalCardArt","paymentType":"VISA","assetData":[ {"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_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-prod-assets.s3.eu-north-1.amazonaws.com/B5/MC/a7556277-51e9-4ef1-b503-dd8989e7a8bf/w100_h100.png","mediaType":"image/png","width":100,"height":100} ]},{"assetType":"CARD_BACKGROUND_COMBINED","altText":null,"paymentType":"MC","assetData":[ {"url":"https://emvts-prod-assets.s3.eu-north-1.amazonaws.com/B5/MC/eb50276e-7e28-4cd1-9b95-c8dfbe595db6/w1536_h969.png","mediaType":"image/png","width":1536,"height":969} ]},{"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
The web service allows a merchant to remove a card token by the unique identifier of its customer.
To access the web service send a request using the POST method to the request URL https://<SERVER_NAME>/pay/oneclick/v1/rem_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 | |
Token | Yes | 36 characters | Token of stored card |
*The parameter is automatically validated according to the rules.
An example of request:
Code Block | ||
---|---|---|
| ||
POST https://<SERVER-NAME>/pay/oneclick/v1/rem_token.cfm
POST data:{"merchant":{"merchant_id":"452739","login":"LOGIN", "password":"PASSWORD"}, "token": "54F5A3DE-4B47-4B40-03B5-7FF992D6B401", "language": "RU", "customernumber":"1234"} |
The request result is sent in JSON format with the message «Token is remowed».
Example of the response:
Code Block | ||
---|---|---|
| ||
{"message":"Token 33479991-B4E5-40FE-D9ED-EDC94BA7FA14 is removed"} |
In case of an error, the service returns the error data in JSON format.
{"fault":{"detail":"<error message>","faultcode":<first tcode>,"faultstring":<second code >}}.