Введение

ZoodPay готов предоставить свое платежное решение любой заинтересованной в этом онлайн-торговой площадке. ZoodPay API v0 - это последняя версия, которая демонстрирует наши новейшие функции.

Пожалуйста, свяжитесь с нашим менеджером по работе с клиентами, который поможет вам создать учетную запись ZoodPay. Соберите ключи Sandbox и Production, чтобы начать процесс интеграции.

Правила для продавцов

Нажмите сюда

Среды API

Проверьте среды API, как указано ниже:

Production

https://api.zoodpay.com

Sandbox

https://sandbox-api.zoodpay.com

Модели обслуживания ZoodPay

ZoodPay предоставляет своим продавцам выбор из двух различных моделей обслуживания.

1. Рассрочка ZoodPay (ZPI)

Эта модель обслуживания предполагает утверждение платежа, запуск плана платежей потребителя (в рассрочку) и зачисление стоимости заказа на назначенный продавцом банковский счет.

2. Оплата после доставки (PAD)

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

Процесс интеграции

Прямой платежный поток

1. Продавец вызывает конечную точку получения конфигурации, чтобы получить лимиты заказов Zoodpay, возможно, как часть асинхронного запланированного фонового процесса.
2. Продавец хранит эти минимальные и максимальные значения заказа на стороне сервера.
3. Отдельно при оформлении заказа Продавец использует сохраненные минимальные и максимальные значения заказа Zoodpay, чтобы определить, должен ли Zoodpay быть представлен в качестве доступного метода оплаты.
4. Продавец вызывает конечную точку создания транзакции, чтобы получить URL-адрес платежа ZoodPay и токен сеанса.
5. Продавец использует токен в сочетании с URL-адресом платежа, чтобы направить покупателя через процесс оплаты ZoodPay.
6. Потребитель завершает процесс оплаты Zoodpay и возвращается на сайт Продавца.
   1. Если Потребитель нажимает «Подтвердить», он будет возвращен на веб-сайт Продавца с идентификатором транзакции и статусом «УСПЕШНО».
   2. Если Потребитель отменяет заказ, он будет возвращен на веб-сайт Продавца с идентификатором транзакции и статусом «ОТМЕНЕН».
   3. Если возникнет проблема с потребительской картой, он будут возвращен на веб-сайт продавца с идентификатором транзакции и статусом « НЕ УДАЛОСЬ ».

Архитектура API

REST

API ZoodPay организован на основе REST . API пытается использовать предсказуемые, ориентированные на ресурсы URL-адреса и коды состояния HTTP для индикации ошибок.

HTTPS

API ZoodPay требует, чтобы вся коммуникация была защищена с использованием TLS 1.2 или выше.

Заголовки запроса

Клиенты должны отправлять соответствующие заголовки со всеми запросами.

Заголовки HTTP

Аутентификация

ZoodPay API использует базовую HTTP-аутентификацию, простую схему аутентификации, как описано ниже и определено RFC 7617.

Все конечные точки API требуют эту форму аутентификации, за исключением Healthcheck При неправильной проверке подлинности запрос API выдаст ответ «401 неавторизовано».

Для примера

**Примечание

В традиционных терминах HTTP «ID продавца» - это имя пользователя, а «Секретный ключ» - это пароль.

Как создать базовую аутентификацию?

Заголовок авторизации может быть сформирован путем включения слова Basic, за которым следует один пробел, за которым следует пара учетных данных в кодировке base64.

Healtcheck

Эту конечную точку можно использовать для проверки доступности сервиса ZoodPay.

                            
                                GET https://{environment}.zoodpay.com/healthcheck

                                curl --request GET \
                                --url https://sandbox-api.zoodpay.com/healthcheck \
                                --header 'content-type: application/json'     
                            
                        

Логика генерации подписи / контрольной суммы

Зачем продавцу создавать подпись

