/PaymentAppleE - Ukrcard en

• PaymentAppleE – for transmitting Apple Pay payment parameters with encrypted payment data

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

string | null

optional

IP address of the customer.

<= 19 characters

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

paymentToken

string

optional

base64 encoded paymentData property of
PKPaymentToken.

applePayPaymentObject[]

object

required

Object
https://developer.apple.com/documentation/apple_pay_on_the_web/ap
plepaypayment
either this or paymentToken should be provided.

Example

{
  "merchant": "paynet",
  "description": "Payload AppleE",
  "amount": 6030,
  "currencyCode": 498,
  "returnUrl": "https://mpit2.ukrcard.com.ua/payment/merchants/ukrposhta-pilot2/finish.html",
  "applePayPaymentObject": {
    "paymentData": {
      "data": "lpPPMjQQBrTw7JFlEpd1g8+HwM15qlIHntddv5JZg5Tt+c0TIUC/8X8dxRNYWRhxGEsctivH5GXfzJ73GvXgsYN9DDhTD2frIje7xDkuEaC+aEptlMQPHJHLVYNhpsDAfizXkgjlBunGhD45fDy/F1TXwjM2P86GkhqHRdNe3XozZ23H9UXEH4kf9Sj9ZC2nhyAt+bckkPcHpnTO38jtkM90U7jTdP7iY3X6zbA/oAW3X/NizZwKj2BFUMsI7tmJWG3WTDDOIIv7y2WlCw202yx1pTG7bZGJh5NHigRwnzOGArjhB+yH2eXlL0VV4Hh+2tH6BDrwU75KgquXpVhDZ0AvcyzCx50hn/sfUgRW5uGbm8dMCGXCosvqL+WqvrQklklRkTa0WuuCtcmSIQ==",
      "signature": "MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgAYJKoZIhvcNAQcBAACggDCCA+MwggOIoAMCAQICCEwwQUlRnVQ2MAoGCCqGSM49BAMCMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xOTA1MTgwMTMyNTdaFw0yNDA1MTYwMTMyNTdaMF8xJTAjBgNVBAMMHGVjYy1zbXAtYnJva2VyLXNpZ25fVUM0LVBST0QxFDASBgNVBAsMC2lPUyBTeXN0ZW1zMRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABMIVd+3r1seyIY9o3XCQoSGNx7C9bywoPYRgldlK9KVBG4NCDtgR80B+gzMfHFTD9+syINa61dTv9JKJiT58DxOjggIRMIICDTAMBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFCPyScRPk+TvJ+bE9ihsP6K7/S5LMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDQGA1UdHwQtMCswKaAnoCWGI2h0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlYWljYTMuY3JsMB0GA1UdDgQWBBSUV9tv1XSBhomJdi9+V4UH55tYJDAOBgNVHQ8BAf8EBAMCB4AwDwYJKoZIhvdjZAYdBAIFADAKBggqhkjOPQQDAgNJADBGAiEAvglXH+ceHnNbVeWvrLTHL+tEXzAYUiLHJRACth69b1UCIQDRizUKXdbdbrF0YDWxHrLOh8+j5q9svYOAiQ3ILN2qYzCCAu4wggJ1oAMCAQICCEltL786mNqXMAoGCCqGSM49BAMCMGcxGzAZBgNVBAMMEkFwcGxlIFJvb3QgQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDUwNjIzNDYzMFoXDTI5MDUwNjIzNDYzMFowejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8BcRhBnXZIXVGl4lgQd26ICi7957rk3gjfxLk+EzVtVmWzWuItCXdg0iTnu6CP12F86Iy3a7ZnC+yOgphP9URaOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUI/JJxE+T5O8n5sT2KGw/orv9LkswDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDgQCBQAwCgYIKoZIzj0EAwIDZwAwZAIwOs9yg1EWmbGG+zXDVspiv/QX7dkPdU2ijr7xnIFeQreJ+Jj3m1mfmNVBDY+d6cL+AjAyLdVEIbCjBXdsXfM4O5Bn/Rd8LCFtlk/GcmmCEm9U+Hp9G5nLmwmJIWEGmQ8Jkh0AADGCAYkwggGFAgEBMIGGMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUwIITDBBSVGdVDYwCwYJYIZIAWUDBAIBoIGTMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTI0MDQzMDA3MTMxM1owKAYJKoZIhvcNAQk0MRswGTALBglghkgBZQMEAgGhCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEICS97Sh46AitIktqTDsgpmo2y5lSeWYyLXi6AfeDCWKKMAoGCCqGSM49BAMCBEgwRgIhAPd5MXN6o+GrcZBgUGoBwDXri7+0EC3Lpu4Swhtjy7YtAiEA3KK/hWZ6KCrPwINZ7lUHXvkA/KYAS7iJJyd6sFmaM5wAAAAAAAA=",
      "header": {
        "publicKeyHash": "DTDGZsGuU1/8Z/t1drgQbGbgnysxjeLit7WgLidh0Lg=",
        "ephemeralPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEHVCv5Fp2+fgv53rp5dZQIJf7vFdnP0VCshKUguiHq4ckwoYQUVo7MceTQFdmlFTUC3KRMUiivPCemSqCvRb/FQ==",
        "transactionId": "a0163c46486f6eda57ace0c03a626104b7252cff7ef9df22c88b77b1264e9dd4"
      },
      "version": "EC_v1"
    },
    "paymentMethod": {
      "displayName": "MasterCard 8095",
      "network": "MasterCard",
      "type": "credit"
    },
    "transactionIdentifier": "A0163C46486F6EDA57ACE0C03A626104B7252CFF7EF9DF22C88B77B1264E9DD4"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/537337-0-default/PaymentAppleE' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchant": "paynet",
    "description": "Payload AppleE",
    "amount": 6030,
    "currencyCode": 498,
    "returnUrl": "https://mpit2.ukrcard.com.ua/payment/merchants/ukrposhta-pilot2/finish.html",
    "applePayPaymentObject": {
        "paymentData": {
            "data": "lpPPMjQQBrTw7JFlEpd1g8+HwM15qlIHntddv5JZg5Tt+c0TIUC/8X8dxRNYWRhxGEsctivH5GXfzJ73GvXgsYN9DDhTD2frIje7xDkuEaC+aEptlMQPHJHLVYNhpsDAfizXkgjlBunGhD45fDy/F1TXwjM2P86GkhqHRdNe3XozZ23H9UXEH4kf9Sj9ZC2nhyAt+bckkPcHpnTO38jtkM90U7jTdP7iY3X6zbA/oAW3X/NizZwKj2BFUMsI7tmJWG3WTDDOIIv7y2WlCw202yx1pTG7bZGJh5NHigRwnzOGArjhB+yH2eXlL0VV4Hh+2tH6BDrwU75KgquXpVhDZ0AvcyzCx50hn/sfUgRW5uGbm8dMCGXCosvqL+WqvrQklklRkTa0WuuCtcmSIQ==",
            "signature": "MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgAYJKoZIhvcNAQcBAACggDCCA+MwggOIoAMCAQICCEwwQUlRnVQ2MAoGCCqGSM49BAMCMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xOTA1MTgwMTMyNTdaFw0yNDA1MTYwMTMyNTdaMF8xJTAjBgNVBAMMHGVjYy1zbXAtYnJva2VyLXNpZ25fVUM0LVBST0QxFDASBgNVBAsMC2lPUyBTeXN0ZW1zMRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABMIVd+3r1seyIY9o3XCQoSGNx7C9bywoPYRgldlK9KVBG4NCDtgR80B+gzMfHFTD9+syINa61dTv9JKJiT58DxOjggIRMIICDTAMBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFCPyScRPk+TvJ+bE9ihsP6K7/S5LMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDQGA1UdHwQtMCswKaAnoCWGI2h0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlYWljYTMuY3JsMB0GA1UdDgQWBBSUV9tv1XSBhomJdi9+V4UH55tYJDAOBgNVHQ8BAf8EBAMCB4AwDwYJKoZIhvdjZAYdBAIFADAKBggqhkjOPQQDAgNJADBGAiEAvglXH+ceHnNbVeWvrLTHL+tEXzAYUiLHJRACth69b1UCIQDRizUKXdbdbrF0YDWxHrLOh8+j5q9svYOAiQ3ILN2qYzCCAu4wggJ1oAMCAQICCEltL786mNqXMAoGCCqGSM49BAMCMGcxGzAZBgNVBAMMEkFwcGxlIFJvb3QgQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDUwNjIzNDYzMFoXDTI5MDUwNjIzNDYzMFowejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8BcRhBnXZIXVGl4lgQd26ICi7957rk3gjfxLk+EzVtVmWzWuItCXdg0iTnu6CP12F86Iy3a7ZnC+yOgphP9URaOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUI/JJxE+T5O8n5sT2KGw/orv9LkswDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDgQCBQAwCgYIKoZIzj0EAwIDZwAwZAIwOs9yg1EWmbGG+zXDVspiv/QX7dkPdU2ijr7xnIFeQreJ+Jj3m1mfmNVBDY+d6cL+AjAyLdVEIbCjBXdsXfM4O5Bn/Rd8LCFtlk/GcmmCEm9U+Hp9G5nLmwmJIWEGmQ8Jkh0AADGCAYkwggGFAgEBMIGGMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUwIITDBBSVGdVDYwCwYJYIZIAWUDBAIBoIGTMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTI0MDQzMDA3MTMxM1owKAYJKoZIhvcNAQk0MRswGTALBglghkgBZQMEAgGhCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEICS97Sh46AitIktqTDsgpmo2y5lSeWYyLXi6AfeDCWKKMAoGCCqGSM49BAMCBEgwRgIhAPd5MXN6o+GrcZBgUGoBwDXri7+0EC3Lpu4Swhtjy7YtAiEA3KK/hWZ6KCrPwINZ7lUHXvkA/KYAS7iJJyd6sFmaM5wAAAAAAAA=",
            "header": {
                "publicKeyHash": "DTDGZsGuU1/8Z/t1drgQbGbgnysxjeLit7WgLidh0Lg=",
                "ephemeralPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEHVCv5Fp2+fgv53rp5dZQIJf7vFdnP0VCshKUguiHq4ckwoYQUVo7MceTQFdmlFTUC3KRMUiivPCemSqCvRb/FQ==",
                "transactionId": "a0163c46486f6eda57ace0c03a626104b7252cff7ef9df22c88b77b1264e9dd4"
            },
            "version": "EC_v1"
        },
        "paymentMethod": {
            "displayName": "MasterCard 8095",
            "network": "MasterCard",
            "type": "credit"
        },
        "transactionIdentifier": "A0163C46486F6EDA57ACE0C03A626104B7252CFF7EF9DF22C88B77B1264E9DD4"
    }
}'

Responses

🟢200Success

application/json

Body

redirect

string

optional

URL to which the customer is redirected after executing the payment, depending on the payment result.

<= 512 characters

info

string

required

Result of the payment attempt. Possible values:
● Your order is proceeded, redirecting...
● Operation declined. Please check the data and available balance of the card. Redirecting...
● Sorry, payment cannot be completed. Redirecting...
● Payment declined. Please, contact the merchant. Redirecting...
● Payment declined. Please, contact the merchant. Redirecting...
● Payment declined. Please, contact your bank. Redirecting...
● Cannot connect to your bank. Please, contact your bank. Redirecting...
● Processing timeout. Please, try again later. Redirecting...

<= 512 characters

errorCode

string

optional

Response code:
● 0 in the case of a successful transaction
● Other code if an error occurred when processing the request.

<= 3 characters

lookup

boolean

optional

Parameter that signifies whether LookUp checks (a simplified alternative of 3-D Secure checks) are used. The possible values:
● true — LookUp checks are enabled
● false — LookUp checks are disabled
This parameter is displayed if the Lookup feature is configured in EPG.

orderStatus[]

object

required

Status of the order after processing the request as it is passed in the getOrderStatusExtended method.

errorCode

string

required

Response code:
● 0 in the case of a successful transaction
● Other code if an error occurred when processing the request.

>= 1 characters<= 3 characters

errorMessage

string | null

optional

Description of the error in the language that was sent in the language parameter of the request.

<= 512 characters

orderNumber

string

required

Number (identifier) of the order in the merchant’s online store system. It is unique for every store in the system and is generated on the order registration.

<= 32 characters

orderStatus

number

optional

Order status in SmartVista E-commerce Payment Gateway. The value is selected from the variants listed below. It is absent if no matching order was found.
The possible values of the field are listed in the orderStatus values.

>= 1<= 2

actionCode

number

required

Processing system authorization code.

<= 3

actionCodeDescription

string

required

Action code description in the language specified in the Language parameter.

<= 512 characters

amount

number

required

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

currency

number

required

Payment currency code in the ISO 4217 format.

<= 3

date

string

required

Date of order registration.

merchantOrderParams[]

object

optional

Tag containing attributes that contain additional merchant parameters.
See the merchantOrderParams block parameters table below.

attributes[]

object

required

Attributes of the order in the payment system (order number).
See the attributes block parameters table below.

cardAuthInfo[]

object

optional

Tag containing the payment attributes.
See the cardAuthInfo block parameters table below.

success

boolean

required

Result of the request.

data[]

object

optional

Block with the order details. The data block parameters are described below.

orderId

string

required

Number (identifier) of the order in the merchant’s online store system. It is unique for every store in the system and is generated on the order registration.

<= 36 characters

Example

{
  "redirect": "https://msk-aix-wbl01svng.bt.bpc.in/?orderId=d7d3d572-9f17-4c50-a07c-f53bb07e43f3",
  "info": "Ваш платёж обработан, происходит переадресация...",
  "lookup": false,
  "orderStatus": {
    "errorCode": "0",
    "errorMessage": "Успешно",
    "orderNumber": "4505",
    "orderStatus": 2,
    "actionCode": "0",
    "actionCodeDescription": "Без ошибок",
    "amount": 1000,
    "currency": 980,
    "date": "1621438342828",
    "merchantOrderParams": null,
    "attributes": [
      {
        "name": "mdOrder",
        "value": "d7d3d572-9f17-4c50-a07c-f53bb07e43f3"
      }
    ],
    "cardAuthInfo": {
      "pan": "516854**0704",
      "expiration": 202212,
      "cardholderName": null,
      "authorizationResponseId": "005595",
      "secureAuthInfo": {
        "eci": 0,
        "cavv": null,
        "xid": null,
        "threeDSInfo": null
      }
    }
  },
  "preAuth": false,
  "success": true,
  "data": {
    "orderId": "d7d3d572-9f17-4c50-a07c-f53bb07e43f3"
  },
  "errorCode": "0"
}