/PaymentGoogleE - Ukrcard en

Request

Body Params application/json

merchant

string | null

optional

Merchant login to access EPG

>= 1 characters<= 100 characters

mdOrder

string | null

optional

Order number generated by EPG after the registration of the order.
Order number in epg system, if present – a registered order with this number will be used

<= 36 characters

description

string | null

optional

Free form description of the order.

<= 512 characters

additionalParameters[]

object | null

optional

An additional tag with attributes used to pass the additional parameters of a merchant.
To pass N parameters, the request must contain N additionalParameters tags in which the name attribute contains the name of a parameter and the value attribute contains its value.

name

string

required

Name of an additional parameter.

<= 255 characters

value

string

required

Value of the additional parameter.

<= 1024 characters

language

string | null

optional

Language in the ISO 639-1 format. If it is not specified, the default language specified in the online store settings is used.

>= 2 characters<= 2 characters

preAuth

boolean | null

optional

Flag that defines whether the payment is a twophase payment with preauthorization.
The possible values are:
● true — the payment is considered a two-phase payment and the request is a preauthorization.
● false — the payment is considered a one-phase payment and the request is a purchase.
If this parameter is not specified, by default the payment is considered a purchase.

Default:

false

ip

string | null

optional

IP address of the customer.

<= 19 characters

email

string | null

optional

If notifying customers is enabled, the customer’s email address to send notifications to.

phone

string | null

optional

If notifying customers is enabled, the customer’s phone number to send SMS notifications to.

<= 255 characters

Match pattern:

system setting:phoneMask

returnUrl

string

required

URL to which the customer is redirected after a successful payment.
Required for order registration. Used for redirect after the payment is completed.

<= 255 characters

failUrl

string | null

optional

Web address to which the customer is redirected if the payment fails.

<= 255 characters

postalCode

string | null

optional

Cardholder’s postal code for the AVS (Address Verification Service) checks.

<= 9 characters

streetAddress

string | null

optional

Cardholder’s street address for the AVS (Address Verification Service) checks.

<= 40 characters

amount

number

required

Order amount in the minor denomination (for example, cents).

<= 20

currencyCode

number

required

Payment currency code in the ISO 4217 format.

<= 3

paymentToken[]

object

required

Object UTF-8 encoded, serialized JSON object
https://developers.google.com/pay/api/web/guides/resources/paymentdata-cryptography#payment-method-token-structure

browserParams

object

optional

Standart Block
Required for
"authMethod": "PAN_ONLY"
Not filled
"authMethod": "CRYPTOGRAM_3DS"
browserParams
is a JSON-based structure.
Parameter set and structure
browserParams.

Example

