Initiate Payment
POST https://api.martpay.net/api/v2/pis/payment
POST https://api.martpay.net/api/v2/pis/paymentОписание Эта конечная точка используется для получения ссылок на оплату, по которым ваши клиенты будут перенаправлены для обработки платежа.
Рабочий процесс страницы оформления заказа для клиента зависит от параметров, переданных в запросе:
Минимальный набор параметров: Если указаны только обязательные параметры, клиенту будет предложено заполнить все необходимые поля на странице оформления заказа.
Расширенные параметры: При получении данных банков через конечную точку «Get Institutions» вы можете передавать дополнительные параметры, которые будут предварительно заполнены на странице оформления заказа. В некоторых случаях это позволяет полностью пропустить этап ввода данных клиентом.
Headers
key
x-api-key
value
{{api-key}}
Body
merchant_order_id
string (required)
Уникальная строка, представляющая платеж. До 256 символов.
payment_amount
string (required)
Сумма платежа. Мин.: 1. Макс.: 15000. Сумма может иметь дробную часть: 2,50. Не допускается указывать более 2 цифр.
payment_currency
string (required)
Поддерживается только EUR.
return_url
string (required)
URL-адрес, по которому ваш клиент будет перенаправлен после проведения платежа.
customer_email
string
Вы можете указать адрес электронной почты клиента, чтобы он был предварительно заполнен на странице оформления заказа.
institution_id
string (optional. Required with institution_country_code)
Идентификатор, представляющий конкретный банк (см. «Get Institutions»).
institution_country_code
string (optional. Required with institution_id)
Код страны банка. Поскольку некоторые банки работают в нескольких странах, вам всегда необходимо указывать это поле вместе с institution_id.
payer
object (optional)
Личная информация клиента и реквизиты банковского счета.Некоторые банки требуют предоставления дополнительной информации о плательщике. Вы можете указать эти поля, если решите использовать параметр institution_id. Если вы не предоставите эти данные (или пропустите некоторые поля), клиенту будет предложено ввести недостающие данные на странице оформления заказа. Список обязательных полей для каждого банка, указанных в свойстве extraFields конечной точки «Get Institutions».
payer.name
string (optional)
Полное имя клиента.
payer.bic
string (optional)
Bank Identifier Code (SWIFT code) для выбранного банка.
payer.iban
string (optional)
Customer's International Bank Account Number(IBAN).
payer.country
string (optional)
Страна по адресу клиента.
payer.city
string (optional)
Адрес клиента, город.
payer.postCode
string(optional)
Почтовый код
payer.countryCode
string (optional)
Страна по адресу клиента. Двухбуквенный код страны (ISO-3166)
payer.buildNumber
string (optional)
Номер дома
payer.streetName
string (optional)
Улица
payer.addressLines
array (optional)
Адрес клиента, включающий город, улицу и номер дома.
payer.psuId
string (optional)
Идентификатор клиента (логин) для личного кабинета, предоставленного банком.
Если указывается psuId, передавать psuCorporateId не требуется.
payer.psuCorporateId
string (optional)
Идентификатор (логин) для бизнес-аккаунта, предоставленного банком
Если указывается psuCorporateId, передавать psuId не требуется.
client_ip
string (optional)
IP-адрес, с которого необходимо выполнить платеж. Параметр обязателен только при включённой проверке IP.
customer_full_name
string (optional)
Полное имя клиента. Параметр обязателен только при включённой проверке IP.
customization
object (optional)
Параметры настройки пользовательского интерфейса для страницы оформления заказа. Если они не указаны, будет применен стиль по умолчанию.
customization.title
string (optional)
Название, отображаемое на странице оформления заказа
customization.logoUrl
string (optional)
URL-адрес изображения логотипа, отображаемого на странице оформления заказа.
Формат: Абсолютный URL (рекомендуется HTTPS)..
customization.logoHeight
string (optional)
Высота логотипа
customization.primaryColor
string (optional)
Основной цвет, используемый для кнопок, выделений и интерактивных элементов (шестнадцатеричный формат).
Формат: Шестнадцатеричный код цвета (#RRGGBB).
customization.bgColor
string (optional)
Цвет фона
customization.spacing
string (optional)
Настройка плотности UI-элементов. Возможные значения: 'sm', 'md', 'lg'
customization.radius
string (optional)
Радиус границы для UI-элементов Возможные значения: 'none', 'sm', 'md', 'lg'
customization.modalShadow
string (optional)
Определяет размер тени модального окна Возможные значения: 'none', 'sm', 'md', 'lg'
Example
Last updated