Продавец будет использовать sha512 для создания подписи. Поля будут использоваться, как указано:

                            
                                string = merchant_key|merchant_reference_no|amount|currency|market_code|salt

                                signature = sha512(string)
                            
                        

Примечание. Каждое поле будет разделено разделителем "|".

Продавец отправит подпись в полезной нагрузке запроса в ZoodPay. Zoodpay проверит подпись и если подпись недействительна, вернёт ошибку «Указанная контрольная сумма недействительна»

Зачем ZoodPay создавать подпись

ZoodPay будет использовать sha512 для создания подписи. Поля будут использоваться в обратном порядке, как указано:

                            
                                string = market_code|currency|amount|merchant_reference_no|merchant_key|transaction_id|salt

                                signature = sha512(string)
                            
                        

Он отправит в ответ полезную нагрузку Продавцу. Продавец проверит подпись и соответственно обновит статус транзакции, если подпись недействительна. Также они могут использовать наш Get Transaction Status API для проверки статуса транзакции.

Примечание: Salt будет предоставлена во время создания учетной записи.

Zoodpay Logic для создания подписи для обратного вызова возврата

ZoodPay будет использовать sha512 для создания подписи. Поля будут использоваться, как указано:

                            
                                string = merchant_refund_reference|refund_amount|status|merchant_key|refund_id|salt

                                signature = sha512(string)
                            
                        

Примечание: Каждое поле будет разделено разделителем «|».

Zoodpay отправит подпись в полезных данных запроса обратного вызова на возврат средств Продавцу. Продавец проверит подпись и соответствующим образом обновит статус возврата, если подпись недействительна.

Описание моделей данных

1. Метод Get Configuration

а. Запросить модель данных полезной нагрузки

б. Модель данных полезной нагрузки ответа

c. Модель данных конфигурации

2. Создать метод транзакции

а. Запросить модель данных полезной нагрузки

б. Модель данных полезной нагрузки ответа

c. Модель данных клиента

d. Модель данных заказа

е. Модель данных элемента

f. Модель контактных данных

г. Модель данных службы доставки

3. Создание метода возврата.

а. Запрос модели данных полезной нагрузки

б. Модель данных полезной нагрузки ответа

c. Модель данных возврата

4. Установление даты доставки транзакции.

а. Запрос модели данных полезной нагрузки

б. Модель данных ответа полезной нагрузки

API обратного вызова / Webhooks

1. Мгновенное уведомление об оплате (IPN) Запрос полезной нагрузки от ZoodPay на URL обратного вызова продавца

Заголовки HTTP

Пример

                                
                                    {
                                        "amount": "200.00",
                                        "created_at": "2020-09-22T11:23:55.432Z",
                                        "status": "Paid",
                                        "transaction_id": "5fd751239103c"
                                        ”merchant_order_reference”: 12345
                                        ”signature”: “98f6edca713f25495da17a806636101eca46501b080dc6f47fab85d1223a1” 
                                    }
                                
                            

а. Модель данных запроса полезной нагрузки

2. Refund Url Payload от ZoodPay на URL обратного вызова продавца

Заголовки HTTP

Пример

                                
                                    {
                                        "refund": {
                                            "created_at": "2020-12-10T10:48:44+00:00",
                                            "currency": "KZT",
                                            "declined_reason": "",
                                            "merchant_refund_reference": "merch123",
                                            "refund_amount": 10.00,
                                            "refund_id": "5fd1fdc3f77d",
                                            "refunded_at": "2021-01-10T23:00:00+00:00",
                                            "request_id": "100",
                                            "status": "Done",
                                            "transaction_id": "5fd1eab5b1d71",                    
                                        },
                                        "signature": "b5b8a7a4b25e622ea7ab56e62ac8bb069f708"
                                        "refund_id": "5fd1fd0c3f77d"
                                    }
                                
                            

а. Модель данных запроса полезной нагрузки

Симулятор API

Пожалуйста, нажмите здесь, он откроется на новой странице

Ошибки

ZoodPay API указывает на успех или неудачу запроса через коды состояния HTTP.