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 1

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

Input parameters:

Parameter
Description
Data format
Required
Example

merchantRequestId

unique identifier generated by the merchant system, used to be able to find out the status of the operation if the request ended with an unknown error or disconnection

string(36)

Yes

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

merchantId

Merchant Id generated in Ekom

string(36)

Yes

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

encryptedCardNumber

card number encrypted in JWE using public payment key

string

Yes

5573670000000304 (decrypted form)

desiredThreeDSMode

a flag that indicates whether the merchant wants to use 3DS in the purchase or not.

string (50)

Yes

Default SHOULD

Possible values:

  • MUST - the merchant requires payment with 3DS

  • MUST_NOT - forced operation without 3DS

  • SHOULD - if the card supports 3DS, then we perform a check

notificationUrl

url to which the notification will be sent CallBack

string (1000)

No

https://merchant.notification_url

notificationEncryption

CallBack data encryption flag

string

No

true/false

If the parameter is not passed or is passed false, the data in CallBack will be unencrypted

date

date and time of payment

string

Yes

{{currentdateT}}.00+00:00

comment

additional description of the transaction filled in by the merchant's client

string (1000)

No

///5555.25412

purpose

payment purpose filled in by the merchant

string (255)

No

For product

merchantComment

additional information\merchant comment on the order

string(255)

a-zA-Z0-9 ,.;:@#$%'-=+1,256$

No

merchant Comment id 1258728c1

resultRedirectUrl

Url to redirect the customer after passing 3DS authentication

string (1000)

No

customerData

object with customer data

object

Yes

senderCustomerId

Sender customer ID

string (255)

Yes

1258728c1

senderFirstName

sender name

string (30)

  • 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 spaces and hyphens, but cannot be exclusively with “ “ or “-“

  • a hyphen or space can be inside, but cannot be at the beginning or end

  • For the apostrophe character, use the only available utf8 character - ' which is in: utf 16 - u0027 utf32 - 00000027

No

Ivanenko

senderLastName

sender's last name

string (30)

  • the value cannot contain only numbers

  • cannot contain periods and other special characters

  • only alphanumeric values ​​are allowed

  • can accept space and hyphen, but cannot consist exclusively of “ “ or “-“

  • a hyphen or space can be inside, but cannot be at the beginning or end

  • For the apostrophe character, use the only available utf8 character - ' which is in: utf 16 - u0027 utf32 - 00000027

No

Ivan

senderMiddleName

sender's middle name

string (30)

  • value cannot contain only numbers

  • cannot contain periods or other special characters

  • only alphanumeric values ​​are allowed

  • can accept spaces and hyphens, but cannot consist exclusively of “ “ or “-“

  • a hyphen or space can be inside, but cannot be at the beginning or end

  • For the apostrophe character, use the only available utf8 character - ' which is in: utf 16 - u0027 utf32 - 00000027

No

Ivanovich

senderEmail

sender's email

string (256)

No

senderCountry

sender's country

string (3) ISO 3166, 804 (Ukraine)

No

804

senderRegion

region sender

string (255)

No

Kyiv

senderСity

sender city

string (25)

No

Kyiv

senderStreet

sender street

string (35)

No

Sichovyh striltsiv

senderAdditionalAddress

additional sender address data (floor, house number, apartment)

string (255)

No

23

senderItn

sender's IP address

string (20)

No

123456789

senderPassport

sender's passport

string (255)

No

AN123456

senderIp

sender's IP address

string (50)

No

123.12.12.12

senderPhone

sender phone number

string (20)

No

380630000000

senderBirthday

sender's birthday

string (50)

No

12/31/2000

senderGender

sender's gender

string (50)

No

Male/Female

senderZipCode

Sender Zip Code

string (50)

No

49000

Output parameters:

Parameter
Description
Data Format
Example

type

transaction type

string

Purchase

rrn

transaction RRN 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

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

createDateTime

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 payment system 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

indicator of CallBack data encryption

string

true/false If the parameter is not provided or set to false, the CallBack data will not be encrypted

cardNumberMask

masked card number

string

5573********0304

desiredThreeDSMode

indicator specifying whether the merchant wants to use 3DS in the purchase

string

MUST/SHOULD/MUST_NOT

threeDSMode

parameter indicating whether 3DS was used in the purchase

string

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

statusThreeDs

3DS processing status

string

Y - successful 3DS N - unsuccessful 3DS

threeDSServerTransId

transaction ID in the 3DS system

string

