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 JSON parameters:
  • Output JSON parameters:
  • An example of a request body
  • Example response body without 3DS
  • Example of response body from 3DS
  1. Payment methods H2H
  2. GooglePay™ decrypted
  3. C2A

C2A request Step 1

{{url}}/ecom/execute_request/payments/v3/google_pay/card_to_account

Input JSON parameters:

Parameter

Description

Data Format

Required

Example

The paymentData object to be encrypted with the payment key

​

​

​

​

paymentMethod

Payment credential type. CARD is currently only supported

string

Yes

CARD

authMethod

Method of card transaction authentication. PAN_ONLY - PAN card CRYPTOGRAM_3DS - encrypted PAN

string

Yes

CRYPTOGRAM_3DS

pan

Number of the debited personal account. This line contains only numbers.

string

Yes

#######

expirationMonth

The card's expiration month, where 1 means January, 2 means February, and so on.

number

Yes

10

expirationYear

The four-digit card expiration year, such as 2020.

number

Yes

2025

cryptogram

3-D Secure cryptogram.

string

No

AVn0rK8BiDxN2D/w2j8LMAABAAA=

eciIndicator

This line is not always present. It is only returned for transactions with authenticated device tokens on Android

string(1)

No

4

messageId

A unique identifier that identifies the message in case it needs to be recalled or found later.

string

No

some-message-id

messageExpiration

Дата й час закінчення терміну дії повідомлення в мілісекундах UTC з епохи. Інтегратори повинні відхиляти будь-які повідомлення, термін дії яких минув.

string

No

#######

Additional data for payment

​

​

​

​

merchantRequestId

A unique identifier generated by the merchant's system, used to retrieve the operation status in case of an unknown error or disconnection.

string(36)

Yes

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

merchantId

Merchant ID generated in Ecom.

string(36)

Yes

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

transactionAmount

Payment amount in pennies

string

Yes

2000

desiredThreeDSMode

Indicates whether the merchant prefers to use 3DS in the purchase.

string(50)

Yes

Default: SHOULD MUST - Payment must be processed with 3DS. MUST_NOT - Payment must be processed without 3DS. SHOULD - If the card supports 3DS, verification is performed.

resultRedirectUrl

URL for redirecting the customer after 3DS authentication.

string(1000)

No

Google Help

notificationUrl

The URL to which the CallBack will be sent.

string(1000)

No

https://merchant.notification_url

notificationEncryption

Indicates whether CallBack data is encrypted.

string

No

true/false If not provided or set to false, CallBack data will be unencrypted.

date

Date and time of the payment.

string

Yes

{{currentdateT}}.00+00:00

comment

Additional transaction description provided by the merchant's customer.

string(1000)

No

///5555.25412

purpose

Payment purpose provided by the merchant.

string(255)

No

For goods

merchantComment

Additional information or comments from the merchant regarding the order.

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

No

merchant Comment id 1258728c1

recipientAccount

Recipient's account

string

No

2,9E+12

customerData

Object containing customer details.

object

Yes

-

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

Ivanenko

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

Ivan

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 code.

string(3) (ISO 3166, e.g., 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.

string(35)

No

Sichovykh Striltsiv

senderAdditionalAddress

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

string(255)

No

23

senderItn

Sender's tax identification number.

string(20)

No

#######

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

#######

senderBirthday

Sender's date of birth.

string(50)

No

#######

senderGender

Sender's gender.

string(50)

No

Male

senderZipCode

Sender's postal code.

string(50)

No

49000

recipientCustomerId

Recipient's client id

​string(30)

No

1258728c1

recipientFirstName

Recipient'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

recipientLastName

Recipient'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

Ivan

recipientMiddleName

Recipient'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

recipientEmail

Recipient's email

string

No

mail@gmail.com

recipientСountry

Recipient's county

string

No

804

recipientRegion

Recipient's region

string

No

Kyivska

recipientСity

Recipient's city

string

No

Kyiv

recipientStreet

Recipient's street

string

No

Sichovykh Striltsiv

recipientAdditionalAddress

Recipient's additional address data (floor, house number, apartment).

string

No

23

recipientItn

Recipient's tax ID.

string

No

1,23E+08

recipientPassport

Recipient's passport

string

No

AN123456

recipientIp

Recipient's IP address.

string

No

123.12.12.12

recipientPhone

Recipient's phone number

string

No

381000000000

recipientBirthday

Recipient's date of birth.

string

No

31.12.2000

recipientGender

Recipient's gender

string

No

Male/Female

recipientZipCode

Recipient's zip code

string

No

49000

Output JSON parameters:

Parameter

Description

Data Format

Example

type

Transaction type.

string

Purchase

rrn

RRN transaction number in MPS.

string

2,6E+09

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

#######

modificationDateTime

Transaction 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

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)

