Payment Processing Request
{{url}}/ecom/execute_request/payments/v1/apple_pay/token/purchase
Input Parameters:
paymentToken
Payment token object
object
Yes
-
paymentData
Payment data object
object
Yes
-
data
Encrypted data block containing card details, transaction info, etc.
string
Yes
CLtkH05O6bkhXkEdN/0LGtJQGeNT+9PMDp...
transactionIdentifier
Unique transaction identifier generated by Apple Pay
string
Yes
2d4921ff56bf979b76c53b3...
signature
Signature confirming data integrity
string
Yes
MIAGCSqGSIb3DQEHAqCAMIACA...
version
Format version of paymentData indicating Apple Pay specification
string
Yes
EC_v1
header Object:
object
Yes
publicKeyHash
Merchant's public key hash
string
Yes
1LSYfOslX5QlRIUAidZju...
applicationData
Additional data provided by the merchant
string
No
-
wrappedKey
Encrypted symmetric key for additional security
string
No
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8...
ephemeralPublicKey
Temporary public key used for encryption
string
Yes
MFkwEwYHKoZIzj0CAQYIKoZI...
transactionId
Unique transaction identifier
string
Yes
2d4921ff56bf979b76c53b3a..
paymentMethod Object:
object
Yes
displayName
Merchant name displayed to the user
string
Yes
Merchant 5538
network
Payment network used for the transaction
string
Yes
visa, masterCard
type
Transaction type (debit or credit)
string
Yes
debit, credit
Additional Payment Data:
object
merchantRequestId
Unique ID generated by the merchant's system
string(36)
Yes
137d9304-0368-11ed-b939-0242ac120002
merchantId
Merchant ID generated in the system
string(36)
Yes
137d9304-0368-11ed-b939-0242ac120002
desiredThreeDSMode
Indicator if the merchant wants to use 3DS authentication
string(50)
Yes
SHOULD
resultRedirectUrl
URL for client redirection after 3DS authentication
string(1000)
No
https://merchant.redirect.url
notificationUrl
URL for callback notifications
string(1000)
No
https://merchant.notification_url
notificationEncryption
Whether callback data is encrypted
string
No
true/false
date
Payment date and time
string
Yes
{{currentdateT}}.00+00:00
comment
Additional transaction comment
string(1000)
No
///5555.25412
purpose
Payment purpose specified by the merchant
string(255)
No
Product purchase
merchantComment
additional information\comment of the merchant on the order
tring(255) a-zA-Z0-9 ,.;:@#$%'-=+1,256$
No
merchant Comment id 1258728c1
customerData
object
Так
senderCustomerId
Sender's customer ID
string(255)
Yes
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
Ivan
senderLastName
Sender's last 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
Ivanov
senderMiddleName
Sender's middle 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
Ivanovich
senderEmail
Sender's email
string(256)
No
mail@gmail.com
senderCountry
Sender's country (ISO 3166)
string(3)
No
804
senderCity
Sender's city
string(25)
No
Kyiv
senderStreet
sender's street
string (35)
Sichovykh strilʹtsiv
senderAdditionalAddress
additional data of the sender's address (floor, house number, apartment)
string (255)
23
senderItn
IPN of the sender
string (20)
123456789
senderPassport
sender's passport
string (255)
АН123456
senderIp
IP address of the sender
string (50)
123.12.12.12
senderPhone
Sender's phone number
string(20)
No
3,8063E+11
senderBirthday
birthday of the sender
string (50)
31.12.2000
senderGender
Gender of the sender
string (50)
Male/Female
senderZipCode
sender index
string (50)
49000
Response Parameters:
Parameter
Description
Data Format
Example
type
Transaction type
string
CARD_2_ACCOUNT
rrn
Transaction RRN number in MPS
string
2554256963
purpose
Payment purpose
string
For goods
comment
Transaction 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 (numeric)
string
62
merchantRequestId
Merchant request ID
string
72837906-f526-4aef-8d11-58d80b44cb75
transactionCurrency
Payment currency
string
980
merchantCommission
Merchant commission amount
string
2
createDateTime
Payment creation date and time
string
#############
modificationDateTime
Payment modification date and time
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
C2A
notificationUrl
Callback notification URL
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
Merchant preference for 3DS usage
string
MUST/SHOULD/MUST_NOT
threeDSMode
Whether 3DS was used
string
MUST, MUST_NOT
statusThreeDs
3DS transaction status
string
Y, N
threeDSServerTransId
3DS system transaction ID
string
b6c35fdb-28c1-454d-a2f3-51098c26bda4
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 for client redirection for 3DS authentication
string
https://api-ecom-release.develop.bankalliance.ua/threeDS/getRedirectHtml/...
txnType
Transaction subtype.
enum
Possible values: NONCVV/noncvv- upon receipt of a given value of cvv input and its verification does not occur
senderCustomerId
Sender's customer ID.
string (255)
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 email.
string (256)
mail@gmail.com
senderCountry
Sender's country.
string
Ukraine
An example of a request body
Example response body without 3DS
Example of response body from 3DS
Last updated