Receiving order data

{{url}}/ecom/execute_request/hpp/v1/operations

Input parameters:

Parameter	Description	Data Format	Required	Example
hppOrderId	Order ID	string	Yes	1727703854455xVnw_4_NpkJ

Output parameters:

Parameter	Description	Data Format	Example
coinAmount	order amount	long	2000
ecomOrderId	Order ID in the ECOM system	string	c64a6676-925d-4054-ab21-91face1a05b9
statusUrl	url to redirect to the status page	string	http://pgi-status-ecom-release.develop.bankalliance.ua/?hpp_id=17285615314160DOA6pa1E8F
merchantId	Merchant ID in the ECOM system	string	137d9304-0368-11ed-b939-0242ac120002
hppOrderId	Order ID	string	1727703854455xVnw_4_NpkJ
redirectUrl	link to redirect the customer to the payment page	string	http://pgi-ecom-release.develop.bankalliance.ua/?hpp_id=17285615314160DOA6pa1E8F
hppPayType	payment type	enum	PURCHASE
notificationUrl	url to which the CallBack will be sent	string	https://example.com/notify
merchantRequestId	unique merchant request identifier	string	137d04-0318-11ed-b939-0241ac120104
expiredOrderDate	date and time of order validity	string	2024-10-10 15:13:51.41+03:00
orderStatus	order status	string	PENDING
paymentMethods	payment methods	enum	CARD
createDate	date and time of order creation	string	2024-10-10 14:58:51.36+03:00
operations	object with transaction data	object

Example request

{
    "hppOrderId": "1727703854455xVnw_4_NpkJ"
}

Example response

{
    "coinAmount": 1000,
    "ecomOrderId": "d49e66c3-eae6-4e0c-bd4c-76ee16f1ea65",
    "statusUrl": "https://pgi-status-ecom.develop.bankalliance.ua/?hpp_id=1729673735773zTmfRBLPRgE",
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "hppOrderId": "1729673735773zTmfRBLPRgE",
    "redirectUrl": "https://pgi-ecom.develop.bankalliance.ua/?hpp_id=1729673735773zTmfRBLPRgE",
    "hppPayType": "PURCHASE",
    "notificationUrl": "https://example.com/notify",
    "merchantRequestId": "417382d3-bc5a-4b7b-a84e-fe5ab5210ec9",
    "expiredOrderDate": "2024-10-23 12:10:35.76+03:00",
    "orderStatus": "SUCCESS",
    "paymentMethods": [
        "CARD"
    ],
    "createDate": "2024-10-23 11:55:36.41+03:00",
    "operations": [
        {
            "type": "PURCHASE",
            "rrn": "429708466097",
            "purpose": "Payment for Order №123456",
            "coinAmount": 1000,
            "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
            "operationId": "1729673813027T0LkeMDxpar",
            "ecomOperationId": "ecb27e94-742f-4fcc-b906-e3f1a209c5b1",
            "merchantName": "KB test terminal",
            "approvalCode": "060628",
            "status": "SUCCESS",
            "transactionType": 35,
            "transactionCurrency": "980",
            "merchantCommission": 0,
            "transactionCreateDateTime": "2024.10.23 11:56",
            "transactionModificationDateTime": "2024.10.23 12:26",
            "creationDateTime": "2024.10.23 11:56:54.483",
            "modificationDateTime": "2024.10.23 12:26:59.131",
            "processingDateTime": "2024.10.23 11:56:54.000",
            "transactionResponseInfo": {
                "actionCode": "0",
                "responseCode": "00",
                "description": "approved"
            },
            "bankCode": "BANK_ALLIANCE",
            "paymentSystem": "MasterCard",
            "paymentServiceType": "CARD",
            "notificationEncryption": false,
            "cardNumberMask": "537593••••••0141",
            "desiredThreeDSMode": "SHOULD",
            "threeDSMode": "MUST",
            "threeDSServerTransId": "c76c9f92-5619-4be6-8521-e15a79bce534",
            "senderCustomerId": "Id ",
            "senderMiddleName": "s",
            "senderEmail": "[email protected]",
            "senderCountry": "804",
            "senderRegion": "senderRegion",
            "senderCity": "senderCity",
            "senderStreet": "senderStret",
            "senderAdditionalAddress": "senderAdditionalAddress",
            "senderItn": "5555557777",
            "senderPassport": "passport",
            "senderIp": "255.255.244.255",
            "senderPhone": "380957388888",
            "senderBirthday": "22081989",
            "senderGender": "Female",
            "senderZipCode": "12345",
            "senderBankCode": "BANK_ALLIANCE",
            "senderPaymentSystem": "MasterCard",
            "senderCardNumberMask": "537593••••••0141"
        },
        {
            "type": "REFUND",
            "coinAmount": 10,
            "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
            "ecomOperationId": "4627004b-806c-4ee3-9000-a764cd61981d",
            "status": "FAIL",
            "transactionType": 76,
            "merchantRequestId": "12d76d6e-e753-4216-8fa0-3ed9bb29573b",
            "transactionCurrency": "980",
            "transactionCreateDateTime": "2024.10.24 12:52",
            "transactionModificationDateTime": "2024.10.24 12:52",
            "creationDateTime": "2024.10.24 12:52:41.242",
            "modificationDateTime": "2024.10.24 12:52:41.926",
            "transactionResponseInfo": {},
            "productType": "PURCHASE",
            "errorDetails": "b_security_time_in_request_not_correct",
            "notificationUrl": "https://test.refund.com",
            "notificationEncryption": false,
            "rrnOriginal": "429708466097",
            "originalOperationId": "1729673813027T0LkeMDxpar",
            "originalCoinAmount": 1000,
            "originalEcomOperationId": "ecb27e94-742f-4fcc-b906-e3f1a209c5b1"
        }
    ]
}