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:
  • Response Parameters:
  • An example of a request body
  • Example response body without 3DS
  • Example of response body from 3DS
  1. Payment methods H2H
  2. ApplePay encrypted

Payment Processing Request

{{url}}/ecom/execute_request/payments/v1/apple_pay/token/purchase

Input Parameters:

Parameter
Description
Data Format
Required
Example

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

"paymentToken": {
  "paymentData": {
    "data": "CLtkH05O6bkhXkEdN/0LGtJQGeNT+9PMDpC0oITlXse1wZby4EtRwNhWz5Cp12ZjKGvsVX0aHeNsyULl8ca3fbVdaYA6b6MGQ7oPBVVyecRo0dl3p8Xhm5oHx9NcI+KTgx2oAZAGxylAAVADKFhYY0xo81yPm8KIhnv8rsKmCyL3d/Vhmlznfr7HgkmmXVhF/YoMp1FDdO6SWQkQBbM8Bu30DQBxPKJAHWGhWTBx8ufWKx+P7ErP2dROhQbFKZEtAvpNOS1o4CV5l4lLfNjiRb+QO85aPbbp80ohD6D9xjCP30lpP8JnWsJIBB3p158SId4Fz95152cvpirqZkOinCfHMLPM371Ent9e50UjQj20d4HVkV6XfwZpRUj8/UYFcemqG+w/VNp7WUFePA==",
    "signature": "MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgAYJKoZIhvcNAQcBAACggDCCA+MwggOIoAMCAQICCBZjTIsOMFcXMAoGCCqGSM49BAMCMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0yNDA0MjkxNzQ3MjdaFw0yOTA0MjgxNzQ3MjZaMF8xJTAjBgNVBAMMHGVjYy1zbXAtYnJva2VyLXNpZ25fVUM0LVBST0QxFDASBgNVBAsMC2lPUyBTeXN0ZW1zMRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABMIVd+3r1seyIY9o3XCQoSGNx7C9bywoPYRgldlK9KVBG4NCDtgR80B+gzMfHFTD9+syINa61dTv9JKJiT58DxOjggIRMIICDTAMBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFCPyScRPk+TvJ+bE9ihsP6K7/S5LMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDQGA1UdHwQtMCswKaAnoCWGI2h0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlYWljYTMuY3JsMB0GA1UdDgQWBBSUV9tv1XSBhomJdi9+V4UH55tYJDAOBgNVHQ8BAf8EBAMCB4AwDwYJKoZIhvdjZAYdBAIFADAKBggqhkjOPQQDAgNJADBGAiEAxvAjyyYUuzA4iKFimD4ak/EFb1D6eM25ukyiQcwU4l4CIQC+PNDf0WJH9klEdTgOnUTCKKEIkKOh3HJLi0y4iJgYvDCCAu4wggJ1oAMCAQICCEltL786mNqXMAoGCCqGSM49BAMCMGcxGzAZBgNVBAMMEkFwcGxlIFJvb3QgQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDUwNjIzNDYzMFoXDTI5MDUwNjIzNDYzMFowejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8BcRhBnXZIXVGl4lgQd26ICi7957rk3gjfxLk+EzVtVmWzWuItCXdg0iTnu6CP12F86Iy3a7ZnC+yOgphP9URaOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUI/JJxE+T5O8n5sT2KGw/orv9LkswDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDgQCBQAwCgYIKoZIzj0EAwIDZwAwZAIwOs9yg1EWmbGG+zXDVspiv/QX7dkPdU2ijr7xnIFeQreJ+Jj3m1mfmNVBDY+d6cL+AjAyLdVEIbCjBXdsXfM4O5Bn/Rd8LCFtlk/GcmmCEm9U+Hp9G5nLmwmJIWEGmQ8Jkh0AADGCAYkwggGFAgEBMIGGMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUwIIFmNMiw4wVxcwCwYJYIZIAWUDBAIBoIGTMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTI0MDkyNTE0NTIxMFowKAYJKoZIhvcNAQk0MRswGTALBglghkgBZQMEAgGhCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEIBpIgKQboEHgDkNYiHuoxqtps5oRjZAr/0YLZmSz2pq6MAoGCCqGSM49BAMCBEgwRgIhAIkjGYfkIWMHGQ4y3xMqF3qvRKc2KwWaqBuTaf8iSlmvAiEAje5izLs9ItZTUCob80n+W3/oOQD0MmdrbIU75mztQ6YAAAAAAAA=",
    "header": {
      "publicKeyHash": "1LSYfOslX5QlRIUAidZjuXuz3w3KHgpnF7RZXPOPAbc=",
      "ephemeralPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAECWpX1FFd7LTXechNBSUtq9OVotLI1zCSgdr5fUWYVt4hJpl1qFSIPPOpbtOhhugrF+ZmZVvbmUe9gNscRUHOtw==",
      "transactionId": "2d4921ff56bf979b76c53b3a6f79125883546ace6548889a0468209741cc0f33"
    },
    "version": "EC_v1"
  },
  "paymentMethod": {
    "displayName": "MasterCard 5538",
    "network": "MasterCard",
    "type": "debit"
  },
  "transactionIdentifier": "2d4921ff56bf979b76c53b3a6f79125883546ace6548889a0468209741cc0f33"
},

  "desiredThreeDSMode": "MUST_NOT",
  "notificationUrl": "https://www.google.com.ua/?hl=ru",
  "resultRedirectUrl": "https://www.google.com.ua/?hl=ru",
  "purpose": "purpose",
  "comment": "comment",
  "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "merchantRequestId": "d7e27615-4357-4647-a9b8-3488d48be594",
  "date": "2024-09-25 18:54:37.00+03:00",
  "customerData": {
      "senderCustomerId": "1231234124142",
    "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"
  }
}
}

