Callback
To send the Callback, a Post request will be made to the notificationUrl that was specified in the payment request. Callback encryption is regulated by the notificationEncryption parameter.
If the status of receiving the Callback is not 200 OK, the Callback is resent after 5 seconds, then after 30 seconds, then after 5 minutes, then after 30 minutes, after 1 hour
If the status of receiving the Callback is not 200 OK for the 1st time, but 200 OK for the 2nd time, then the Callback is no longer resent.
Input parameters
type
Transaction type.
string
Purchase
rrn
RRN transaction number in MPS.
string
2554256963
purpose
Payment purpose.
string
For 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 the Ecom system.
string
8c3303e9-7396-43b8-af4e-31d9facdde9b
merchantName
Merchant name.
string
KB test terminal
approvalCode
Authorization code.
string
39203
status
Transaction status.
string
Possible values: SUCCESS, FAIL, PENDING, REQUIRED_3DS, DESIRED_THREEDS_MODE_ERROR
transactionType
Transaction type in numerical form.
string
35
merchantRequestId
Merchant request id
string
72837906-f526-4aef-8d11-58d80b44cb75
transactionCurrency
Payment currency.
string
980
merchantCommission
Commission amount
string
2
createDateTime
Transaction creation date.
string
19.09.2024 15:29
modificationDateTime
Transaction modification date.
string
19.09.2024 15:29
actionCode
Response code
string
0
responseCode
Response details.
string
0
description
Response description.
string
approved
bankCode
Issuer bank name.
string
BANK_ALLIANCE
paymentSystem
Issuer MPS name.
string
MasterCard
productType
Terminal product type.
string
PURCHASE
notificationUrl
URL to which the CallBack is sent
string
paymentServiceType
Payment type
string
CARD/APPLE_PAY/GOOGLE_PAY
notificationEncryption
Callback data encryption feature
string
true/false If the parameter is not passed or false is passed, then the data in the CallBack will be unencrypted
cardNumberMask
Masked card number
string
5573********0304
desiredThreeDSMode
A feature that indicates whether the merchant wants to use the 3DS in the purchase or not.
string
MUST/SHOULD/MUST_NOT
threeDSMode
A parameter that indicates whether a 3DS is used in the purchase or not
string
MUST- pay with 3DS MUST_NOT- pay without 3DS
statusThreeDs
3DS holding status
string
Y - successful 3ds N - unsuccessful 3ds
threeDSServerTransId
Id of the transaction in the 3ds system
string
8a811df4-91e0-436b-a9ac-9b0772c96f28
acsTransId
Id of the transaction 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 A code that indicates the security level of a transaction
string
2
processingMerchantId
Id of the merchant in PC
string
AE100000
processingTerminalId
Id of the terminal in the PS
string
AE100000
redirect3dsUrl
URL to redirect the client to the issuer's page for the 3DS pass
string
txnType
Under the type of transaction
enum
Possible values: NONCVV/noncvv- upon receipt of a given value of cvv input and its verification does not occur
senderCustomerId
Id of the sender's client
string
1258728c1
senderFirstName
Sender's first name
string
Ivanenko
senderLastName
Sender's last name
string
Ivan
senderMiddleName
Sender's middle name
string
Ivanovich
senderEmail
Sender's mail
string
mail@gmail.com
senderCountry
Sender's country
string
Ukraine
senderRegion
Sender's region.
string (255)
Kyivska
senderCity
Sender's city.
string (25)
Kyiv
senderStreet
Sender's street.
string (35)
Sichovykh Striltsiv
senderAdditionalAddress
Additional address data (floor, house number, apartment).
string (255)
23
senderItn
Sender's tax ID.
string (20)
123456789
senderPassport
Sender's passport.
string (255)
AN123456
senderIp
Sender's IP address.
string (50)
123.12.12.12
senderPhone
Sender's phone number.
string (20)
3,81E+11
senderBirthday
Sender's date of birth.
string (50)
31.12.2000
senderGender
Sender's gender.
string (50)
Male/Female
senderZipCode
Sender's postal code.
string (50)
49000
senderBankCode
Sender's issuing bank
string
BANK_ALLIANCE
senderPaymentSystem
Sender's issuer
string
MasterCard
senderCardNumberMask
Masked card number of the sender
string
5573********0304
recipientCustomerId
Recipient's client id
string(30)
1258728c1
recipientFirstName
Recipient's first name
Ivanenko
recipientLastName
Recipient's last name
Ivan
recipientMiddleName
Recipient's middle name
string(30)
Ivanovich
recipientEmail
Recipient's email
string
mail@gmail.com
recipientСountry
Recipient's county
string
804
recipientRegion
Recipient's region
string
Kyivska
recipientСity
Recipient's city
string
Kyiv
recipientStreet
Recipient's street
string
Sichovykh Striltsiv
recipientAdditionalAddress
Recipient's additional address data (floor, house number, apartment).
string
23
recipientItn
Recipient's tax ID.
string
123456789
recipientPassport
Recipient's passport
string
AN123456
recipientIp
Recipient's IP address.
string
123.12.12.12
recipientPhone
Recipient's phone number
string
3,81E+11
recipientBirthday
Recipient's date of birth.
string
31.12.2000
recipientGender
Recipient's gender
string
Male/Female
recipientZipCode
Recipient's zip code
string
49000
recipientBankCode
Recipient's issuing bank
string
BANK_ALLIANCE
recipientPaymentSystem
Recipient's issuer
string
MasterCard
recipientCardNumberMask
Masked card number of the Recipienr
string
5573********0304
originalOperationId
Id under which the original transaction was created
string
1712843529623cHAHkmt-G5u
originalCoinAmount
Original payment amount
int
100
originalEcomOperationId
Id in the Ekom system under which the original transaction was created
string
c25ee1cb-a052-439b-b075-bcb632615b11
rrnOriginal
RRN original transaction number in MPS
string
123456789
Example of a request body
Example response
Last updated