{
  "merchant": "googletest",
  "amount": "6050",
  "currencyCode": "980",
  "returnUrl": "https://success.callback.paynet.md",
  "paymentToken": {
    "signature": "MEUCIAxBoMQ6zFDB8xMXge3fAR/LxkWkbiRspMaReLXFvVMaAiEA9iGejfJaQeryQAxJWwhBWjMBHxdZh/a+UAAOOpZzlrc=",
    "intermediateSigningKey": {
      "signedKey": "{\"keyValue\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8avPDkzZgeA+UYEZbqfC8TkBWLU8N9yIWomdWB+eQ59I637S+0EsTnXLcQEvQ9B7MwEh7C9v9fsMSTNdwTIL5g\\u003d\\u003d\",\"keyExpiration\":\"1699698690174\"}",
      "signatures": [
        "MEUCIQD/Ryy5gN+D+d+VYPQSKfb2GD+GM5FXAcN7Q73L/jf06AIgeag2Jk919/eaPillrs0z/r/W2QsTIGi8x+KWtS7oNvw="
      ]
    },
    "protocolVersion": "ECv2",
    "signedMessage": "{\"encryptedMessage\":\"ezyCQPxVm3JGfw5dm5rKLwpeS9Sf2fV6GS2WRMBE3kEOQR8mui2zlNPQgGn1U22qSuh8OW+HmdD8xxjQ9TX2AfpME6aqUDolb/7veAiaCrjg6iET8hLq3GL75ehEFgFrYIfv3F6g3RTnJ74T7SpHKoRsWLeo9AcY55p5nIR2HZnEuVJcJ2UB/RA347BGzFhQZyiFhEmE2EpqMZACYAH6iz5ob9bvugkGgewG8LvyDjXjqhiKfcAeOrBDGpNQLwM/UvUDm6aBkWbQdnjBwlZmMAwQKwUPtpr9L0hvgs2wWGa4S3YfdqzKJGZ2ka3khNDRNDs6rcPqfyC/1UxLxUJN5AvwfNLwUVEp62eBA5euz2zJrma1KwbyU7ZYtaRVOWxMt/d5Yk2nSeWPeliMAKqTvDKEe4yBdbdVDDg7ZXPJafb5hMeApY8baXCheq5Sd8pJKz3e07i8ucv0ByFOWpN9mngLZqJ1eBZjlQ6oMbM\\u003d\",\"ephemeralPublicKey\":\"BH7SBc3h3OJvYYrv79SzBF0JCTardLwcX8vrkTxwT2K7J6/LPh363m+dz570qwQt9WIXJiTUVBoRyo7kKojcScU\\u003d\",\"tag\":\"6szG7KKgQMv6Zxmq1PF7RnkjtflYm/xMVY/PVzdYdzY\\u003d\"}"
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://mock.apidog.com/m1/537337-0-default/PaymentGoogleE' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchant": "googletest",
    "amount": "6050",
    "currencyCode": "980",
    "returnUrl": "https://success.callback.paynet.md",
    "paymentToken": {
        "signature": "MEUCIAxBoMQ6zFDB8xMXge3fAR/LxkWkbiRspMaReLXFvVMaAiEA9iGejfJaQeryQAxJWwhBWjMBHxdZh/a+UAAOOpZzlrc=",
        "intermediateSigningKey": {
            "signedKey": "{\"keyValue\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8avPDkzZgeA+UYEZbqfC8TkBWLU8N9yIWomdWB+eQ59I637S+0EsTnXLcQEvQ9B7MwEh7C9v9fsMSTNdwTIL5g\\u003d\\u003d\",\"keyExpiration\":\"1699698690174\"}",
            "signatures": [
                "MEUCIQD/Ryy5gN+D+d+VYPQSKfb2GD+GM5FXAcN7Q73L/jf06AIgeag2Jk919/eaPillrs0z/r/W2QsTIGi8x+KWtS7oNvw="
            ]
        },
        "protocolVersion": "ECv2",
        "signedMessage": "{\"encryptedMessage\":\"ezyCQPxVm3JGfw5dm5rKLwpeS9Sf2fV6GS2WRMBE3kEOQR8mui2zlNPQgGn1U22qSuh8OW+HmdD8xxjQ9TX2AfpME6aqUDolb/7veAiaCrjg6iET8hLq3GL75ehEFgFrYIfv3F6g3RTnJ74T7SpHKoRsWLeo9AcY55p5nIR2HZnEuVJcJ2UB/RA347BGzFhQZyiFhEmE2EpqMZACYAH6iz5ob9bvugkGgewG8LvyDjXjqhiKfcAeOrBDGpNQLwM/UvUDm6aBkWbQdnjBwlZmMAwQKwUPtpr9L0hvgs2wWGa4S3YfdqzKJGZ2ka3khNDRNDs6rcPqfyC/1UxLxUJN5AvwfNLwUVEp62eBA5euz2zJrma1KwbyU7ZYtaRVOWxMt/d5Yk2nSeWPeliMAKqTvDKEe4yBdbdVDDg7ZXPJafb5hMeApY8baXCheq5Sd8pJKz3e07i8ucv0ByFOWpN9mngLZqJ1eBZjlQ6oMbM\\u003d\",\"ephemeralPublicKey\":\"BH7SBc3h3OJvYYrv79SzBF0JCTardLwcX8vrkTxwT2K7J6/LPh363m+dz570qwQt9WIXJiTUVBoRyo7kKojcScU\\u003d\",\"tag\":\"6szG7KKgQMv6Zxmq1PF7RnkjtflYm/xMVY/PVzdYdzY\\u003d\"}"
    }
}'

Responses

🟢200Success

application/json

Body

merchant

string | null

optional

Merchant login to access EPG

>= 1 characters<= 100 characters

mdOrder

string | null

optional

Order number generated by EPG after the registration of the order.
Order number in epg system, if present – a registered order with this number will be used

<= 36 characters

description

string | null

optional

Free form description of the order.

<= 512 characters

additionalParameters[]

object | null

optional

An additional tag with attributes used to pass the additional parameters of a merchant.
To pass N parameters, the request must contain N additionalParameters tags in which the name attribute contains the name of a parameter and the value attribute contains its value.

name

string

required

Name of an additional parameter.

<= 255 characters

value

string

required

Value of the additional parameter.

<= 1024 characters

language

string | null

optional

Language in the ISO 639-1 format. If it is not specified, the default language specified in the online store settings is used.

>= 2 characters<= 2 characters

preAuth

boolean | null

optional

Flag that defines whether the payment is a twophase payment with preauthorization.
The possible values are:
● true — the payment is considered a two-phase payment and the request is a preauthorization.
● false — the payment is considered a one-phase payment and the request is a purchase.
If this parameter is not specified, by default the payment is considered a purchase.

Default:

false

ip

string | null

optional

IP address of the customer.

<= 19 characters

email

string | null

optional

If notifying customers is enabled, the customer’s email address to send notifications to.

phone

string | null

optional

If notifying customers is enabled, the customer’s phone number to send SMS notifications to.

<= 255 characters

Match pattern:

system setting:phoneMask

returnUrl

string

required

URL to which the customer is redirected after a successful payment.
Required for order registration. Used for redirect after the payment is completed.

<= 255 characters

failUrl

string | null

optional

Web address to which the customer is redirected if the payment fails.

<= 255 characters

postalCode

string | null

optional

Cardholder’s postal code for the AVS (Address Verification Service) checks.

<= 9 characters

streetAddress

string | null

optional

Cardholder’s street address for the AVS (Address Verification Service) checks.

<= 40 characters

amount

number

required

Order amount in the minor denomination (for example, cents).

<= 20

currencyCode

number

required

Payment currency code in the ISO 4217 format.

<= 3

paymentData[]

object

required

Decrypted payment data. See the parameter format at the following link to Apple documentation.

gatewayMerchantId

number

optional

EPG merchant id.

paymentMethod

string

optional

Designed for future uses. At the moment, only one possible value - CARD

<= 50 characters

paymentMethodDetails[]

object

optional

ISO 4217 numeric currency code, as a string to preserve leading zeros.

transactionAmount

number

optional

Transaction amount
in the minor denomination (for example, cents)

<= 2

cardholderName

string

optional

Cardholder name.
Name of the cardholder.
This parameter is verified according to the following
criteria.
· Acceptable characters are: Latin letters, 0-9, $, ), (, -, . ,
a space
· Cardholder name must start with a letter
· Minimum length: one Latin letter
· Maximum length: 25 characters
· Null is valid
· Uppercase and lowercase are acceptable.

>= 1 characters<= 25 characters

deviceManufacturerIdentifier

string

optional

Hex-encoded device manufacturer identifier.

paymentDataType

string

optional

Either 3DSecure or, if using Apple Pay in China, EMV.

paymentData[]

object

optional

Detailed payment data.

messageId

string

optional

messageExpiration

string

optional

additionalparams []

object | null

optional

Block for transferring a list of additional parameters for merchants in authorization and clearing in the Visa and Mastercard payment systems, the values of which are transferred in requests to the EPG.

merchantIdType

string

optional

Possible values:
IDTP1 – Passport
IDTP0010 – Taxpayer ID (ІПН)
IDTP0016 – Company registration number (код ЄДРПОУ)

merchantIdNumber

string

optional

Document details

<= 19 characters

browserParams

object

optional

Standart Block
Required for
"authMethod": "PAN_ONLY"
Not filled
"authMethod": "CRYPTOGRAM_3DS"
browserParams
is a JSON-based structure.
Parameter set and structure
browserParams.

Example

{
  "redirect": "https://mpit2.ukrcard.com.ua/payment/merchants/ukrposhta-pilot2/finish.html?orderId=dbbdd1b1-3f2f-4353-9421-071508f2821a",
  "info": "Ваш платёж обработан, происходит переадресация...",
  "errorCode": 0,
  "startThreeDS2": false,
  "orderStatus": {
    "errorCode": "0",
    "errorMessage": "Успешно",
    "orderNumber": "20230321000011",
    "orderStatus": 2,
    "actionCode": 0,
    "actionCodeDescription": "Запрос успешно обработан",
    "amount": 6050,
    "currency": "980",
    "date": 1679393949945,
    "attributes": [
      {
        "name": "mdOrder",
        "value": "dbbdd1b1-3f2f-4353-9421-071508f2821a"
      }
    ],
    "cardAuthInfo": {
      "expiration": "202812",
      "authorizationResponseId": "495762",
      "pan": "520424**7840"
    },
    "authDateTime": 1679393950528,
    "terminalId": "UPE00005",
    "authRefNum": "000045937309",
    "paymentAmountInfo": {
      "paymentState": "DEPOSITED",
      "approvedAmount": 6050,
      "depositedAmount": 6050,
      "refundedAmount": 0
    },
    "bankInfo": {
      "bankCountryName": "<Неизвестно>"
    },
    "fraudLevel": 0
  },
  "success": true,
  "data": {
    "orderId": "dbbdd1b1-3f2f-4353-9421-071508f2821a"
  }
}