Completion Request (Finalization of Preauth)

{{url}}/ecom/execute_request/payments/v1/completion

Input Parameters

Parameter Name

Type / Format

Required

Description / Constraints

Example

merchantRequestId

string(36)

Yes

A unique identifier generated by the merchant's system, used to check operation status if the request ends with an unknown error or disconnection.

137d9304-0368-11ed-b939-0242ac120002

merchantId

string(36)

Yes

Merchant ID generated within the Ecom system.

137d9304-0368-11ed-b939-0242ac120002

originalOperationId

string

Yes

The identifier of the original pre-authorization operation (received in Step 1 or 2 of Preauth).

137d9304-0368-11ed-b939-0242ac120002

coinAmount

string

Yes

The completion amount in cents/kopecks.

(Note: This can be equal to or less than the pre-authorized amount).

2500

date

string

Yes

Payment date and time.

{{currentdateT}}.00+00:00

notificationUrl

string(1000)

No

The URL to which the CallBack will be sent.

https://merchant.notification_url

notificationEncryption

string

No

Indicator for CallBack data encryption.

Possible Values: true/false. If omitted or false, data in CallBack will not be encrypted.

true

merchantComment

string(255)

No

Additional information/comment from the merchant regarding the order. (Allowed chars: a-zA-Z0-9 ,.;:@#)

merchant Comment id 1258728c1

comment

string(1000)

No

Additional operation description filled in by the merchant's customer.

///5555.25412

purpose

string(255)

No

Payment purpose filled in by the merchant.

За товар (For goods)

Output Parameters

Parameter Name

Type

Description / Possible Values

Example

type

string

Transaction type.

COMPLETION

rrn

string

RRN (Retrieval Reference Number) of the transaction in the payment system.

2554256963

status

string

Transaction status.

Possible Values: SUCCESS, FAIL, PENDING

SUCCESS

transactionType

string

Transaction type in numerical value.

196

originalOperationId

string

The ID of the original pre-authorization operation (sent in the request).

137d9304-0368-11ed-b939-0242ac120002

preauthOperationId

string

The ID of the original pre-authorization operation.

1712843529623cHAHkmt-G5u

preauthCoinAmount

int

The amount of the original pre-authorization.

100

preauthEcomOperationId

string

Ecom ID under which the pre-authorization operation was created.

c25ee1cb-a052-439b-b075-bcb632615b11

rrnPreauth

string

The RRN of the original pre-authorization in the payment system.

123456789

coinAmount

int

The completed amount (matches the requested amount).

2000

actionCode

string

Response code (0 = success).

0

description

string

Response description.

approved

All other fields

string

Standard fields like merchantId, operationId, createDateTime, etc., are returned.


Request and Response Examples

Example Request Body

JSON

{
    "merchantRequestId":"137d9304-0368-11ed-b939-0242ac120002",
    "originalOperationId":"17594943825392XRyx8EeK6e",
    "merchantId":"137d9304-0368-11ed-b939-0242ac120002",
    "coinAmount":"2500", 
    "notificationUrl": "",
    "date": "2022-11-11 11:58:41.56+00:00"
}

Example Response Body

JSON

{
   "type":"COMPLETION",
   "rrn":"527612892256",
   "purpose":"AAAAfasfsfsfAAAAfasAA",
   "comment":"AAAAfasfsfsfAAAAf",
   "coinAmount":100,
   "merchantId":"137d9304-0368-11ed-b939-0242ac120002",
   "operationId":"17594944974293A5xR2LzpAQ",
   "ecomOperationId":"9ee1923c-11ce-4ac2-9917-899d499ff3d8",
   "status":"SUCCESS",
   "transactionType":196,
   "merchantRequestId":"e582be0c-aa5c-4991-95a3-ff3d5f53a1c6",
   "transactionCurrency":"980",
   "creationDateTime":"2025.10.03 15:28:17.399",
   "modificationDateTime":"2025.10.03 15:28:17.399",
   "transactionResponseInfo":{
      "actionCode":"0",
      "responseCode":"00",
      "description":"Операція успішна"
   },
   "productType":"PURCHASE",
   "notificationUrl":"https://webhook.site/95b1ded7-b86f-46cb-a771-c70f1f913d57",
   "paymentServiceType":"CARD",
   "notificationEncryption":false,
   "processingTerminalId":"AE001001",
   "processingMerchantId":"AE001001",
   "creatorSystem":"H2H",
   "rrnPreauth":"527612892256",
   "preauthOperationId":"17594943825392XRyx8EeK6e",
   "preauthCoinAmount":100,
   "preauthEcomOperationId":"f1a166ce-a19e-46e2-bd7c-2dc90acd1041"
}

Last updated