Apple Pay

Схема работы

В проведении отдельного платежа с использованием Apple Pay задействуется ваша система, один из интерфейсов и платежная платформа Rocketpay, а также технические средства Apple Pay.

Основные операции

	Интерфейсы			Суммы		Время
	Payment Page	Gate	Dashboard	минимум	максимум	базовое	предельное
Оплата в одну стадию				*	*	*	*
Блокировка средств в рамках оплаты в две стадии				*	*	*	*
Списание и отмена заблокированных средств в рамках оплаты в две стадии						*	*
Регистрация повторяемой оплаты						*	*
Повторные списания в рамках повторяемой оплаты						*	*
Возвраты						*	*

* Дополнительную информацию необходимо уточнять у курирующего менеджера Rocketpay.

Уточнить минимальную и максимальную сумму платежа, доступную в вашем проекте, вы можете в Dashboard. Для этого в Dashboard перейдите в раздел Проекты и выберите вкладку Платежные методы.

Сценарии использования

Для проведения оплат с помощью Apple Pay пользователю достаточно один раз зарегистрировать свою карту на устройстве Apple Pay и после использовать Touch ID, Face ID, пароль или двойное нажатие на боковую кнопку (Apple Watch) для подтверждения оплаты.

Рис.: Оплата через Payment Page

Рис.: Оплата через Gate

Рис.: Возврат через Gate

Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведенных платежах и операциях, представлены далее.

Общая информация

Чтобы выполнить оплату через Payment Page с использованием метода Apple Pay:

1. Отправьте запрос с нужными параметрами и подписью на рабочий URL-адрес платежной платформы Rocketpay.
2. Примите от платежной платформы Rocketpay оповещение (callback) с результатом оплаты.

Полная схема оплаты через Payment Page выглядит следующим образом.

Информация о формате запросов и параметрах вызова Payment Page при работе с Apple Pay, а также о формате оповещений о результатах оплат приведена далее. Общую информацию о работе с Payment Page API можно найти в разделе Описание Payment Page API.

Запрос на открытие платежной формы

В запросе на открытие платежной формы c использованием метода Apple Pay укажите необходимые параметры:

{"register":true}

Вот пример параметров из запроса на открытие платежной формы с использованием виджета EPayWidget:

EPayWidget.run(
    {
        project_id: 123,
        payment_id: 'payment_47',
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        card_holder: 'Doe',    
        customer_email: 'johndoe@example.com',
        payment_currency: 'KZT',
        payment_amount: 100000,
        force_payment_method: 'apple_pay_core',
        recurring: '%7B%22register%22%3Atrue%7D',
        signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R'
    }
)

Оповещение (callback)

В методе Apple Pay результат оплаты платежная платформа возвращает в оповещении. Подробнее о структуре оповещений см. Оповещения (callbacks) в Payment Page.

При успешной регистрации повторяемой оплаты оповещение будет содержать идентификатор зарегистрированной оплаты в параметре id объекта recurring.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 123 была успешно проведена оплата в размере 1000,00 KZT.

