/PaymentAppleD

Developing

POST

/PaymentAppleD

• PaymentAppleD – Request for payment via Apple Pay with decrypted 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

paymentData[]

object

optional

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

applicationPrimaryAccountNumber

string

optional

Device-specific account number of the card that funds this transaction.

applicationExpirationDate

string

optional

Card expiration date in the format YYMMDD.

<= 8 characters

Match pattern:

YYMMDD

currencyCode

string

optional

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

<= 3 characters

transactionAmount

number

optional

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

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.

additionalParameters []

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

fmparam

object

optional

Block for transmitting a list of additional parameters used to implement the regulator's requirements for transmitting information about the payer in a payment transaction, and used for financial monitoring. The obligation to transmit parameters in the specified tag for each method is specified in the requirements (application) of the acquiring bank for registration of terminals.

ReceiverCNAME

string

optional

Recipient name (legal entity)
(Only characters in encoding (UTF-8) are used, without using Unicode escapes!)

ReceiverEDRPOU

string

optional

Recipient's EDRPOU (legal entity) 8 digits

>= 8 characters<= 8 characters

Match pattern:

^[0-9]

ReceiverIBAN

string

optional

IBAN number (legal entity) of the recipient in the format for Ukraine.
Must start with UA, followed by 2 check digits, 6 characters of the MFO of the corresponding bank, and 19 characters of the bank account number. Total length — 29 characters.
Only IBANs issued by Ukrainian banks are supported.

>= 29 characters<= 29 characters

Match pattern:

^UA\d{2}\d{6}\d{19}$

SenderCNAME

string

optional

Name of the payer (legal entity)
(Only characters in encoding (UTF-8) are used, without using Unicode escapes!)

SenderEDRPOU

string

optional

Payer's Unified State Register of Accounts (legal entity) 8 digits

>= 8 characters<= 8 characters

SenderIBAN

string

optional

IBAN number of the payer (legal entity) in the format for Ukraine.

Must start with UA, followed by 2 check digits, 6 characters of the MFO of the corresponding bank, and 19 characters of the bank account number. Total length — 29 characters.
Only IBANs issued by Ukrainian banks are supported.

>= 29 characters<= 29 characters

Match pattern:

^UA\d{2}\d{6}\d{19}$

SenderPIB

string

optional

Full name of the payer (individual)
(Only characters in encoding (UTF-8) are used, without using Unicode escapes!)

SenderITN

string

optional

Taxpayer's INN (individual) 10 digits
(or passport number and series, if the person does not have a INN)

ReceiverPIB

string

optional

Full name of the recipient (individual)

ReceiverITN

string

optional

TIN of the recipient (individual) 10 digits
(or passport number and series, if the person does not have a TIN)

TranID

string

optional

Transaction identifier in external systems, can be used as additional information for reconciliations if required by the acquiring bank

Example

{
    "description": "POST PaymentAppleD MC",
    "additionalParameters": {},
    "language": "uk",
    "preAuth": false,
    "ip": "92.244.102.207",
    "email": "luba.karga@gmail.com",
    "phone": "+380991299519",
    "returnUrl": "https://secure.secure3d.net/m3ua/action/5817f4d1-f57e-4ece-ac0d-c9b512f86606/complete_3ds",
    "failUrl": "https://secure.secure3d.net/m3ua/action/5817f4d1-f57e-4ece-ac0d-c9b512f86606/complete_3ds",
    "paymentData": {
        "applicationPrimaryAccountNumber": "5455######0016",
        "applicationExpirationDate": "251231",
        "currencyCode": "980",
        "transactionAmount": 13742,
        "cardholderName": "?????",
        "deviceManufacturerIdentifier": "",
        "paymentDataType": "3DSecure",
        "paymentData": {
            "onlinePaymentCryptogram": "AVn0rK8BiDxN2D/w2j8LMAABAAA=",
            "eciIndicator": "7"
        }
    }
}

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/PaymentAppleD' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "POST PaymentAppleD MC",
    "additionalParameters": {},
    "language": "uk",
    "preAuth": false,
    "ip": "92.244.102.207",
    "email": "luba.karga@gmail.com",
    "phone": "+380991299519",
    "returnUrl": "https://secure.secure3d.net/m3ua/action/5817f4d1-f57e-4ece-ac0d-c9b512f86606/complete_3ds",
    "failUrl": "https://secure.secure3d.net/m3ua/action/5817f4d1-f57e-4ece-ac0d-c9b512f86606/complete_3ds",
    "paymentData": {
        "applicationPrimaryAccountNumber": "5455######0016",
        "applicationExpirationDate": "251231",
        "currencyCode": "980",
        "transactionAmount": 13742,
        "cardholderName": "?????",
        "deviceManufacturerIdentifier": "",
        "paymentDataType": "3DSecure",
        "paymentData": {
            "onlinePaymentCryptogram": "AVn0rK8BiDxN2D/w2j8LMAABAAA=",
            "eciIndicator": "7"
        }
    }
}'

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

Modified at 2025-06-26 12:43:30

/Panbytoken

/PaymentAppleE