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
  1. Payment methods H2H
  2. TOKEN
  3. C2A

Token payment request Step 1

{{url}}/ecom/execute_request/payments/v1/token_card_2_terminal

Input Parameters:

Parameter
Description
Data Format
Required
Example

merchantRequestId

Unique identifier generated by the merchant's system, used to track the transaction status in case of an unknown error or disconnect.

string(36)

Yes

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

merchantId

Merchant ID generated in Ecom.

string(36)

Yes

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

token

card token

string

Yes

K24YmzXWbw6aCWQn3sdpk7E9

cvv

cvv card is encrypted in JWE

string

Yes

345 (decoded view)

txnType

The parameter is specified - cvv input and its verification does not occur

The parameter is NOT specified - cvv is entered and its verification is in progress

string

No

Possible values:

NONCVV/noncvv

typeToken

defines the type of token when it is created

string

No

possible values:

  • TOKEN_PER_CUSTOMER - a token is created for a specific customer (customer)

desiredThreeDSMode

Indicates whether the merchant wishes to use 3DS for the transaction.

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.""Default: SHOULD.

resultRedirectUrl

URL for client redirection after 3DS authentication.

string (1000)

No

https://support.google.com/

notificationUrl

URL to which the CallBack will be sent.

string (1000)

No

https://merchant.notification_url

notificationEncryption

Indicator for encrypting CallBack data.

string

No

true/false

merchantCommission

Commission amount.

int

No

0

date

Transaction date and time.

string

Yes

{{currentdateT}}.00+00:00

comment

Additional transaction description entered by the merchant's client.

string (1000)

No

///5555.25412

purpose

Payment purpose entered by the merchant.

string (255)

No

For goods

merchantComment

Additional order-related information/comment from the merchant.

string(255)

No

merchant Comment id 1258728c1

recipientAccount

Recipient's account.

string

No

2,9E+13

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

Yes

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

Yes

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.

string (3) ISO 3166

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 address data (floor, house number, apartment).

string (255)

No

23

senderItn

Sender's tax ID.

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's phone number.

string (20)

No

3,8063E+11

senderBirthday

Sender's date of birth.

string (50)

No

31.12.2000

senderGender

Sender's gender.

string (50)

No

Male/Female

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

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

123456789

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

3,8063E+11

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

Comment.

string

Test

coinAmount

Payment amount.

int

2000

merchantId

Merchant ID.

string

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

operationId

Transaction ID.

string

1712844596346b9F-WwrWZpq

ecomOperationId

Ecom system transaction ID.

string

8c3303e9-7396-43b8-af4e-31d9facdde9b

merchantName

Merchant's 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 as a numeric value

string

62

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

Issuing bank name.

string

BANK_ALLIANCE

paymentSystem

Issuing MPS name.

string

MasterCard

productType

Terminal product type.

string

C2A

notificationUrl

Callback URL.

string

https://merchant.notification_url/

paymentServiceType

Payment type.

string

CARD/APPLE_PAY/GOOGLE_PAY

notificationEncryption

Callback data encryption indicator.

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

3DS usage preference.

string

MUST/SHOULD/MUST_NOT

threeDSMode

Indicates whether 3DS was used.

string

MUST/MUST_NOT

statusThreeDs

3DS transaction status.

string

Y - successful 3ds N - unsuccessful 3ds

threeDSServerTransId

3DS system transaction ID.

string

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

acsTransId

ACS system transaction ID.

string

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

dsTransId

Directory Server transaction ID.

string

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

eci

Electronic Commerce Indicator (security level code).

string

2

processingMerchantId

Merchant ID in processing center.

string

AE100000

processingTerminalId

Terminal ID in processing center.

string

AE100000

redirect3dsUrl

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

string

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

txnType

Transaction subtype.

enum

NONCVV/noncvv

customerData

Object containing customer details.

object

-

senderCustomerId

Sender's customer ID.

string (255)

1258728c1

senderFirstName

Sender's first name.

​

string(30)

Ivanenko

senderLastName

Sender's last name.

​

string(30)

Ivan

senderMiddleName

Sender's middle name.

​

string(30)

Ivanovich

senderEmail

Sender's email.

string (256)

mail@gmail.com

senderCountry

Sender's country.

string (3) ISO 3166

804

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

recipientCustomerId

Recipient's client id

​string(30)

1258728c1

recipientFirstName

Recipient's first name

​

string(30)

Ivanenko

recipientLastName

Recipient's last name

​