{
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "123456"
    },
    "recurring": {
        "id": 12345
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 1187,
            "payment_id": "1234567890",
            "date": "2022-03-25T11:08:45+0000",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Пример тела оповещения с информацией об отклоненной оплате.

{
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "123456"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 1187,
            "payment_id": "1234567890",
            "date": "2022-03-25T11:20:30+0000",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4Vn/jmY+g=="
}

Дополнительные материалы

Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:

• Общий порядок интеграции
• Подписывание и проверка подписи
• Типы платежей, операции и платежи
• Статусы операций и коды ответов

Общая информация

Для оплаты через Gate с использованием метода Apple Pay со стороны веб-сервиса необходимо:

1. Отправить запрос на создание платежной сессии, содержащий требуемые параметры и подпись, на рабочий URL Rocketpay.
2. Принять данные платежной сессии и пользователя.
3. Отправить запрос оплату, содержащий требуемые параметры и подпись, на рабочий URL Rocketpay.
4. Принять от платежной платформы Rocketpay оповещение (callback) о результате оплаты.

Полная схема оплаты в одну стадию с использованием метода Apple Pay выглядит следующим образом.

Информация о формате запросов и параметрах инициализации оплат методом Apple Pay через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Использование API Gate.

Запрос на создание платежной сессии

Далее представлена информация, необходимая для создания платежной сессии с использованием метода Apple Pay.

Пример корректного запроса на создание платежной сессии с Apple Pay представлен далее.

{
  "general": {
    "project_id": 123,
    "signature": "VJ/h5ogVuQ6oMNLLxvvKe3Ef6Jw7wV8bt1cPYZcSQduYBT6o+Se5",
    "validation_url": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
    "domain_name": "appay.eu.ngrok.io",
    "display_name": "test payment"
  }
}

Запрос на проведение оплаты

Далее представлена информация, необходимая для создания и отправки запроса на оплату с использованием метода Apple Pay.

Вот пример данных из запроса на оплату с использованием метода Apple Pay:

{
    "general": {
        "project_id": 123,
        "payment_id": "payment_47",
        "signature": "96c+hWk1zweuGKwDRrl+Se5mDLXHChlDZrjJXZw7ew6ow3RpGYv4U=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "payment": {
        "amount": 100000,
        "currency": "KZT"
    },
    "etoken": {
        "token": "{\"paymentData\":{...},\"paymentMethod\":{...},\"transactionIdentifier\":\"...\"}"
    },
    "recurring": {
        "register": true,
        "type": "R",
        "period": "W",
        "interval": 3,
        "time": "10:00:00",
        "scheduled_payment_id": "567890",
        "start_date": "10-10-2020",
        "expiry_year": 2025,
        "expiry_month": 5,
        "expiry_day": 5
    }
}

Оповещение (callback)

В методе Apple Pay результат оплаты платежная платформа возвращает в оповещении. Подробнее о структуре оповещений см. Оповещения (callbacks) в Gate.

При успешной регистрации повторяемой оплаты оповещение будет содержать идентификатор зарегистрированной оплаты в параметре id объекта recurring.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 123 была успешно проведена оплата в размере 1000,00 KZT.

{
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2019-08-30T13:58:12+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "account": {
        "number": "123456"
    },
    "recurring": {
        "id": 12345
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2019-08-30T13:58:12+0000",
        "created_date": "2019-08-30T13:58:06+0000",
        "request_id": "0a5cb476be3a55010fb050ec1c1cbd35361ac912a3",
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "provider": {
            "id": 1187,
            "payment_id": "1234567890",
            "date": "2019-08-30T13:58:09+0000",
            "auth_code": "591748"
        },
        "code": "0",
        "message": "Success"
    },
    "signature": "5DtWEGy+dMGZZnm3Owjgw9ly67MbzypSxU2KS33RFCKlyphMTlWSNEuh"
}

В следующем примере оплата была отклонена из-за недостатка средств на счете карты.

 {
    "project_id": 123,
    "country": "KZ",
    "product_name": "Visa Rewards",
    "issuer_name": "Bank name",
    "account": {
        "number": "123456"
    },
    "customer": {
        "id": "customer_123"
    },
    "payment": {
        "date": "2019-08-06T12:57:03+0000",
        "id": "payment_47",
        "method": "etoken",
        "status": "decline",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "type": "purchase",
        "description": "test"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "decline",
        "date": "2019-08-06T12:57:03+0000",
        "created_date": "2019-08-06T12:57:00+0000",
        "request_id": "f92c3dfdf76133d5e1a9d26279b3b77b7da32e",
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "provider": {
            "id": 1187,
            "payment_id": "1234567890",
            "auth_code": ""
        },
        "code": "10105",
        "message": "Insufficient funds on card"
    },
    "signature": "9CIXvWMsKOcQsWEHKLsSVAyjRoWsamH6wOqYCdXre8kY9rpDi"
}

Дополнительные материалы

Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:

• Синхронная и асинхронная обработка запросов
• Подписывание и проверка подписи
• Типы платежей, операции и платежи
• Статусы операций и коды ответов

Общая информация

При выполнении оплаты в две стадии с использованием метода Apple Pay при использовании Payment Page возможно выполнение только первой стадии оплаты — блокировки средств на счете пользователя. Для списания заблокированных средств нужно отправить отдельный запрос с использованием Gate API. Подробнее о запросе на списание заблокированных средств см. Запрос на списание заблокированных средств.

При блокировке средств через Payment Page веб-сервис отправляет запрос, содержащий требуемые параметры и подпись, на рабочий URL-адрес Rocketpay и принимает оповещение о результате блокировки средств.

Полная схема выполнения блокировки средств выглядит следующим образом.

Информация о формате запросов и параметрах вызова Payment Page при работе с методом Apple Pay, а также о формате оповещений о результатах блокировки средств приведена далее. Общую информацию о работе с Payment Page API можно найти в разделе Описание Payment Page API.

Запрос на открытие платежной формы

В запросе на открытие платежной формы c использованием метода Apple Pay укажите необходимые параметры:

{"register":true}

Вот пример параметров из запроса на открытие платежной формы с использованием виджета EPayWidget:

EPayWidget.run(
    {
        project_id: 123,
        payment_id: 'payment_47',
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        card_holder: 'Doe', 
        customer_email: 'johndoe@example.com',   
        payment_currency: 'KZT',
        payment_amount: 100000,
        force_payment_method: 'apple_pay_core',
        recurring: '%7B%22register%22%3Atrue%7D',
        signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R'
    }
)

Оповещение (callback)

В методе Apple Pay результат оплаты платежная платформа возвращает в оповещении. Подробнее о структуре оповещений см. Оповещения (callbacks) в Payment Page.

При успешной регистрации повторяемой оплаты оповещение будет содержать идентификатор зарегистрированной оплаты в параметре id объекта recurring.

В следующем примере в оповещении содержится информация о том, что в проекте 123 выполнена блокировка средств в размере 1000,00 KZT.

{
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "auth",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "123456"
    },
    "recurring": {
        "id": 12345
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60",
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4"
}

Вот пример тела оповещения с информацией об отклонении запроса на блокировку средств.

{
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "123456"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 1187,
            "payment_id": "1234567890",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu4"
}

Дополнительные материалы

• Общий порядок интеграции
• Типы платежей, операции и платежи
• Подписывание и проверка подписи
• Статусы операций и коды ответов

Общая информация

При выполнении оплаты в две стадии через Gate с использованием метода Apple Pay веб-сервис должен выполнить следующее:

1. Отправить запрос на создание платежной сессии, содержащий требуемые параметры и подпись, на рабочий URL Rocketpay.
2. Принять данные платежной сессии и пользователя.
3. Отправить запрос для блокировки средств, содержащий требуемые параметры и подпись, на рабочий URL Rocketpay.
4. Принять от платежной платформы Rocketpay оповещение о результате блокировки средств.
5. Отправить запрос для списания средств, содержащий требуемые параметры и подпись, на рабочий URL Rocketpay.
6. Принять от платежной платформы Rocketpay оповещение (callback) о результате оплаты.

Проведение оплаты в две стадии выполняется поэтапно:

1. Этап 1. Блокировка средств пользователя.
2. Этап 2. Списание заблокированных средств или отмена блокировки средств без их списания.

Полная схема оплаты с использованием метода Apple Pay выглядит следующим образом.

Рис.: Этап 1. Блокировка средств

Рис.: Этап 2. Списание средств

Рис.: Этап 2. Отмена блокировки

Информация о форматах запросов и оповещений, используемых при проведении оплаты в две стадии с использованием метода Apple Pay через Gate приведена далее. Общую информацию о работе с Gate API можно найти в разделе Использование API Gate.

Запрос на создание платежной сессии

Далее представлена информация, необходимая для создания платежной сессии с использованием метода Apple Pay.

Пример корректного запроса на создание платежной сессии с Apple Pay представлен далее.

{
  "general": {
    "project_id": 123,
    "signature": "VJ/h5ogVuQ6oMNLLxvvKe3Ef6Jw7wV8bt1cPYZcSQduYBT6o+Se5",
    "validation_url": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
    "domain_name": "appay.eu.ngrok.io",
    "display_name": "test payment"
  }
}

Запрос на блокировку средств

Далее представлена информация, необходимая для создания и отправки запроса на блокировку средств с использованием метода Apple Pay.

Вот пример данных из запроса на блокировку средств с использованием метода Apple Pay:

{
    "general": {
        "project_id": 123,
        "payment_id": "payment_47",
        "signature": "96c+hWk1zweuGKwDRrl+Se5mDLXHChlDZrjJXZw7ew6ow3RpGYv4U=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "payment": {
        "amount": 100000,
        "currency": "KZT"
    },
    "etoken": {
        "token": "{\"paymentData\":{...},\"paymentMethod\":{...},\"transactionIdentifier\":\"...\"}"
    },
    "recurring": {
        "register": true,
        "type": "R",
        "period": "W",
        "interval": 3,
        "time": "10:00:00",
        "scheduled_payment_id": "567890",
        "start_date": "10-10-2020",
        "expiry_year": 2025,
        "expiry_month": 5,
        "expiry_day": 5
    }
}

Запрос на списание заблокированных средств

Далее представлена информация, необходимая для создания запроса на списание заблокированных средств с использованием метода Apple Pay.

Вот пример данных из запроса на списание заблокированных средств с использованием метода Apple Pay:

{
    "general": {
        "project_id": 123,
        "payment_id": "payment_47",
        "signature": "96c+hWk1zweuGKwDRrl+Se5mDLXHChlDZrjJXZw7ew6ow3RpGYv4"
    },
    "payment": {
        "amount": 100000,
        "currency": "KZT"
    }
}

Запрос на отмену блокировки средств

Далее представлена информация, необходимая для создания запроса на отмену блокировки средств с использованием метода Apple Pay.

Пример запроса на отмену блокировки средств с применением метода Apple Pay.

{
    "general": {
        "project_id": 123,
        "payment_id": "payment_47",
        "signature": "96c+hWk1zweuGKwDRrl+Se5mDLXHChlDZrjJXZw7ew6ow3RpGYv4"
    }
}

Оповещение (callback)

В методе Apple Pay результат оплаты в две стадии платежная платформа возвращает в оповещении. Подробнее о структуре оповещений см. Оповещения (callbacks) в Gate.

При успешной регистрации повторяемой оплаты оповещение будет содержать идентификатор зарегистрированной оплаты в параметре id объекта recurring.

В следующем примере в оповещении содержится информация о том, что в рамках проекта 123 произведена блокировка средств в размере 1000,00 KZT.

{
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "123456"
    },
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "awaiting capture",
        "date": "2025-02-23T09:31:16+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "operation": {
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 25656,
            "payment_id": "1234567890",
            "auth_code": "130510"
        },
        "id": 5009268010192904,
        "type": "auth",
        "status": "success",
        "date": "2025-02-23T09:31:16+0000",
        "created_date": "2025-02-23T09:31:13+0000",
        "request_id": "f2c569dcfc8caaad230-d449fed468dc...120188b71513288e5-05009269"
    },
    "signature": "Xwv0+3w+3K4CBlCK2mzNZ7hvSs740DmNYheH...Z4uRUnDNoASiem+Kd7emCOy3A=="
} 

