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:
  1. Payment methods HPP

Callback

To send the Callback, a Post request will be made to the notificationUrl that was specified in the order creation request.

Input parameters:

Parameter
Description
Data Format
Example

ecomOrderId

Order ID in the ECOM system

string

bd68c2e5-3642-4527-90c3-e3fd8a73e594

coinAmount

order amount

long

2000

merchantId

Merchant ID in the ECOM system

string

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

statusUrl

url to redirect to the status page

string

hppOrderId

Order ID

string

17285584837476oqrSs7PszY

redirectUrl

link to redirect the customer to the payment page

string

notificationUrl

url to which the CallBack will be sent

string

hppPayType

payment type

string

PURCHASE

merchantRequestId

unique merchant request identifier

string

137d9304-0318-11ed-b939-0241ac120104

orderStatus

order status

string

SUCCESS

createDate

date and time of order creation

string

22024-10-10 14:08:03.67+03:00

paymentMethods

payment methods

string

CARD

expiredOrderDate

date and time of order validity

string

2024-10-10 14:23:03.67+03:00

operations

object with transaction data

object

type

Transaction type.

string

Purchase

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

19.09.2024 15:29

modificationDateTime

Transaction modification date.

string

19.09.2024 15:29

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)

123456789

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)

31.12.2000

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

123456789

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

31.12.2000

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

originalOperationId

Id under which the original transaction was created

string

1712843529623cHAHkmt-G5u

originalCoinAmount

Original payment amount

int

100

originalEcomOperationId

Id in the Ekom system under which the original transaction was created

string

c25ee1cb-a052-439b-b075-bcb632615b11

rrnOriginal

RRN original transaction number in MPS

string

123456789

Output parameters:

{
    "ecomOrderId": "6a413da5-8d9a-423a-8467-f335eb6bd602",
    "coinAmount": 1000,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "statusUrl": "http://pgi-status-ecom-release.develop.bankalliance.ua/?hpp_id=17285584837476oqrSs7PszY",
    "hppOrderId": "17285584837476oqrSs7PszY",
    "redirectUrl": "http://pgi-ecom-release.develop.bankalliance.ua/?hpp_id=17285584837476oqrSs7PszY",
    "notificationUrl": "https://example.com/notify",
    "hppPayType": "PURCHASE",
    "merchantRequestId": "137d9304-0318-11ed-b939-0241ac120104",
    "orderStatus": "SUCCESS",
    "createDate": "2024.10.10 14:08:39.453",
    "paymentMethods": [
        "CARD"
    ],
    "expiredOrderDate": "2024.10.10 14:08:39.453",
    "operations": {
            "type": "PURCHASE",
            "rrn": "428411449064",
            "comment": "Payment for Order №123456",
            "coinAmount": 1000,
            "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
            "operationId": "1728558518169TnfMpJ0tO-P",
            "merchantName": "KB test terminal",
            "approvalCode": "091657",
            "status": "SUCCESS",
            "transactionType": 35,
            "transactionCurrency": "980",
            "merchantCommission": 0,
            "transactionCreateDateTime": "2024.10.10 14:08",
            "transactionModificationDateTime": "2024.10.10 14:08",
            "creationDateTime": "2024.10.10 14:08:39.453",
            "modificationDateTime": "2024.10.10 14:08:47.284",
            "processingDateTime": "2024.10.10 14:08:46.000",
            "transactionResponseInfo": {
                "actionCode": "0",
                "responseCode": "00",
                "description": "approved"
            },
            "paymentServiceType": "CARD",
            "notificationEncryption": false,
            "desiredThreeDSMode": "SHOULD",
            "threeDSMode": "MUST",
            "threeDSServerTransId": "3ea53f87-2da5-4b3a-9178-bc8fd1926208"
    }
}

PreviousREFUNDNextOrder statuses

Last updated 2 months ago

http://pgi-status-ecom-release.develop.bankalliance.ua/?hpp_id=17285584837476oqrSs7PszY
http://pgi-ecom-release.develop.bankalliance.ua/?hpp_id=17285584837476oqrSs7PszY
https://example.com/notify
​https://merchant.notification_url/​
​​https://api-ecom-release.develop.bankalliance.ua/threeDS/getRedirectHtml/1702047427621BHu5X99yDbA​​