1,23E+08

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)

########

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

1,23E+08

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

########

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

An example of a request body

{
	"paymentData": "{{encryptedPaymentData}}",
	"merchantRequestId": "{{requestUUIDT}}",
	"desiredThreeDSMode": "MUST_NOT",
	"notificationUrl": "https://api-ecom-prod.bankalliance.ua/mock",
	"resultRedirectUrl": "",
	"purpose": "purpose",
	"comment": "comment",
	"merchantId": "137d9304-0368-11ed-b939-0242ac120002",
	"currencyCode": "980",
	"transactionAmount": "100",
	"customerData": {
        "senderCustomerId": "1234567",
        "senderFirstName": "John",
        "senderLastName": "Doe",
        "senderMiddleName": "Fall",
        "senderEmail": "test@gmail.com",
        "senderCountry": "sender_country",
        "senderRegion": "sender_region",
        "senderCity": "sender_city",
        "senderStreet": "sender_street",
        "senderAdditionalAddress": "N 6",
        "senderItn": "12345",
        "senderPassport": "12345",
        "senderIp": "165.222.87.224",
        "senderPhone": "380967542344",
        "senderBirthday": "12/12/2000",
        "senderGender": "Male",
        "senderZipCode": "12345",
        "recipientCustomerId": "1234567",
        "recipientFirstName": "Yura",
        "recipientLastName": "Bura",
        "recipientMiddleName": "TestMiddle",
        "recipientEmail": "res@gmail",
        "recipientCountry": "804",
        "recipientRegion": "res_reg",
        "recipientCity": "res_dnipro",
        "recipientStreet": "res_street",
        "recipientAdditionalAddress": "res_addres",
        "recipientItn": "res_iin",
        "recipientPassport": "res_pasport",
        "recipientIp": "165.222.87.224",
        "recipientPhone": "380967542344",
        "recipientBirthday": "12/12/2000",
        "recipientGender": "Female",
        "recipientZipCode": "77777"
    },
	"date": "{{currentdateT}}.00+00:00"
}

Example response body without 3DS