В следующем примере содержится информация об отклонении блокировки средств.

{
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "123456"
    },
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2025-02-24T07:34:35+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "operation": {
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "10201",
        "message": "Refer to card issuer",
        "provider": {
            "id": 25656,
            "payment_id": "1234567890",
            "auth_code": ""
        },
        "id": 88969010166206,
        "type": "auth",
        "status": "decline",
        "date": "2025-02-24T07:34:35+0000",
        "created_date": "2025-02-24T07:34:32+0000",
        "request_id": "aa0c10c70169a00eab6ed...f7ed1e4b24e104bfd3001c98-00088970"
    },
    "signature": "JsoAt+YE03GvTxHqlp43kN/Ao...8YZu9PObd3K2E3Syd+AYgwG1Fr8sOqw=="
}

В следующем примере в оповещении содержится информация о том, что в рамках проекта 123 произведено списание ранее заблокированных средств.

{
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "123456"
    },
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2025-02-23T09:31:21+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "operation": {
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 25656,
            "payment_id": "1234567890",
            "auth_code": "130510"
        },
        "id": 5009268010192914,
        "type": "capture",
        "status": "success",
        "date": "2025-02-23T09:31:21+0000",
        "created_date": "2025-02-23T09:31:19+0000",
        "request_id": "7574f98f58c447319961af...7d2c84fb999aba28b0da7-05009269"
    },
    "signature": "R9VlffmrKlv0o4f6WyOVfmCeUp...Rtq++cU4RSXAuwwP7qRPJr68MX/XwPw=="
}

