AlliancePay
🇬🇧 English
🇬🇧 English
  • E Commerce platform AlliancePay v2.32.0
  • Authentication
  • Data Encryption
  • Authorization
  • Using an authorization token
  • Key Management Overview
    • PURCHASE Collection Example
    • A2C Collection Example
  • Payment methods H2H
    • PURCHASE
      • PURCHASE Request - Step 1
      • PURCHASE Request - Step 2
    • A2C
    • C2A
      • C2A Transaction Request - Step 1
      • C2A Transaction Request - Step 2
    • ApplePay decrypted
      • PURCHASE
        • Payment Processing Request - Step 1
        • Payment Processing Request - Step 2 (3DS)
      • C2A
        • C2A request Step 1
        • C2A request Step 2 (3DS)
    • ApplePay encrypted
      • Request aPay support on the page
      • Request to receive aPay merchant data
      • Merchant validation request
      • Session Establishment Request in aPay
      • Payment Processing Request
    • GooglePay™ decrypted
      • PURCHASE
        • Payment Processing Request - Step 1
        • Payment Processing Request - Step 2 (3DS)
      • C2A
        • C2A request Step 1
        • C2A request Step 2 (3DS)
    • GooglePay™ encrypted
      • Google Pay™ Documentation
      • Google Pay™ Support Request on the Page
      • Google Pay™ Merchant Data Retrieval Request
      • Payment request
    • REFUND
    • TOKEN
      • PURCHASE
        • Token payment request Step 1
        • 3DS token payment request Step 2
      • C2A
        • Token payment request Step 1
        • 3DS token payment request Step 2
      • Token Creation
      • Retrieve Token by CustomerId
      • Retrieve Token Data
      • Update Token Status
      • Token Statuses
    • Account Verification
      • Card Verification Request Step 1
      • Card verification request Step 2
    • Getting data
      • By OPERATION_ID
      • By merchantRequestId
    • Getting a balance
    • Callback
  • Payment methods HPP
    • PURCHASE
      • Creating an order
      • Receiving order data
    • REFUND
    • Callback
    • Order statuses
  • Dictionary
    • Transaction status
    • Test cases
    • Error codes
    • Value actionCode, responseCode
    • Limits
    • Instructions for reconciliation by registers
      • Fields Description in Registers
    • Whitelist IP addresses and URLs
  • History of changes
Powered by GitBook
On this page
  • Input parameters:
  • Output parameters:
  • An example of a request body
  • Example of response body without 3DS
  • Example response body from 3DS
  1. Payment methods H2H
  2. Account Verification

Card verification request Step 2

{{url}}/ecom/execute_request/payments/v1/execute/verification

Input parameters:

Parameter
Description
Data Format
Required
Example

operationId

Operation ID received in step 1

string

Yes

1697008393082nW0c1jr6KVv

encryptedCardData

Card expiration date and CVV2 encrypted in JWE. First 4 characters are ExpDate, next 3 characters are CVV

string

Yes

2503111 (decrypted format, in YYMMCVV format)

date

Date and time of the payment

string

Yes

{{currentdateT}}.00+00:00

browserInfo

Object containing browser data

object

Yes, if the operation requires 3DS

browserAcceptHeader

HTTP request header

string

Yes, if the operation requires 3DS

text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9

browserUserAgent

Browser user agent string indicating the system being used

string

Yes, if the operation requires 3DS

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like,Gecko)Chrome/87.0.4280.66 Safari/537.36

browserLanguage

Browser language

string

Yes, if the operation requires 3DS

en-US,en

browserColorDepth

Color depth value of the browser screen

string

Yes, if the operation requires 3DS

24

browserScreenHeight

Height of the browser window's viewport

string

Yes, if the operation requires 3DS

800

browserScreenWidth

Width of the browser window's viewport

string

Yes, if the operation requires 3DS

1280

browserTZ

Browser timezone

string

Yes, if the operation requires 3DS

-180

Output parameters:

Parameter
Description
Data Format
Example

type

Transaction type

string

Purchase

rrn

RRN number of the transaction 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

SUCCESS FAIL PENDING REQUIRED_3DS DESIRED_THREEDS_MODE_ERROR

transactionType

Transaction type in numeric value

string

35

merchantRequestId

Merchant request ID

string

72837906-f526-4aef-8d11-58d80b44cb75

transactionCurrency

Payment currency

string

980

merchantCommission

Commission amount

string

2

creationDateTime

Payment creation date

string

2024.09.19 15:29:25.675

modificationDateTime

Payment modification date

string

2024.09.19 15:29:25.675

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 was sent

string

paymentServiceType

Payment type

string

CARD/APPLE_PAY/GOOGLE_PAY

notificationEncryption

Indicates whether callback data is encrypted

string

true/false If the parameter is not passed or false, the callback data will not be encrypted

cardNumberMask

Masked card number

string

5573********0304

desiredThreeDSMode

Indicates whether the merchant desires to use 3DS in the purchase

string

MUST/SHOULD/MUST_NOT

threeDSMode

Indicates whether 3DS was used in the purchase

string

MUST - payment with 3DS MUST_NOT - payment without 3DS

statusThreeDs

3DS transaction status

string

Y - successful 3DS N - unsuccessful 3DS

threeDSServerTransId

Transaction ID in the 3DS system

string

b6c35fdb-28c1-454d-a2f3-51098c26bda4

acsTransId

Transaction ID in the ACS system

string

3e17fabb-71e6-498e-8794-ef8c95c5ba6f

dsTransId

Transaction ID generated by the Directory Server

string

12ebc556-82d3-4e35-9fb8-77ac18b050ea

eci

Electronic Commerce Indicator code indicating the security level of the transaction

string

02

processingMerchantId

Merchant ID in the processing center

string

AE100000

processingTerminalId

Terminal ID in the processing center

string

AE100000

redirect3dsUrl

URL to redirect the client to the issuer's page for 3DS authentication

string

txnType

Transaction subtype

enum

Possible values: NONCVV/noncvv - CVV input and verification are not performed

senderCustomerId

Sender's customer ID

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 email

string

mail@gmail.com

senderCountry

Sender's country

string

Ukraine

senderRegion

Sender's region

string

Kyiv

senderCity

Sender's city

string

Kyiv

senderStreet

Sender's street

string

Sichovykh Striltsiv

senderAdditionalAddress

Additional sender address details (floor, house number, apartment)

string

23

senderItn

Sender's tax identification number

string

123456789

senderPassport

Sender's passport

string

AN123456

senderIp

Sender's IP address

string

123.12.12.12

senderPhone

Sender's phone number

string

380630000000

senderBirthday

Sender's date of birth

string

31.12.2000

senderGender

Sender's gender

string

M

senderZipCode

Sender's postal code

string

12000

senderBankCode

Sender's issuer bank name

string

BANK_ALLIANCE

senderPaymentSystem

Sender's issuer MPS name

string

MasterCard

senderCardNumberMask

Sender's masked card number

string

5573********0304

externalCardToken

Token ID

string

tmkEYenZSa8FV03aawVXxbep

An example of a request body

{
    "operationId": "{{operationId}}",
    "encryptedCardData": "{{encryptedCardData}}",
    "browserInfo": {
        "browserAcceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
        "browserUserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like,Gecko)Chrome/87.0.4280.66 Safari/537.36",
        "browserLanguage": "en-US,en",
        "browserColorDepth": "24",
        "browserScreenHeight": "800",
        "browserScreenWidth": "1280",
        "browserTZ": "-180"
    },
    "date": "{{currentdateT}}.00+00:00"
}

Example of response body without 3DS