8a811df4-91e0-436b-a9ac-9b0772c96f28

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 for redirecting the client to the issuer's page for 3DS authentication

string

txnType

transaction subtype

enum

Possible values: NONCVV/noncvv - when this value is received, CVV input and verification do not occur

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

senderCountry

sender's country

string

Ukraine

senderRegion

sender's region

string

Kyivska

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 payment system name

string

MasterCard

senderCardNumberMask

sender's masked card number

string

5573********0304

An example of a request body

{
    "merchantId": "137d9304-0368-11ed-b939-0242ac1200",
    "merchantRequestId": "8c1f4b28-5b96-4b0e-bdc6-1d1cc2f2c42a",
    "encryptedCardNumber": "",
    "merchantComment": "",
    "comment": "",
    "purpose": "",
    "resultRedirectUrl": "https://support.google.com/websearch/answer/463?hl=ru",
    "desiredThreeDSMode": "MUST",
    "notificationUrl": "https://webhook.site/739593ac-8e50-48fd-a6c4-0422f9487a6e",
    "notificationEncryption": false,
    "date": "2025-04-03 14:55:14.00+00:00",
    "customerData": {
        "senderCustomerId": "senderCustomerId",
        "senderLastName": "senderLastName",
        "senderEmail": "aaaa@gmail.com",
        "senderFirstName": "senderFirstName",
        "senderMiddleName": "senderMiddleName",
        "senderRegion": "senderRegion",
        "senderCountry": "804",
        "senderAdditionalAddress": "senderAdditionalAddress",
        "senderStreet": "senderStreet",
        "senderCity": "senderCity",
        "senderIp": "55.555.44",
        "senderBirthday": "senderBirthday",
        "senderGender": "senderGender",
        "senderZipCode": "senderZipCode",
        "senderPassport": "senderPassport",
        "senderItn": "senderItn",
        "senderPhone": "senderPhone"
    }
}

Example of response body without 3DS

{
    "type": "VERIFICATION",
    "purpose": "",
    "comment": "",
    "coinAmount": 0,
    "merchantId": "137d9304-0368-11ed-b939-0242ac1200",
    "operationId": "17436921182614gyGFwqQKlb",
    "ecomOperationId": "71baa5d2-d685-4f1e-9b44-3b1e747855dc",
    "status": "PENDING",
    "transactionType": 215,
    "merchantRequestId": "8c1f4b28-5b96-4b0e-bdc6-1d1cc2f2c42a",
    "transactionCurrency": "980",
    "creationDateTime": "2025.04.03 17:55:18.214",
    "modificationDateTime": "2025.04.03 17:55:18.214",
    "transactionResponseInfo": {},
    "productType": "PURCHASE",
    "notificationUrl": "https://webhook.site/739593ac-8e50-48fd-a6c4-0422f9487a6e",
    "paymentServiceType": "CARD",
    "notificationEncryption": false,
    "processingTerminalId": "AE001001",
    "processingMerchantId": "AE001001",
    "creatorSystem": "H2H",
    "desiredThreeDSMode": "MUST",
    "threeDSMode": "MUST",
    "threeDSServerTransId": "6c187d07-e46e-4683-930c-8e8312433130",
    "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": "17436921182614gyGFwqQKlb",
    "ecomOperationId": "71baa5d2-d685-4f1e-9b44-3b1e747855dc",
    "status": "REQUIRED_3DS",
    "transactionType": 215,
    "merchantRequestId": "8c1f4b28-5b96-4b0e-bdc6-1d1cc2f2c42a",
    "transactionCurrency": "980",
    "creationDateTime": "2025.04.03 17:55:18.214",
    "modificationDateTime": "2025.04.03 17:55:18.214",
    "transactionResponseInfo": {},
    "productType": "PURCHASE",
    "notificationUrl": "https://webhook.site/739593ac-8e50-48fd-a6c4-0422f9487a6e",
    "paymentServiceType": "CARD",
    "notificationEncryption": false,
    "processingTerminalId": "AE001001",
    "processingMerchantId": "AE001001",
    "creatorSystem": "H2H",
    "desiredThreeDSMode": "MUST",
    "threeDSMode": "MUST",
    "threeDSServerTransId": "6c187d07-e46e-4683-930c-8e8312433130",
    "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"
}
PreviousAccount VerificationNextCard verification request Step 2

Last updated 28 days ago

mail@gmail.com
https://merchant.notification_url/
https://api-ecom-release.develop.bankalliance.ua/threeDS/getRedirectHtml/1702047427621BHu5X99yDbA
mail@gmail.com
Google Help