string(30)

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

the name of the recipient's issuing bank

string

BANK_ALLIANCE

recipientPaymentSystem

the name of the recipient's issuer

string

MasterCard

recipientCardNumberMask

masked card number of the recipient

string

5573********0304

externalCardToken

token id

string

K24YmzXWbw6aCWQn3sdpk7E9

An example of a request body

{
    "merchantId":"467c8a10-c705-11ed-afa1-0242ac120002",
    "merchantRequestId": "{{requestUUIDT}}",
    "cvv": "eyJhbGciOiJFQ0RILUVTK0EyNTZLVyIsImVuYyI6IkEyNTZHQ00iLCJlcGsiOnsia3R5IjoiRUMiLCJ4IjoiZlJYSlpPOVYxSlFaTlJjNUZUdENnWWVQSGhRVGs0MEt1N0ZnQ3QxblpGYnRkSHlWVXp0Tkl0Rzh3TVdTZzNBbiIsInkiOiJZekxRZlYwM3dmRVlyTlN4M2dZUjQ3cXlnak9pNGxMNWxLV01qWktzS3ZCYXpWbmUySDBUVTBQUEd2azhvaWlBIiwiY3J2IjoiUC0zODQifX0",
    "token": "K24YmzXWbw6aCWQn3sdpk7E9",
    "coinAmount": "1000",
    "comment": "comment",
    "purpose": "purpose",
    "merchantCommission": "0",
    "desiredThreeDSMode": "MUST"
    "notificationUrl": "",
    "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": "410208187342",
    "purpose": "purpose",
    "comment": "comment",
    "coinAmount": 1010,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "operationId": "1712823122106xnUK8T9Z9d8",
    "ecomOperationId": "a4842af1-ab80-4685-9cef-0d97aedbb99f",
    "merchantName": null,
    "approvalCode": null,
    "status": "SUCCESS",
    "transactionType": 62,
    "merchantRequestId": "0d7a190d-9cfc-4b01-9615-e207ebe8b23b",
    "transactionCurrency": "980",
    "merchantCommission": 67,
    "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",
    "paymentServiceType": "CARD",
    "notificationEncryption": false,
    "senderCardNumberMask": null,
    "desiredThreeDSMode": "MUST_NOT",
    "threeDSMode": "MUST_NOT",
    "statusThreeDs": null,
    "threeDSServerTransId": null,
    "redirect3dsUrl": null,
    "recipientAccount": null,
    "senderCustomerId": null,
    "senderFirstName": "FirstName",
    "senderLastName": "Name",
    "senderMiddleName": null,
    "senderEmail": null,
    "senderCountry": "Ukraine",
    "senderRegion": null,
    "senderCity": "City",
    "senderStreet": "Str.",
    "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,
    "externalCardToken": "tmkEYenZSa8FV03aawVXxbep"
}

Example of response body from 3DS

{
    "type": "CARD_2_ACCOUNT",
    "rrn": null,
    "purpose": "purpose",
    "comment": "comment",
    "coinAmount": 1010,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "operationId": "1712823334404zicRAYWIAm1",
    "ecomOperationId": "412ac336-aac5-43b5-8d35-b57ffa9d53ff",
    "merchantName": null,
    "approvalCode": null,
    "status": "REQUIRED_3DS",
    "transactionType": 62,
    "merchantRequestId": "60cb4f84-add5-48c6-984f-7b20a6b50c75",
    "transactionCurrency": "980",
    "merchantCommission": 67,
    "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",
    "paymentServiceType": "CARD",
    "notificationEncryption": false,
    "senderCardNumberMask": null,
    "desiredThreeDSMode": "MUST",
    "threeDSMode": "MUST",
    "statusThreeDs": null,
    "threeDSServerTransId": "db259063-61ba-4681-a7e9-65fbbebead2d",
    "redirect3dsUrl": "https://api-ecom-release.develop.bankalliance.ua/threeDS/getRedirectHtml/1712823334404zicRAYWIAm1",
    "recipientAccount": null,
    "senderCustomerId": null,
    "senderFirstName": "FirstName",
    "senderLastName": "Name",
    "senderMiddleName": null,
    "senderEmail": null,
    "senderCountry": "Ukraine",
    "senderRegion": null,
    "senderCity": "City",
    "senderStreet": "Str.",
    "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,
    "externalCardToken": "tmkEYenZSa8FV03aawVXxbep"
}
PreviousC2ANext3DS token payment request Step 2

Last updated 2 months ago