В следующем примере содержится информация об отклонении списания средств.

{
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "123456"
    },
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "awaiting capture",
        "date": "2025-02-14T11:02:40+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "operation": {
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "10000",
        "message": "General decline",
        "provider": {
            "id": 18592,
            "payment_id": "",
            "auth_code": ""
        },
        "id": 5044775010195824,
        "type": "capture",
        "status": "decline",
        "date": "2025-02-14T11:02:40+0000",
        "created_date": "2025-02-13T16:55:17+0000",
        "request_id": "365e5a5c177e49a69635a1e...cb6867da2414f92a5967-05044776"
    },
    "signature": "aFarg/tVTKX8OfrCupyWwfi4y...YhyY8lZEqa2hPjpVt5zo2f8wMZdQ=="
}

В следующем примере в оповещении содержится информация об отмене блокировки средств.

{
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "123456"
    },
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "canceled",
        "date": "2025-02-22T19:05:16+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "operation": {
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 18592,
            "payment_id": "",
            "auth_code": "",
            "date": "2025-02-22T19:05:16+0000"
        },
        "id": 5051368010197754,
        "type": "cancel",
        "status": "success",
        "date": "2025-02-22T19:05:16+0000",
        "created_date": "2025-02-22T19:05:12+0000",
        "request_id": "e591ce7e99b371e034ba167...81ce0f32182620116e622-05051369"
    },
    "signature": "P98J30+t6uApD+Wa7rCUK25OICC...uimTzYoGxFzMPyoHNFaPa5b6g=="
}

