A2C
{{url}}/ecom/execute_request/payments/v4/account_to_card
Maximum amount for an A2C transaction request is 29,999.00 UAH.
Exceeding this limit results in an error:
Input Parameters
Parameter
Description
Data Format
Required
Example
merchantRequestId
Unique identifier generated by the merchant system, used to check the transaction status in case of an unknown error or disconnection.
string(36)
Yes
137d9304-0368-11ed-b939-0242ac120002
encryptedCardNumber
Recipient's card number encrypted in JWE format using a payment key.
string
Yes
5473670000000304 (decrypted form)
coinAmount
Payment amount.
int
Yes
2000
merchantId
Merchant ID generated in Ecom.
string(36)
Yes
137d9304-0368-11ed-b939-0242ac120002
date
Date and time of the transaction.
string
Yes
{{currentdateT}}.00+00:00
notificationUrl
URL where the callback will be sent.
string
No
https://merchant.notification_url
notificationEncryption
Indicator for callback data encryption.
string
No
true/false (If not provided or set to false, callback data will not be encrypted.)
comment
Additional payment information.
string
No
///5555.25412
purpose
Payment purpose.
string
No
For goods
merchantComment
Additional merchant order comment.
string(255) a-zA-Z0-9 ,.;:@#$%'-=+1,256$
No
merchant Comment id 1258728c1
senderAccount
Sender's account number.
string
No
2900000000000
customerData
Object containing customer data.
object
Yes
-
senderCustomerId
Sender's customer ID.
string(255)
No
1258728c1
senderFirstName
Sender's first name.
string(30)
the value cannot contain only numbers
cannot contain periods or other special characters
cannot contain “NULL”, “3D SECURE”, “SURNAME”, “CARDHOLDER”, ”UNKNOWN”
only alphanumeric values are allowed
can accept a space and a hyphen, but can NOT consist exclusively of “ ” or “-“
a hyphen or space can be inside, but not at the beginning or end
For the apostrophe character, use the only available utf8 character - ' which in: utf 16 - u0027 utf32 - 00000027
No
Ivanenko
senderLastName
Sender's last name.
string(30)
periods or other special characters
cannot contain “NULL”, “3D SECURE”, “SURNAME”, “CARDHOLDER”, ”UNKNOWN”
only alphanumeric values are allowed
can accept a space and a hyphen, but can NOT consist exclusively of “ ” or “-“
a hyphen or space can be inside, but not at the beginning or end
For the apostrophe character, use the only available utf8 character - ' which in: utf 16 - u0027 utf32 - 00000027
No
Ivan
senderMiddleName
Sender's middle name.
string(30)
periods or other special characters
cannot contain “NULL”, “3D SECURE”, “SURNAME”, “CARDHOLDER”, ”UNKNOWN”
only alphanumeric values are allowed
can accept a space and a hyphen, but can NOT consist exclusively of “ ” or “-“
a hyphen or space can be inside, but not at the beginning or end
For the apostrophe character, use the only available utf8 character - ' which in: utf 16 - u0027 utf32 - 00000027
No
Ivanovich
senderEmail
Sender's email.
string(256)
No
mail@gmail.com
senderCountry
Sender's country.
string(3) ISO 3166, 804 for Ukraine
No
804
senderRegion
Sender's region.
string(255)
No
Kyivska
senderCity
Sender's city.
string(25)
No
Kyiv
senderStreet
Sender's street address.
string(35)
No
Sichovykh Striltsiv
senderAdditionalAddress
Additional address details (floor, house number, apartment).
string(255)
No
23
senderItn
Sender's tax identification number.
string(20)
No
123456789
senderPassport
Sender's passport number.
string(255)
No
AN123456
senderIp
Sender's IP address.
string(50)
No
123.12.12.12
senderPhone
Sender's phone number.
string(20)
No
380630000000
senderBirthday
Sender's birth date.
string(50)
No
31.12.2000
senderGender
Sender's gender.
string(50)
No
Male/Female
senderZipCode
Sender's postal code.
string(50)
No
49000
recipientCustomerId
Recipient's customer ID.
string(255)
Yes
1258728c1
recipientFirstName
Recipient's first name.
string(30)
periods or other special characters
cannot contain “NULL”, “3D SECURE”, “SURNAME”, “CARDHOLDER”, ”UNKNOWN”
only alphanumeric values are allowed
can accept a space and a hyphen, but can NOT consist exclusively of “ ” or “-“
a hyphen or space can be inside, but not at the beginning or end
For the apostrophe character, use the only available utf8 character - ' which in: utf 16 - u0027 utf32 - 00000027
No
Ivanenko
recipientLastName
Recipient's last name.
string(30)
periods or other special characters
cannot contain “NULL”, “3D SECURE”, “SURNAME”, “CARDHOLDER”, ”UNKNOWN”
only alphanumeric values are allowed
can accept a space and a hyphen, but can NOT consist exclusively of “ ” or “-“
a hyphen or space can be inside, but not at the beginning or end
For the apostrophe character, use the only available utf8 character - ' which in: utf 16 - u0027 utf32 - 00000027
No
Ivan
recipientMiddleName
Recipient's middle name.
string(30)
periods or other special characters
cannot contain “NULL”, “3D SECURE”, “SURNAME”, “CARDHOLDER”, ”UNKNOWN”
only alphanumeric values are allowed
can accept a space and a hyphen, but can NOT consist exclusively of “ ” or “-“
a hyphen or space can be inside, but not at the beginning or end
For the apostrophe character, use the only available utf8 character - ' which in: utf 16 - u0027 utf32 - 00000027
No
Ivanovich
recipientEmail
Recipient's email.
string(256)
No
mail@gmail.com
recipientCountry
Recipient's country (ISO 3166, 804 for Ukraine).
string(3)
No
804
recipientRegion
Recipient's region.
string(255)
No
Kyivska
recipientCity
Recipient's city.
string(25)
No
Kyiv
recipientStreet
Recipient's street address.
string(35)
No
Sichovykh Striltsiv
recipientAdditionalAddress
Additional recipient's address details.
string(255)
No
23
recipientItn
Recipient's tax identification number.
string(20)
No
123456789
recipientPassport
Recipient's passport number.
string(255)
No
AN123456
recipientIp
Recipient's IP address.
string(50)
No
123.12.12.12
recipientPhone
Recipient's phone number.
string(20)
No
380630000000
recipientBirthday
Recipient's birth date.
string(50)
No
31.12.2000
recipientGender
Recipient's gender.
string(50)
No
Male/Female
recipientZipCode
Recipient's postal code.
string(50)
No
49000
Output Parameters
type
Transaction type
string
ACCOUNT_2_CARD
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 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 numerical format
string
46
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
##########
modificationDateTime
Payment modification date
string
##########
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
A2C
notificationUrl
Callback notification URL
string
https://merchant.notification_url/
paymentServiceType
Payment type
string
CARD/APPLE_PAY/GOOGLE_PAY
notificationEncryption
Callback encryption flag
string
true/false If not provided or set to false, Callback data will be unencrypted
cardNumberMask
Masked card number
string
5573********0304
desiredThreeDSMode
Merchant preference for 3DS
string
MUST/SHOULD/MUST_NOT
threeDSMode
Indicates if 3DS was used
string
MUST - processed with 3DS, MUST_NOT - processed without 3DS
statusThreeDs
3DS transaction status
string
Y - successful, N - failed
threeDSServerTransId
Transaction ID in 3DS system
string
b6c35fdb-28c1-454d-a2f3-51098c26bda4
processingMerchantId
Merchant ID in processing center
string
AE100000
processingTerminalId
Terminal ID in processing center
string
AE100000
redirect3dsUrl
URL for client redirection to issuer page for 3DS authentication
string
https://api-ecom-release.develop.bankalliance.ua/threeDS/getRedirectHtml/1702047427621BHu5X99yDbA
txnType
Transaction subtype
enum
Possible values: NONCVV/noncvv - No CVV entry or verification required
Parameter
Description
Data Format
Example
senderCustomerId
Sender customer ID
string
1258728c1
senderFirstName
Sender first name
string
Ivanenko
senderLastName
Sender last name
string
Ivan
senderMiddleName
Sender middle name
string
Ivanovych
senderEmail
Sender email
string
mail@gmail.com
senderCountry
Sender country
string
Ukraine
senderRegion
Sender region
string
Kyivska
senderCity
Sender city
string
Kyiv
senderStreet
Sender street
string
Sichovykh Striltsiv
senderAdditionalAddress
Additional sender address details (floor, house number, apartment)
string
23
senderItn
Sender tax ID
string
123456789
senderPassport
Sender passport number
string
AN123456
senderIp
Sender IP address
string
123.12.12.12
senderPhone
Sender phone number
string
3,8063E+11
senderBirthday
Sender date of birth
string
31.12.2000
senderGender
Sender gender
string
M
senderZipCode
Sender ZIP code
string
12000
senderBankCode
Sender issuer bank name
string
BANK_ALLIANCE
senderPaymentSystem
Sender issuer MPS name
string
MasterCard
senderCardNumberMask
Masked sender card number
string
5573********0304
Parameter
Description
Data Format
Example
recipientCustomerId
Recipient customer ID
string
1258728c1
recipientFirstName
Recipient first name
string
Ivanenko
recipientLastName
Recipient last name
string
Ivan
recipientMiddleName
Recipient middle name
string
Ivanovych
recipientEmail
Recipient email
string
mail@gmail.com
recipientCountry
Recipient country
string
Ukraine
recipientRegion
Recipient region
string
Kyivska
recipientCity
Recipient city
string
Kyiv
recipientStreet
Recipient street
string
Sichovykh Striltsiv
recipientAdditionalAddress
Additional recipient address details (floor, house number, apartment)
string
23
recipientItn
Recipient tax ID
string
123456789
recipientPassport
Recipient passport number
string
AN123456
recipientIp
Recipient IP address
string
123.12.12.12
recipientPhone
Recipient phone number
string
3,8063E+11
recipientBirthday
Recipient date of birth
string
31.12.2000
recipientGender
Recipient gender
string
M
recipientZipCode
Recipient ZIP code
string
12000
recipientBankCode
Recipient issuer bank name
string
BANK_ALLIANCE
recipientPaymentSystem
Recipient issuer MPS name
string
MasterCard
recipientCardNumberMask
Masked recipient card number
string
5573********0304
Example Request Body
Example of a response body
Last updated