Payment Processing Request - Step 2 (3DS)

{{url}}/ecom/execute_request/payments/v1/apple_pay_3ds/purchase

Incoming JSON Parameters

Parameter	Description	Data Format	Mandatory	Example
operationId	The operation ID obtained in step 1	string	Yes	137d9304-0368-11ed-b939-0242ac120002
date	Date and time of payment	string	Yes	{{currentdateT}}.00+00:00
browserInfo	Object containing browser data	object	Yes, if the operation requires 3DS	-
browserAcceptHeader	HTTP request header	string	Yes, if the operation requires 3DS	text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,/;q=0.8,application/signed-exchange;v=b3;q=0.9
browserUserAgent	Browser software element identifying the system	string	Yes, if the operation requires 3DS	Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36
browserLanguage	Browser language	string	Yes, if the operation requires 3DS	en-US,en
browserColorDepth	Screen color depth value in the browser	string	Yes, if the operation requires 3DS	24
browserScreenHeight	Height of the browser viewport	string	Yes, if the operation requires 3DS	800
browserScreenWidth	Width of the browser viewport	string	Yes, if the operation requires 3DS	1280
browserTZ	Browser timezone offset	string	Yes, if the operation requires 3DS	-180

Output JSON Parameters

Parameter	Description	Data Format	Example
type	Transaction type	string	Purchase
rrn	Transaction reference number in MPS	string	2554256963
purpose	Payment purpose	string	For the goods
comment	Comment	string	test
coinAmount	Payment amount	int	2000
merchantId	Merchant ID	string	137d9304-0368-11ed-b939-0242ac120002
operationId	Transaction ID	string	1712844596346b9F-WwrWZpq
ecomOperationId	Transaction ID in Ecom system	string	8c3303e9-7396-43b8-af4e-31d9facdde9b
merchantName	Merchant name	string	KB test terminal
approvalCode	Authorization code	string	39203
status	Transaction status	string	SUCCESS, FAIL, PENDING, REQUIRED_3DS, DESIRED_THREEDS_MODE_ERROR
transactionType	Transaction type in digital format	string	35
merchantRequestId	Merchant request ID	string	72837906-f526-4aef-8d11-58d80b44cb75
transactionCurrency	Payment currency	string	980
merchantCommission	Commission amount	string	2
createDateTime	Payment creation date	string	2024.09.19 15:29:25.675
modificationDateTime	Payment modification date	string	2024.09.19 15:29:25.675
actionCode	Response code	string	0
responseCode	Response details	string	0
description	Response description	string	approved
bankCode	Issuing bank name	string	BANK_ALLIANCE
paymentSystem	Issuer's MPS name	string	MasterCard
productType	Terminal product type	string	PURCHASE
notificationUrl	URL for CallBack notifications	string	https://merchant.notification_url/
paymentServiceType	Payment type	string	CARD/APPLE_PAY/GOOGLE_PAY
notificationEncryption	CallBack data encryption flag	string	true/false
cardNumberMask	Masked card number	string	5573********0304
desiredThreeDSMode	3DS requirement indicator	string	MUST/SHOULD/MUST_NOT
threeDSMode	3DS usage status	string	MUST/MUST_NOT
statusThreeDs	3DS verification status	string	Y/N
threeDSServerTransId	Transaction ID in the 3DS system	string	b6c35fdb-28c1-454d-a2f3-51098c26bda4
acsTransId	Transaction ID in the ACS system	string	3e17fabb-71e6-498e-8794-ef8c95c5ba6f
dsTransId	Transaction ID generated by Directory Server	string	12ebc556-82d3-4e35-9fb8-77ac18b050ea
eci	Electronic Commerce Indicator	string	02
processingMerchantId	Merchant ID in HR	string	AE100000
processingTerminalId	Terminal ID in PC	string	AE100000
redirect3dsUrl	URL for redirecting clients to issuer's 3DS page	string	https://api-ecom-release.develop.bankalliance.ua/threeDS/getRedirectHtml/1702047427621BHu5X99yDbA
txnType	Transaction type enum	enum	NONCVV/noncvv
senderCustomerId	Sender client ID	string	1258728c1
senderFirstName	Sender's first name	string	Ivan
senderLastName	Sender's last name	string	Ivanenko
senderMiddleName	Sender's patronymic	string	Ivanovych
senderEmail	Sender's email	string	[e-mail]
senderCountry	Sender's country	string	Ukraine

Example Request Body

{
    "operationId": "",
    "browserInfo": {
        "browserAcceptHeader":",
        "browserUserAgent": "",
        "browserLanguage": "",
        "browserColorDepth": "",
        "browserScreenHeight": "",
        "browserScreenWidth": "",
        "browserTZ": ""
    },
    "date": "{{currentdateT}}.00+00:00"
}

Example of response body from 3DS

{
    "type": "PURCHASE",
    "rrn": null,
    "purpose": "purpose",
    "comment": "comment",
    "coinAmount": null,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "operationId": "1712824711120IbbgGHLPNCm",
    "ecomOperationId": "895f15f5-26f7-43cd-8cc1-8f970148425b",
    "merchantName": null,
    "approvalCode": null,
    "status": "REQUIRED_3DS",
    "transactionType": 35,
    "merchantRequestId": "4bf82d10-472d-4ac5-b505-4b7d22ba2686",
    "transactionCurrency": "980",
    "merchantCommission": null,
    "createDateTime": "2024.09.19 15:29:25.675",
    "modificationDateTime": "2024.09.19 15:29:25.675",
    "transactionResponseInfo": {
        "actionCode": null,
        "responseCode": null,
        "description": null
    },
    "bankCode": null,
    "paymentSystem": null,
    "productType": "PURCHASE",
    "notificationUrl": "https://api-ecom-prod.bankalliance.ua/mock",
    "paymentServiceType": "APPLE_PAY",
    "notificationEncryption": false,
    "cardNumberMask": null,
    "desiredThreeDSMode": "MUST",
    "threeDSMode": "MUST",
    "statusThreeDs": null,
    "threeDSServerTransId": "0036703b-839f-4166-a1d8-5fe2f6fb2ea8",
    "redirect3dsUrl": "https://api-ecom-release.develop.bankalliance.ua/threeDS/getRedirectHtml/1712824711120IbbgGHLPNCm",
    "txnType": "null",
    "senderCustomerId": null,
    "senderFirstName": null,
    "senderLastName": null,
    "senderMiddleName": null,
    "senderEmail": null,
    "senderCountry": null,
    "senderRegion": null,
    "senderCity": null,
    "senderStreet": null,
    "senderAdditionalAddress": null,
    "senderItn": null,
    "senderPassport": null,
    "senderIp": null,
    "senderPhone": null,
    "senderBirthday": null,
    "senderGender": null,
    "senderZipCode": null,
    "senderBankCode": null,
    "senderPaymentSystem": null,
    "senderCardNumberMask": null
}