В следующем примере содержится информация об отклонении отмены блокировки средств.

 {
    "card_safe": false,
    "OperationFee": {
        "amount": 0,
        "currency": "KZT"
    },
    "customer_ip": "2.73.213.76",
    "project_id": 84031,
    "payment": {
        "type": "purchase",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "status": "awaiting capture",
        "method": "etoken",
        "id": "payment_47",
        "date": "2025-02-20T11:11:34+0000",
        "description": "TEST_PAYMENT_951914"
    },
    "customer": {
        "id": "customer_123",
        "card_type": "mastercard"
    },
    "account": {
        "number": "123456"
    },
    "issuer_name": "JOINT STOCK COMMERCIAL BANK - TBC BANK",
    "recurring": {
        "valid_thru": "2028-02-29T23:59:59+0000",
        "id": 1696779776,
        "currency": "KZT"
    },
    "operation": {
        "type": "cancel",
        "sum_initial": {
            "currency": "KZT",
            "amount": 100000
        },
        "sum_converted": {
            "currency": "KZT",
            "amount": 100000
        },
        "status": "decline",
        "request_id": "cancel_88358010120206-a9e702a...306b99c45e0dd-00088359",
        "provider": {
            "payment_id": "",
            "id": 18592,
            "auth_code": ""
        },
        "message": "General decline",
        "id": 88358010167846,
        "date": "2025-02-20T11:11:34+0000",
        "created_date": "2025-02-20T11:11:32+0000",
        "code": "20000"
    },
    "signature": "vfDSFTFOYB+h7AuyP6XMWBzTJJa0gXB...ondmQ14w6S2LgJKzWYeSZY9A=="
}

Дополнительные материалы

• Общий порядок интеграции
• Типы платежей, операции и платежи
• Подписывание и проверка подписи
• Статусы операций и коды ответов

Общая информация

Платежный метод Apple Pay предоставляет возможность проводить повторяемые оплаты — повторяемые оплаты со списаниями по запросу. Подробная информация представлена в разделе Схема и статусы повторяемой оплаты со списаниями по запросу.

В этом разделе содержится информация о проведении повторных списаний в рамках уже зарегистрированной повторяемой оплаты. Информация о том, как зарегистрировать повторяемую оплату, приведена в секции Формат запроса в разделах о проведении оплат в одну и две стадии.

При выполнении повторного списания в рамках уже зарегистрированной повторяемой оплаты через Gate с использованием метода Apple Pay ваша система должена выполнить следующее:

1. Отправить запрос с нужными параметрами и подписью на рабочий URL-адрес Rocketpay для проведения повторного списания.
2. Принять от платежной платформы Rocketpay оповещение о результате повторного списания.