Example response body without 3DS

{
    "type": "PURCHASE",
    "rrn": null,
    "purpose": "назначение",
    "comment": "комент",
    "coinAmount": null,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "operationId": null,
    "ecomOperationId": "459dc6d9-cbcb-4f80-9e96-7c09562f51d9",
    "merchantName": null,
    "approvalCode": null,
    "status": "PENDING",
    "transactionType": 35,
    "merchantRequestId": "afb51fa6-a2ec-4f02-b2d0-3a6efee611f0",
    "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": "PURCHASE",
    "notificationUrl": "https://api-ecom-prod.bankalliance.ua/mock",
    "paymentServiceType": "APPLE_PAY",
    "notificationEncryption": false,
    "cardNumberMask": null,
    "desiredThreeDSMode": "MUST_NOT",
    "threeDSMode": null,
    "statusThreeDs": null,
    "threeDSServerTransId": null,
    "redirect3dsUrl": null,
    "txnType": "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,
    "senderCardNumberMask": null
}

Example of response body from 3DS

{
    "type": "PURCHASE",
    "rrn": null,
    "purpose": "purpose",
    "comment": "comment",
    "coinAmount": null,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "operationId": "1712824711120IbbgGHLPNCm",
    "ecomOperationId": "895f15f5-26f7-43cd-8cc1-8f970148425b",
    "merchantName": null,
    "approvalCode": null,
    "status": "REQUIRED_3DS",
    "transactionType": 35,
    "merchantRequestId": "4bf82d10-472d-4ac5-b505-4b7d22ba2686",
    "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": "PURCHASE",
    "notificationUrl": "https://api-ecom-prod.bankalliance.ua/mock",
    "paymentServiceType": "APPLE_PAY",
    "notificationEncryption": false,
    "cardNumberMask": null,
    "desiredThreeDSMode": "MUST",
    "threeDSMode": "MUST",
    "statusThreeDs": null,
    "threeDSServerTransId": "0036703b-839f-4166-a1d8-5fe2f6fb2ea8",
    "redirect3dsUrl": null,
    "txnType": "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,
    "senderCardNumberMask": null
}

PreviousSession Establishment Request in aPayNextGooglePay™ decrypted

Last updated 2 months ago