{
    "type": "VERIFICATION",
    "rrn": "509310723011",
    "purpose": "",
    "comment": "",
    "coinAmount": 0,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120",
    "operationId": "17436771609101HDujgZphks",
    "ecomOperationId": "1c97b778-d8d0-4680-89eb-8015842b45a3",
    "status": "SUCCESS",
    "transactionType": 215,
    "merchantRequestId": "03185335-3a9f-4aad-a3b9-c8b1e6d4051b",
    "transactionCurrency": "980",
    "creationDateTime": "2025.04.03 13:46:00.846",
    "modificationDateTime": "2025.04.03 13:46:01.465",
    "transactionResponseInfo": {
        "actionCode": "0",
        "responseCode": "00",
        "description": "Операція успішна"
    },
    "productType": "PURCHASE",
    "notificationUrl": "test",
    "paymentServiceType": "CARD",
    "notificationEncryption": false,
    "processingTerminalId": "AE001001",
    "processingMerchantId": "AE001001",
    "creatorSystem": "H2H",
    "desiredThreeDSMode": "MUST_NOT",
    "threeDSMode": "MUST_NOT",
    "senderCustomerId": "1234",
    "senderFirstName": "senderFirstName",
    "senderLastName": "senderLastName",
    "senderMiddleName": "senderMiddleName",
    "senderEmail": "aaaa@gmail.com",
    "senderCountry": "804",
    "senderRegion": "senderRegion",
    "senderCity": "senderCity",
    "senderStreet": "senderStreet",
    "senderAdditionalAddress": "senderAdditionalAddress",
    "senderItn": "5555555",
    "senderPassport": "passport",
    "senderIp": "55.555.44",
    "senderPhone": "5555",
    "senderBirthday": "20000110",
    "senderGender": "Female",
    "senderZipCode": "12345"
}

Example response body from 3DS

{
    "type": "VERIFICATION",
    "purpose": "",
    "comment": "",
    "coinAmount": 0,
    "merchantId": "137d9304-0368-11ed-b939-0242ac1200",
    "operationId": "1743677843021zx9DLwCfxz-",
    "ecomOperationId": "d8abe162-99a1-4cb9-8611-8b610cda510b",
    "status": "REQUIRED_3DS",
    "transactionType": 215,
    "merchantRequestId": "f821a5fa-cbfb-4ace-9c2f-83abc799d3a9",
    "transactionCurrency": "980",
    "creationDateTime": "2025.04.03 13:57:22.957",
    "modificationDateTime": "2025.04.03 13:57:23.752",
    "transactionResponseInfo": {},
    "productType": "PURCHASE",
    "notificationUrl": "test",
    "paymentServiceType": "CARD",
    "notificationEncryption": false,
    "processingTerminalId": "AE001001",
    "processingMerchantId": "AE001001",
    "creatorSystem": "H2H",
    "desiredThreeDSMode": "MUST",
    "threeDSMode": "MUST",
    "threeDSServerTransId": "1a85c9f3-c19c-448a-a4bb-04f265b62a28",
    "redirect3dsUrl": "https://api-ecom-preprod.develop.bankalliance.ua/threeDS/getRedirectHtml/1743677843021zx9DLwCfxz-",
    "senderCustomerId": "1234",
    "senderFirstName": "senderFirstName",
    "senderLastName": "senderLastName",
    "senderMiddleName": "senderMiddleName",
    "senderEmail": "aaaa@gmail.com",
    "senderCountry": "804",
    "senderRegion": "senderRegion",
    "senderCity": "senderCity",
    "senderStreet": "senderStreet",
    "senderAdditionalAddress": "senderAdditionalAddress",
    "senderItn": "5555555",
    "senderPassport": "passport",
    "senderIp": "55.555.44",
    "senderPhone": "5555",
    "senderBirthday": "20000110",
    "senderGender": "Female",
    "senderZipCode": "12345"
}
PreviousCard Verification Request Step 1NextGetting data

Last updated 28 days ago

https://merchant.notification_url/
https://api-ecom-release.develop.bankalliance.ua/threeDS/getRedirectHtml/1702047427621BHu5X99yDbA