Полная схема проведения повторного списания в рамках уже зарегистрированной повторяемой оплаты выглядит следующим образом.

Информация о формате запросов и параметрах инициирования повторного списания методом Apple Pay через Gate, а также о формате оповещений о результатах списания приведена далее. Общую информацию о работе с Gate API можно найти в разделе Использование API Gate.

Запрос на повторяемую оплату

Далее представлена информация, необходимая для создания и отправки запроса на повторяемую оплату с использованием метода Apple Pay.

Вот пример запроса на проведение повторяемой оплаты.

{
    "general": {
        "project_id": 123,
        "payment_id": "payment_47",
        "signature": "DH0v2pZnkK9hwytQ6/ZtDSQh+wwx/OqrWdbltzO5GMSkzd0Iq6lM2"
    },
    "customer": {
        "ip_address": "198.51.100.47"
    },
    "payment": {
        "amount": 100000,
        "currency": "KZT"
    },
    "recurring": {
        "id": 12345
    }
} 

Запрос на отмену повторяемой оплаты

До момента истечения срока выполнения повторяемых оплат их можно отменить. Также для изменения условий выполнения повторяемой оплаты ее необходимо отменить и отправить запрос на создание новой.

Далее представлена информация, необходимая для создания и отправки запроса на отмену повторяемой оплаты с использованием метода Apple Pay.

Корректный запрос на отмену проведения повторямой оплаты с применением метода Apple Pay должен содержать идентификаторы проекта и платежа, подпись, а также идентификатор зарегистрированной повторяемой оплаты.

 {
    "general": {
        "project_id": 123,
        "payment_id": "payment_47",
        "signature": "DH0v2pZnkK9hwytQ6/ZtDSQh+wwx/OqrWdbltzO5GMSkzd0Iq6lM2v8"
    },
    "recurring": {
        "id": 12345
    }
}

Оповещение (callback)

Для оповещений о результатах действий с повторяемыми оплатами с применением метода Apple Pay используется стандартный формат, описание которого представлено в разделе Оповещения (callbacks) в Gate.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 123 для пользователя была успешно зарегистрирована повторяемая оплата.

 {
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "recurring",
        "status": "success",
        "date": "2018-11-20T08:44:46+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": "payment"
    },
    "account": {
        "number": "123456"
    },
    "recurring": {
        "id": 12345,
        "currency": "",
        "valid_thru": "-0001-11-30T00:00:00+0000"
    },
    "operation": {
        "id": 28,
        "type": "recurring",
        "status": "success",
        "date": "2018-11-20T08:44:46+0000",
        "created_date": "2018-11-20T08:44:41+0000",
        "request_id": "07fd7ade7cf010",
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "provider": {
            "id": 1187,
            "payment_id": "1234567890",
            "date": "2020-11-20T08:44:45+0000",
            "auth_code": ""
        },
        "code": "0",
        "message": "Success"
    },
    "signature": "x2tsnvLCRXZMX8Kwyr9a8+I3RipuPWUod5c89cDSQ6cRq=="
}

Дополнительные материалы

Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:

• Общий порядок интеграции
• Подписывание и проверка подписи
• Типы платежей, операции и платежи
• Статусы операций и коды ответов

Общая информация

Чтобы выполнить возврат ранее выполненной оплаты через Gate с использованием метода Apple Pay:

1. Отправьте запрос с нужными параметрами и подписью на рабочий URL-адрес платежной платформы Rocketpay.
2. Примите от платежной платформы Rocketpay оповещение (callback) с результатом возврата.

Полная схема возврата по оплате с использованием метода Apple Pay выглядит следующим образом.

Информация о формате запросов и параметрах инициализации возвратов методом Apple Pay через Gate, а также о формате оповещений о результатах возвратов приведена далее, общая информация о работе с API см. в разделе Использование API Gate.

Запрос на возврат

Далее представлена информация, необходимая для создания и отправки запроса на возврат с использованием метода Apple Pay.

Вот пример данных из запроса на возврат с использованием метода Apple Pay:

