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

Payment Page - платежная форма, программный модуль с пользовательским интерфейсом, который позволяет проводить оплаты. Payment Page может использоваться на сайтах и позволяет работать с платежными картами даже при отсутствии у мерчанта сертификата PCI DSS.

Работа с Payment Page строится следующим образом:

1. Мерчант формирует запрос Create Payment.
2. На стороне Платежной организации выполняется проверка и формирование ответа, при успешном прохождении и заполнении всех полей.
3. В ответ приходит ссылка на платежную форму.
4. Пользователь выполняет необходимые действия в платежной форме: указывает реквизиты и другую информацию и подтверждает готовность провести оплату.
5. Платежная форма перенаправляет на 3дс и высвечивается статус оплаты.
6. Плательщик нажимает на вернуться в магаз переходит на адрес в ретурн урл.
7. Мерчант запрашивает статус по запросу Get Transaction Status (не рекомендуется запрашивать чаще чем каждые 3 сек), либо дожидается callback с IP 176.123.177.29.

Gate(host to host) - является одной из «точек входа» для работы с платежной платформой и предоставляет наиболее полные возможности для взаимодействия на программном уровне. Через Gate можно проводить разовые оплаты и возвраты, а также получать дополнительную информацию, например, о статусе платежа. Также этот метод походит мерчантам с сертификата PCI DSS.

Работа с Gate строится следующим образом:

1. Мерчант формирует запрос Create Payment.
2. На стороне Платежной организации выполняется проверка и формирование ответа, при успешном прохождении и заполнении всех полей.
3. Мерчант высылает данные по карте при помощи запроса Add Payment Data to Transaction
4. Мерчант перенаправляет плательщика на урл в п1 для прохождения 3дс.
5. В платежной среде платежной организации и банка эквайера, на стороне требуемых систем, выполняется обработка платежа, по итогам которой мерчант запрашивает статус по запросу Get Transaction Status(не рекомендуется запрашивать чаще чем каждые 3 сек).

Create Payment

Cоздание страницы платежа на сайте мерчанта для плательщика.

Пример запроса:

CURL

curl --request POST \ 
  --url https://api.test.ecom.emoney.tools/core/v1/payment \ 
  --header 'Authorization: Basic Base64(Merchan_id:secret)' \ 
  --header 'Content-Type: application/json' \ 
  --data 
  '{
    "amount": 1000, 
    "return_url": "https://example.com/return",
    "callback_url": "https://example.com/callback",
    "description": "Your payment description",
    "payment_method": 2,
    "currency":"USD"
   }'

Данные

Успешный ответ:

{
    "id": 37102,
    "url": "https://pay.test.emoney.tools?id=37081"
}

id - платежа, url - ссылка на платежную страницу

Возможные ошибки

1. Нет одного из обязательных полей:

{
    "error": "JsonSyntaxException"
}

2. Неправильный формат:

{
    "error": "JsonSyntaxException"
}

3. Мерчант заблокирован:

{
    "message": "Unauthorized"
}

Коды ответов:

• 0 SUCCESS
• 1000 NO_TERMINAL_FOUND No terminal configured to process this transaction
• 1001 NO_TERMINAL_COMISSION_FOUND Can not found terminal commission for available terminals

Add Payment Data to Transaction

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

Пример запроса:

CURL

curl --request POST \ - url https://api.test.ecom.emoney.tools/core/v1/public/payment_data \
 --header 'Content-Type: application/json' \
 --data '{
   "id": 37102,
   "payment_details": {
       "pan": "4111111111111111",
       "month": "01",
       "year": "2023",
       "cvv": "123"
       }
     }'

Данные

Успешный ответ:

{
    "code": 1011,
    "msg": "Payment data stored to secure cash"
}

Возможные ошибки

1. Неправильный формат или нет одного из обязательных полей:

{
    "error": "JsonSyntaxException"
}

2. Повторный запрос по одной транзакции:

{
    "code": 1015,
    "msg": "This transaction is not await payment data or not exist"
}

Get Transaction Status

Запрос получает статус конкретной платежной транзакции

Пример запроса:

CURL

curl --request GET \ --url 'https://api.test.ecom.emoney.tools/core/v1/public/payment?id=37102' \

Успешный ответ:

{
    - "id": 37102,
    - "created_at": "2023-10-23T08:41:58.255273Z",
    "order_id": null,
    "merchant": {
        "name": "Филлиал нурлытау",
        "company": {
            "bin": "980504301209",
            "name": "ТОО Прожектор перестройки",
            "description": "Надежный партнер"
        }
    },
    "description": "Your payment description",
    "amount": 1000,
    "customer_commission_amount": 0,
    "merchant_commission_amount": null,
    "completed_at": null,
    "status": 400,
    "transaction_type": 0,
    "payment_method": 2
}

Возможные ошибки

{
    "message": "Transaction not found"
}

Refund

Возврат денежных средств, можно сделать частичным.

Пример запроса:

CURL

curl --request POST \
  --url https://api.test.ecom.emoney.tools/core/v1/refund \
  --header 'Authorization: Basic MTA6MTIzNDU2' \
  --header 'Content-Type: application/json' \
  --data '{
"id": 37102,
"amount": 5
}'

id - айди транзакции оплаты, amount - сумма транзакции для возврата, можно сделать частичный возврат

Успешный ответ:

{
    "id": 420838,
    "status": 50
}

id - айди транзакции возврата, status - статус транзакции

Confirmation Refund

Подтверждение возврата. Срок действия между созданием и подтверждением не более 20 минут.

Пример запроса:

CURL

curl --request PATCH \
  --url https://api.test.ecom.emoney.tools/core/v1/refund \
  --header 'Authorization: Basic MTA6MTIzNDU2' \
  --header 'Content-Type: application/json' \
  --data '{
           "id": 420838,
           "approved": true
     }'

Успешный ответ:

{
    "message": "Refund sent to processing"
}

Возможная ошибка (неверная транзакция или срок действия транзакции возврата истек)

{
    "message": "No transaction found"
}

Коды и статусы транзакции

Коды ошибок

Следующая страница →

Токенизация

На этой странице

• Общая информация
• Create Payment
• Данные
• Возможные ошибки
• Коды ответов:
• Add Payment Data to Transaction
• Данные
• Возможные ошибки
• Get Transaction Status
• Возможные ошибки
• Refund
• Confirmation Refund
• Возможная ошибка (неверная транзакция или срок действия транзакции возврата истек)
• Коды и статусы транзакции
• Коды ошибок