Приватний
DCC
Отримання оплати клієнта в валюті його картки

Схема роботи API оплата карткою server-server
Важливо:
  1. Для отримання курсу та альтернативної суми до фінального запиту з action = “pay” додайте параметр prepare = “tariffs”. У відповіді параметр dcc_allowed буде містити дані за курсом і за сумою в альтернативній валюті на поточний момент.
  2. Для виконання операції з DCC до фінального запиту з action = “pay” додайте параметр is_dcc_debit = “true”.
Формування запиту до API при самостійній інтеграції:
Параметри для формування data:
Основні
Parameter Required Type Description
version Required Number Версія API. Поточне значення - 3
public_key Required String Публічний ключ - ідентифікатор магазину. Отримати ключ можна в налаштуваннях магазину
action Required String pay
amount Required Number Сума платежу. Наприклад: 5, 7.34
card Required String Номер картки платника
card_cvv Required String CVV/CVV2
card_exp_month Required String Місяць терміну дії картки платника. Наприклад: 08
card_exp_year Required String Рік терміну дії картки платника. Наприклад: 19
card_token Required String Токен картки платника. Наприклад: B5BВB0D00B88B00ED00A00D0D (При використанні токену дані картки передавати не потрібно)
currency Required String Валюта платежу. Можливі значення: USD, EUR, RUB, UAH
description Required String Призначення платежу.
order_id Required String Унікальний ID покупки у Вашому магазині. Максимальна довжина 255 символів.
phone Required String Телефон платника. На цей номер буде відправлений OTP пароль підтвердження платежу. Телефон вказується в міжнародному форматі (Україна +380, Росія +7). Наприклад: +380950000001 (з +) або +380950000001 (без +)
language Optional String Мова клієнта ru, uk, en
recurringbytoken Optional String Цей параметр дозволяє генерувати card_token платника, який ви отримаєте в callback запиті на server_url. card_token дозволяє проводити платежі без введення реквізитів картки платника, використовуючи API paytoken. Для отримання card_token необхідно передати в запиті значення: 1
result_url Optional String URL у Вашому магазині на який покупець буде переадресовано після завершення покупки. Максимальна довжина 510 символів.
server_url Optional String URL API в Вашому магазині для повідомлень про зміну статусу платежу (сервер->сервер). Максимальна довжина 510 символів. Детальніше
sandbox Required String Включає тестовий режим. Кошти з картки платника не списуються. Для включення тестового режиму необхідно передати значення 1. Всі тестові платежі будуть мати статус sandbox - успішний тестовий платіж.
is_dcc_debit Optional Boolean true - транзакция будет проведена с использованием альтернативной суммы DCC.
false - транзакция будет проведена без DCC.
prepare Optional String tariffs Получить курс и альтернативную валюту DCC.
Параметри відправника
sender_address NEW Optional String Адреса відправника
sender_city Optional String Місто відправника
sender_country_code Optional String Код країни відправника. Цифровий ISO 3166-1 код
sender_first_name Optional String Ім'я відправника
sender_last_name Optional String Прізвище відправника
sender_postal_code Optional String Поштовий індекс відправника
3DS параметри
mpi_md Optional String Параметр, що повертається сторінкою ACS MD.
Цей параметр передається, тільки якщо попередньо було використано API MPI
mpi_pares Optional String Параметр, що повертається сторінкою ACS pares.
Цей параметр передається, тільки якщо попередньо було використано API MPI
Приклад відповіді:
{
  "action": "pay",
  "payment_id": 165172,
  "status": "success",
  "version": 3,
  "type": "buy",
  "paytype": "card",
  "public_key": "i000000000",
  "acq_id": 414963,
  "order_id": "98R1U1OV1485849059893399",
  "liqpay_order_id": "NYMK3AE61501685438251925",
  "description": "description",
  "sender_phone": "380950000001",
  "sender_first_name": "first_name",
  "sender_last_name": "last_name",
  "sender_card_mask2": "473118*50",
  "sender_card_bank": "pb",
  "sender_card_type": "visa",
  "sender_card_country": 804,
  "dcc_allowed": [{
    "amount": 3.5984,
    "rate": 27.7905,
    "commission": 0.0,
    "currency": "USD"
  }],
  "ip": "8.8.8.8",
  "card_token": "CDRES215658546306B200061FCC53A86B",
  "amount": 100.0,
  "currency": "UAH",
  "sender_commission": 0.0,
  "receiver_commission": 0.0,
  "agent_commission": 0.0,
  "amount_debit": 100.0,
  "amount_credit": 100.0,
  "commission_debit": 0.0,
  "commission_credit": 0.0,
  "currency_debit": "UAH",
  "currency_credit": "UAH",
  "sender_bonus": 0.0,
  "amount_bonus": 0.0,
  "bonus_type": "bonusplus",
  "bonus_procent": 0.0,
  "authcode_debit": "388000",
  "authcode_credit": "329007",
  "rrn_debit": "000663747000",
  "rrn_credit": "000663747003",
  "mpi_eci": "7",
  "is_3ds": false,
  "create_date": 1501685446633,
  "end_date": 1501685446633,
  "transaction_id": 165172
}
Параметри відповіді
Parameter Type Description
acq_id Number ID еквайера
action String Тип операції. Можливі значення: pay - платіж, hold - блокування коштів на рахунку відправника, paysplit - розщеплення платежу, subscribe - створення регулярного платежу, paydonate - пожертвування, auth - предавторізація картки, regular - регулярний платіж
agent_commission Number Комісія агента в валюті платежу
amount Number Сума платежу
amount_bonus Number Бонус відправника у валюті платежу debit
amount_credit Number Сума транзакції credit в валюті currency_credit
amount_debit Number Сума транзакції debit у валюті currency_debit
authcode_credit String Код авторизації по транзакції credit
authcode_debit String Код авторизації по транзакції debit
bonus_procent Number Розмір знижки в процентах
bonus_type String Тип бонусу, можливі значення bonusplus, discount_club, personal, promo
card_token String Token картки відправника
commission_credit Number Комісія з одержувача у валюті currency_credit
commission_debit Number Комісія з відправника у валюті currency_debit
create_date String Дата створення платежу
currency String Валюта платежу
currency_credit String Валюта транзакції credit
currency_debit String Валюта транзакції debit
description String Коментар до платежу
end_date String Дата завершення/зміни платежу
ip String IP адреса відправника
is_3ds Boolean Можливі значення:
true - транзакція пройшла з 3DS перевіркою,
false - транзакція пройшла без 3DS перевірки
liqpay_order_id String Order_id платежу в системі LiqPay
mpi_eci Number Можливі значення: 5 - транзакція пройшла з 3DS (емітент і еквайєр підтримують технологію 3D-Secure), 6 - емітент картки платника не підтримує технологію 3D-Secure, 7 - операція пройшла без 3D-Secure
order_id String Order_id платежу
payment_id Number Id платежу в системі LiqPay
paytype String Спосіб оплати. Можливі значення card - оплата картою, liqpay - через кабінет liqpay, privat24 - через кабінет Приват24, masterpass - через кабінет masterpass, moment_part - розстрочка, cash - готівкою, invoice - рахунок на e-mail, qr - сканування qr-коду.
public_key String Публічний ключ магазину
receiver_commission Number Комісія з одержувача у валюті платежу
status String Можливі значення: activated - магазин активований з відшкодуванням, wait_accept - магазин активований без відшкодування
rrn_credit String Унікальний номер транзакції в системі авторизації і розрахунків обслуговуючого банку Retrieval Reference number
rrn_debit String Унікальний номер транзакції в системі авторизації і розрахунків обслуговуючого банку Retrieval Reference number
sender_bonus Number Бонус відправника у валюті платежу
sender_card_bank String Банк відправника
sender_card_country String Країна картки відправника. Цифровий ISO 3166-1 код
sender_card_mask2 String Карта відправника
sender_card_type String Тип картки відправника MC/Visa
sender_commission Number Комісія з відправника у валюті платежу
sender_first_name String Ім'я відправника
sender_last_name String Прізвище відправника
sender_phone String Телефон відправника
status String Статус платежу.
Можливі значення:
Кінцеві статуси платежу
error Неуспішний платіж. Некоректно заповнені дані
failure Неуспішний платіж
reversed Платіж повернений
success Успішний платіж
Статуси що потребують підтвердження платежу
3ds_verify Потрібна 3DS верифікація.
Для завершення платежу, потрібно виконати 3ds_verify
cvv_verify Потрібне введення CVV картки відправника.
Для завершення платежу, потрібно виконати cvv_verify
otp_verify Потрібне OTP підтвердження клієнта. OTP пароль відправлений на номер телефону Клієнта.
Для завершення платежу, потрібно виконати otp_verify
receiver_verify Потрібне введення даних одержувача.
Для завершення платежу, потрібно виконати receiver_verify
sender_verify Потрібне введення даних відправника.
Для завершення платежу, потрібно виконати sender_verify
Інші статуси платежу
wait_accept Кошти з клієнта списані, але магазин ще не пройшов перевірку. Якщо магазин не пройде активацію протягом 90 днів, платежі будуть автоматично скасовані
wait_secure Платіж на перевірці
transaction_id Number Id транзакції в системі LiqPay
type String Тип платежу
version Number Версія API. Поточне значення - 3
dcc_allowed Object Дані альтернативної суми для оплати з DCC:
amount Сума платежу в альтернативній валюті
currency Альтернативна валюта
rate Курс конвертації
commission Комісія за платежем в альтернативній валюті