{
    "general": {
        "project_id": 123,
        "payment_id": "refund_02",
        "signature": "of8k9xerKSK4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1"
    },
    "customer": {
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "payment": {
        "description": "refund_02"
    }
}

Оповещение (callback)

Для оповещений о результатах возврата с применением метода Apple Pay используется стандартный формат, описание которого представлено в разделе Оповещения (callbacks) в Gate.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 123 для пользователя был успешно проведен возврат в размере 1000,00 KZT.

{
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "refunded",
        "date": "2020-01-20T08:31:36+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "123456"
    },
    "operation": {
        "id": 28,
        "type": "refund",
        "status": "success",
        "date": "2020-01-20T08:31:36+0000",
        "created_date": "2020-01-20T08:31:35+0000",
        "request_id": "e0069513",
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 1187,
            "payment_id": "1234567890",
            "auth_code": ""
        }
    },
    "signature": "beJ1deUiEDd+7zuo6YrfSRxbOn8BYDLI9RR3yliH3B91LcBan4+2VkRrxn2NYOexr7"
}

В следующем примере возврат был отклонен, так как значение суммы в запросе на возврат больше суммы, указанной в начальном запросе.

{
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2020-01-20T08:31:36+0000",
        "method": "etoken",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "123456"
    },
    "operation": {
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "3283",
        "message": "Refund amount more than init amount",
        "provider": {
            "id": 1187,
            "payment_id": "1234567890",
            "auth_code": ""
        },
        "id": 28,
        "type": "refund",
        "status": "decline",
        "date": "2020-01-20T08:31:36+0000",
        "created_date": "2020-01-20T08:31:35+0000",
        "request_id": "e0069142"
    },
    "signature": "beJ1deUiEDd+7zuo6YrfSRxbOn8BYDLI9RR3yliH3B91LcBan4+2VkRrxn2NYO"
}

Дополнительные материалы

Для организации работы с возвратами через Gate также могут быть полезны следующие материалы:

• Общий порядок интеграции
• Подписывание и проверка подписи
• Типы платежей, операции и платежи
• Статусы операций и коды ответов

Общая информация

Для проверки действительности карты через Gate с использованием Apple Pay метода со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL Rocketpay и принять оповещение о результате. Схема проведения проверки действительности карты через сервис Apple Pay аналогична стандартной проверке, описание которой представлено в разделе Проверка платежной карты.

Запрос на проверку действительности карты

Далее представлена информация, необходимая для проверки действительности карты с использованием метода Apple Pay.

Пример запроса на проверку действительности карты с помощью метода Apple Pay.

{
  "general": {
     "project_id": 123,
     "payment_id": "payment_47",
     "signature": "96c+hWk1zweuGKwDRrl+Se5mDLXHChlDZrjJXZw7ew6ow3RpGYv4"
    },
    "customer": {
    "ip_address": "198.51.100.47"
    },
  "payment": {
    "amount": 100000,
    "currency": "KZT"
    },
    "etoken": {
        "token": "{\"paymentData\":{...},\"paymentMethod\":{...},\"transactionIdentifier\":\"...\"}"
    }
}

Оповещение (callback)

Для оповещений о результатах проведения проверки действительности карты используется стандартный формат, описание которого представлено в разделе Проверка платежной карты.

Дополнительные материалы

Для организации работы с операциями через Gate также могут быть полезны следующие материалы:

• Общий порядок интеграции
• Подписывание и проверка подписи
• Типы платежей, операции и платежи
• Статусы операций и коды ответов

Общая информация

Для метода Apple Pay доступно тестирование оплат в одну и две стадии через Payment Page и Gate. Также доступно тестирование проверки действительности карты через Gate. При тестировании оплат через Gate веб-сервис мерчанта должен соответствовать следующим условиям:

• Домен сайта зарегистрирован в сервисах Apple. Для регистрации домена необходимо обратиться в службу технической поддержки Rocketpay support@rocketpay.kz
• Сайт поддерживает функциональность запуска скрипта для начала сессии Apple согласно документации.

Также при тестировании следует учитывать другие особенности работы с методом Apple Pay, указанные в разделе Обзор.

Тестирование может выполняться в рамках тестового проекта, для подключения и отключения этой функциональности необходимо обращаться к специалистам технической поддержки Rocketpay support@rocketpay.kz.

При проведении тестовых платежей следует учитывать, что в запросах должен указываться идентификатор тестового проекта, а интерфейсы эмулятора платежных форм Payment Page и страницы аутентификации 3‑D Secure могут отличаться от рабочих. Вместе с тем для проведения тестовых платежей необходимо использовать действительные платежные карты, предварительно зарегистрированные в сервисе Apple. Это никак не влияет на проведение реальных платежей с использованием этих карт, но позволяет выполнять полноценное тестирование.