{
    "type": "CARD_2_ACCOUNT",
    "rrn": "410213187859",
    "purpose": "purpose",
    "comment": "comment",
    "coinAmount": null,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "operationId": "17128431233853bBBN9JV2NG",
    "ecomOperationId": "60ae2b45-995a-42c4-bdf5-76e3e8c2a85b",
    "merchantName": null,
    "approvalCode": null,
    "status": "SUCCESS",
    "transactionType": 62,
    "merchantRequestId": "42840103-507e-4541-857d-d66f3ae52332",
    "transactionCurrency": "980",
    "merchantCommission": null,
    "createDateTime": "2024.09.19 15:29:25.675",
    "modificationDateTime": "2024.09.19 15:29:25.675",
    "transactionResponseInfo": {
        "actionCode": null,
        "responseCode": null,
        "description": "Операція успішна"
    },
    "bankCode": null,
    "paymentSystem": null,
    "productType": "C2A",
    "notificationUrl": "https://webhook.site/55533b14-b72b-4d6b-b9bc-1906103240ba",
    "paymentServiceType": "GOOGLE_PAY",
    "notificationEncryption": false,
    "senderCardNumberMask": null,
    "desiredThreeDSMode": "MUST_NOT",
    "threeDSMode": "MUST_NOT",
    "statusThreeDs": null,
    "threeDSServerTransId": null,
    "redirect3dsUrl": null,
    "recipientAccount": null,
    "senderCustomerId": null,
    "senderFirstName": null,
    "senderLastName": null,
    "senderMiddleName": null,
    "senderEmail": null,
    "senderCountry": null,
    "senderRegion": null,
    "senderCity": null,
    "senderStreet": null,
    "senderAdditionalAddress": null,
    "senderItn": null,
    "senderPassport": null,
    "senderIp": null,
    "senderPhone": null,
    "senderBirthday": null,
    "senderGender": null,
    "senderZipCode": null,
    "senderBankCode": null,
    "senderPaymentSystem": null,
    "recipientCustomerId": null,
    "recipientFirstName": null,
    "recipientLastName": null,
    "recipientMiddleName": null,
    "recipientEmail": null,
    "recipientCountry": null,
    "recipientRegion": null,
    "recipientCity": null,
    "recipientStreet": null,
    "recipientAdditionalAddress": null,
    "recipientItn": null,
    "recipientPassport": null,
    "recipientIp": null,
    "recipientPhone": null,
    "recipientBirthday": null,
    "recipientGender": null,
    "recipientZipCode": null
}

Example of response body from 3DS

{
    "type": "CARD_2_ACCOUNT",
    "rrn": null,
    "purpose": "purpose",
    "comment": "comment",
    "coinAmount": null,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "operationId": "1712843252781OgXAcDp-0Gn",
    "ecomOperationId": "ec2ce45b-9a97-4507-980a-f8249e9ef84f",
    "merchantName": null,
    "approvalCode": null,
    "status": "REQUIRED_3DS",
    "transactionType": 62,
    "merchantRequestId": "a8fec362-b5ed-42c7-b2fd-c89e9d0ec508",
    "transactionCurrency": "980",
    "merchantCommission": null,
    "createDateTime": "2024.09.19 15:29:25.675",
    "modificationDateTime": "2024.09.19 15:29:25.675",
    "transactionResponseInfo": {
        "actionCode": null,
        "responseCode": null,
        "description": null
    },
    "bankCode": null,
    "paymentSystem": null,
    "productType": "C2A",
    "notificationUrl": "https://webhook.site/cbf8c83a-ee1e-47c6-899c-eca5731ff084/mock",
    "paymentServiceType": "GOOGLE_PAY",
    "notificationEncryption": false,
    "senderCardNumberMask": null,
    "desiredThreeDSMode": "MUST",
    "threeDSMode": "MUST",
    "statusThreeDs": null,
    "threeDSServerTransId": "b6c35fdb-28c1-454d-a2f3-51098c26bda4",
    "redirect3dsUrl": null,
    "recipientAccount": null,
    "senderCustomerId": null,
    "senderFirstName": null,
    "senderLastName": null,
    "senderMiddleName": null,
    "senderEmail": null,
    "senderCountry": null,
    "senderRegion": null,
    "senderCity": null,
    "senderStreet": null,
    "senderAdditionalAddress": null,
    "senderItn": null,
    "senderPassport": null,
    "senderIp": null,
    "senderPhone": null,
    "senderBirthday": null,
    "senderGender": null,
    "senderZipCode": null,
    "senderBankCode": null,
    "senderPaymentSystem": null,
    "recipientCustomerId": null,
    "recipientFirstName": null,
    "recipientLastName": null,
    "recipientMiddleName": null,
    "recipientEmail": null,
    "recipientCountry": null,
    "recipientRegion": null,
    "recipientCity": null,
    "recipientStreet": null,
    "recipientAdditionalAddress": null,
    "recipientItn": null,
    "recipientPassport": null,
    "recipientIp": null,
    "recipientPhone": null,
    "recipientBirthday": null,
    "recipientGender": null,
    "recipientZipCode": null
}
PreviousC2ANextC2A request Step 2 (3DS)

Last updated 2 months ago

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