maib e-commerce API
ROEN
  • Терминология
  • Этапы и требования к интеграции
    • Этапы интеграции
    • Требования к интеграции
  • maib e-commerce API
  • Типы платежей
  • Генерация Токена доступа
  • Прямой платеж
  • Двухэтапный платеж
    • Авторизация транзакции
    • Завершение транзакции
  • Возврат платежа
  • Информация о платеже
  • Рекуррентные (регулярные) платежи
    • Регистрация карты в системе maib ecomm
    • Выполнение регулярного платежа
  • One-click платежи
    • Регистрация карты в системе maib ecomm
    • Выполнение one-click платежа
  • Удаление карты из maib ecomm
  • Уведомления на Callback Url
  • Статус транзакции и 3D-Secure
  • Ошибки
    • Ошибки API
    • Коды состояния HTTP
  • Плагины и готовые решения
    • Плагины
    • SDK
    • Tilda
    • Gomag
    • Cartum
    • ECOM
Powered by GitBook
On this page
  • Параметры запроса (body)
  • Параметры промежуточного ответа
  • Параметры окончательного ответа (на Callback Url)
  1. Двухэтапный платеж

Авторизация транзакции

PreviousДвухэтапный платежNextЗавершение транзакции

Last updated 1 year ago

После авторизации транзакции возможны 2 действия:

  1. - сумма будет списана со счета Покупателя;

  2. - сумма будет разблокирована, со счета Покупателя ничего не списывается.

API endpoint (POST)

https://api.maibmerchants.md/v1/hold

Параметры запроса (body)

Параметр
Обязательный
Тип
Описание

amount

ДА

number(decimal)

≥1

Сумма в формате X.XX, подлежащая авторизации (блокировке) на счете Покупателя.

Например: 10.25 (currency=MDL) означает 10 лей и 25 бань.

currency

ДА

string(3)

Валюта транзакции (MDL/EUR/USD)

clientIp

ДА

string(15)

IP Покупателя

language

НЕТ

string(2)

Язык страницы maib ecomm checkout

Возможные значения: ro/en/ru

Если этот параметр не передан, страница будет отображаться на английском языке

description

НЕТ

string(124)

Описание платежа

Отображается на страницу maib ecomm checkout

clientName

НЕТ

string(128)

Имя Покупателя

email

НЕТ

string(40)

Email Покупателя

phone

НЕТ

string(40)

Телефон Покупателя

orderId

НЕТ

string(36)

Идентификатор заказа с сайта/приложения

delivery

НЕТ

number(decimal)

Стоимость доставки

items

НЕТ

array

max. 50 items

Товары или услуги из заказа

*Если передается, то все подпараметры обязательны.

  • id

нет

string(36)

ID товара

  • name

нет

string(128)

Название товара

  • price

нет

number(decimal)

Цена товара

  • quantity

нет

integer(32)

Количество товаров

callbackUrl

НЕТ

string(2048

Ссылка, по которой Мерчант получит окончательный ответ со статусом и данными транзакции.

Если вы не передадите этот параметр, его значение будет взято из maibmerchants.

okUrl

НЕТ

string(2048)

Ссылка, по которой Покупатель будет перенаправлен в случае успешной транзакции.

(GET request: okUrl + payId&orderId)

Если вы не передадите этот параметр, его значение будет взято из maibmerchants.

failUrl

НЕТ

string(2048)

Ссылка, по которой Покупатель будет перенаправлен в случае неудачной транзакции.

(GET request: failUrl + payId&orderId)

Если вы не передадите этот параметр, его значение будет взято из maibmerchants.

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

{
"amount": 10.25,
"currency": "MDL",
"clientIp": "135.250.245.121",
"language": "ru",
"description": "xxxxxx",
"clientName": "Имя Фамилия",
"email": "customer@gmail.com",
"phone": "069123456",
"orderId": "123",
"delivery": 1.25,
"items": [
{
"id": "10",
"name": "Товар 1",
"price": 2.50,
"quantity": 2
},
{
"id": "11",
"name": "Товар 2",
"price": 4,
"quantity": 1
}
],
"callbackUrl": "https://example.com/callback",
"okUrl": "https://example.com/ok",
"failUrl": "https://example.com/fail"
}

Параметры промежуточного ответа

Параметр
Тип
Описание

result

Object

Объект, содержащий идентификатор транзакции и ссылку перенаправления Покупателя

  • payId

String

Идентификатор транзакции от maib ecomm

  • orderId

String

Идентификатор заказа с сайта/приложения

  • payUrl

String

Ссылка на страницу maib ecomm checkout где Покупателя необходимо перенаправить для ввода данных карты (или оплатить через Apple Pay / Google Pay)

ok

Boolean

Статус обработки запроса/транзакции:

true - ошибок нет;

false - есть ошибки (подробности ошибки будут отображаться в errors);

errors

Array

  • errorCode

String

Код ошибки

  • errorMessage

String

Описание ошибки

  • errorArgs

Object

Объект содержит параметры с информацией об ошибке

Пример промежуточного ответа

{
"result": {
"payId": "f16a9006-128a-46bc-8e2a-77a6ee99df75",
"orderId": "123",
"payUrl": "https://maib.ecommerce.md/ecomm01/ClientHandler?trans_id=rEsfhyIk8s9ypxkcS9fj/3C8FqA="
},
"ok": true
}
{
    "errors": [
        {
            "errorCode": "12001",
            "errorMessage": "Parameter 'amount' is invalid",
            "errorArgs": {
                "parameter": "amount"
            }
        }
    ],
    "ok": false
}

Параметры окончательного ответа (на Callback Url)

Параметр
Тип
Описание

result

Object

Объект содержащий данные транзакции

  • payId

String

Идентификатор транзакции от maib ecomm

  • orderId

String

Идентификатор заказа с сайта/приложения

  • status

String

OK - транзакция завершена успешно.

  • statusCode

String

Код статуса

  • statusMessage

String

Детали статуса транзакции

  • threeDs

String

AUTHENTICATED - аутентификация прошла успешно.

  • rrn

String

RRN - Идентификатор транзакции, генерируемый maib ecomm.

  • approval

String

Approval Code - Идентификатор подтверждения транзакции, сгенерированный банком-эмитентом карты.

  • cardNumber

String

Маскированный номер карты

  • amount

String

Сумма сделки в формате X.XX

  • currency

String

Валюта транзакции (MDL/EUR/USD)

signature

String

Подпись подтверждения ответа.

Пример окончательного ответа

{
"result": {
"payId": "f16a9006-128a-46bc-8e2a-77a6ee99df75",
"orderId": "123",
"status": "OK",
"statusCode": "000",
"statusMessage": "Approved",
"threeDs": "AUTHENTICATED",
"rrn": "331711380059",
"approval": "327593",
"cardNumber": "510218******1124",
"amount": 10.25,
"currency": "MDL"
},
"signature": "r4KwwIUXQGHhcEM7C4um8o9rSrGEriTRcYQuBbmjEec="
}

Ошибки обработки запроса/транзакций.

Завершение транзакции
Отмена авторизации транзакции
Таблица ошибок
Статус транзакции
Результат аутентификации 3-D Secure