Статусы тестовых платежей

При тестировании оплат в одну и две стадии их итоговые статусы определяются исходя из сумм, указанных в запросах:

• decline — при указании суммы 2000, 5000 или 10001;
• success — при указании суммы 1000.

При тестировании проверки действительности карты статус этой проверки определяется исходя из сумм, указанных в запросах:

• success — при указании суммы 0;
• decline — при указании любой другой суммы.

Оплата в одну стадию через Payment Page

Для проведения тестовой оплаты в одну стадию через Payment Page необходимо:

1. Отправить в платежную платформу корректный тестовый запрос на открытие Payment Page.
2. Если в запросе не был указан метод apple_pay_core — выбрать метод Apple Pay на странице эмулятора.
3. Подтвердить оплату.
4. Принять оповещение с информацией о результате оплаты.

Подробная информация о проведении оплат с использованием метода Apple Pay через Payment Page представлена в пункте Оплата в одну стадию через Payment Page.

Оплата в одну стадию через Gate

Для проведения тестовой оплаты через Gate необходимо:

1. Отправить в платежную платформу корректный тестовый запрос на создание платежной сессии.
2. Принять данные платежной сессии и пользователя.
3. Подтвердить оплату.
4. Отправить в платежную платформу корректный тестовый запрос на оплату.
5. Принять оповещение с информацией о результате оплаты.

Подробная информация о проведении оплат с использованием метода Apple Pay через Gate представлена в пункте Оплата в одну стадию через Gate.

Оплата в две стадии с блокировкой средств через Payment Page и подтверждением или отменой через Gate

Для проведения тестовой оплаты в две стадии с блокировкой через Payment Page и подтверждением или отменой через Gate необходимо:

1. Отправить в платежную платформу корректный тестовый запрос на открытие Payment Page.
2. Если в запросе не был указан код предварительного выбора метода card или apple_pay_core — выбрать оплату методом Apple Pay на странице эмулятора.
3. Подтвердить оплату.
4. Принять оповещение с информацией о результате блокировки.
5. Отправить запрос на подтверждение или отмену оплаты.
6. Принять оповещение с информацией о результате оплаты.

Подробная информация о проведении оплат с использованием метода Apple Pay через Payment Page и Gate представлена в пунктах Оплата в одну стадию через Payment Page и Оплата в одну стадию через Gate.

Оплата в две стадии с блокировкой средств и подтверждением или отменой через Gate

Для проведения тестовой оплаты в две стадии с блокировкой и подтверждением или отменой через Gate необходимо:

1. Отправить в платежную платформу корректный тестовый запрос на создание платежной сессии.
2. Принять данные платежной сессии и пользователя.
3. Отправить в платежную платформу корректный тестовый запрос на оплату.
4. Подтвердить оплату.
5. Принять оповещение с информацией о результате блокировки.
6. Отправить запрос на подтверждение или отмену оплаты.
7. Принять оповещение с информацией о результате оплаты.

Подробная информация о проведении оплат с использованием метода Apple Pay через Gate представлена в пункте Оплата в одну стадию через Gate.

Проверка действительности карты через Gate

Для проведения тестовой проверки действительности карты через Gate необходимо отправить в платежную платформу корректный тестовый запрос на проверку действительности и принять оповещение с информацией о результате проверки.

Подробная информация о проведении проверки действительности карты с использованием метода Apple Pay через Gate представлена в пункте Проверка действительности карты.

Как и при работе с другими платежными методами, которые предоставляет Rocketpay, при использовании этого метода доступны разные способы анализа информации о платежах и операциях.

Всю необходимую информацию можно получать и анализировать средствами Dashboard (dashboard.rocketpay.kz), в том числе с помощью аналитических панелей в разделе Аналитика.

Также можно выгружать необходимую информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:

• Dashboard позволяет выгружать данные в формате CSV с помощью инструментов в разделе Отчеты. При этом можно выполнять разовые и периодические выгрузки информации на локальный компьютер.
• Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы к конечной точке /operations/get.

С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки Rocketpay.