Private
DCC
Acceptance of payment in the client's card currency

Scheme of API server-server card payment
Important:
  1. To receive the exchange rate and the alternative amount in the final request with action = “pay” add the prepare parameter prepare = “tariffs”. In response dcc_allowed parameter will contain the exchange rate and amount in the alternative currency at the moment.
  2. To perform the operation with DCC, add action = “pay” to the final request with is_dcc_debit = “true”.
Forming a request to API for self-integration:
Options for generating data:
Main
Parameter Required Type Description
version Required Number Version API. Current value - 3
public_key Required String Public key - the store identifier. You can get the key in the store settings
action Required String pay
amount Required Number Payment amount. For example: 5, 7.34
card Required String Card number of the payer
card_cvv Required String CVV/CVV2
card_exp_month Required String Expiry month of the payer's card. For example: 08
card_exp_year Required String Expiry year of the payer's card.For example: 19
card_token Required String Sender's card token. For example: B5BВB0D00B88B00ED00A00D0D (You don't need to transmit card data, when using a token)
currency Required String Payment currency. Possible values: USD, EUR, RUB, UAH
description Required String Payment description.
order_id Required String Unique purchase ID in your shop. Maximum length is 255 symbols.
phone Required String Payer's mobile phone. One time password will be sent to the number to confirm the payment. Mobile number should be in the international format (Ukraine +380, Russia +7). For example: +380950000001 (with +) or 380950000001 (without +)
language Optional String Customer's language ru, uk, en
recurringbytoken Optional String This parameter allows to generate payer card_token which you receive in callback request to server_url. card_token allows to make recurring payments without payer card requisites using API paytoken. To receive card_token please send in request value: 1
result_url Optional String URL of your shop where the buyer would be redirected after completion of the purchase. Maximum length 510 symbols.
server_url Optional String URL API in your store for notifications of payment status change (server->server). Maximum length is 510 symbols. Learn more
sandbox Required String Enables the testing environment for developers. Payer card will not be charged. To enable testing environment you will need to transmit value 1. All test payments will have the status sandbox - successful test payment.
is_dcc_debit Optional Boolean true - транзакция будет проведена с использованием альтернативной суммы DCC.
false - транзакция будет проведена без DCC.
prepare Optional String tariffs Получить курс и альтернативную валюту DCC.
Sender parameters
sender_address NEW Optional String Sender's address
sender_city Optional String Sender's city
sender_country_code Optional String Country code of the sender. Digital ISO 3166-1 code
sender_first_name Optional String Sender's first name
sender_last_name Optional String Sender's last name
sender_postal_code Optional String Sender's zip code
3DS parameters
mpi_md Optional String Parameter that returns from ACS MD.
This parameter is transmitted only in case when is used the API MPI
mpi_pares Optional String Parameter that returns from ACS pares.
This parameter is transmitted only in case when is used the API MPI
Example response:
{
  "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
}
Response parameters
Parameter Type Description
acq_id Number Acquirer ID
action String Transaction type. Possible values: pay - payment, hold - amount of hold on sender's account, paysplit - splitting payments, subscribe - creation of a regular payment, paydonate - donation, auth - card preauth, regular - regular payment
agent_commission Number Agent comission in payment currency
amount Number Payment amount
amount_bonus Number Payer bonus amount in payment currency debit
amount_credit Number Payment amount for credit in currency of currency_credit
amount_debit Number Payment amount for debit in currency of currency_debit
authcode_credit String Authorization code for transaction of credit
authcode_debit String Authorization code for transaction of debit
bonus_procent Number Discount rate in percent
bonus_type String Bonus type, possible values ​​of bonusplus, discount_club, personal, promo
card_token String Sender's card token
commission_credit Number Commission from the receiver in currency_credit
commission_debit Number Commission from the sender in currency_debit
create_date String Date of payment creation
currency String Payment currency
currency_credit String Transaction currency of credit
currency_debit String Transaction currency of debit
description String Payment description
end_date String Date of payment edition/end
ip String sender's IP address
is_3ds Boolean Possible values:
true - transaction passed with 3DS,
false - transaction passed without 3DS
liqpay_order_id String Payment order_id in LiqPay system
mpi_eci Number Possible values: 5 - the transaction passed with 3DS (issuer and acquirer support 3d Secure technology), 6 - the issuer of the payer card does not support 3d Secure technology, 7 - the operation passed without 3d Secure
order_id String Order_id payment
payment_id Number Payment id in LiqPay system
paytype String Methods of payment. Possible values card - card payment, liqpay - with liqpay account, privat24 - with privat24 account, masterpass - with masterpass account, moment_part - installments, cash - cash, invoice - to email, qr - qr code scanning.
public_key String Shop public key
receiver_commission Number Receiver comission in payment currency
status String Possible meaning: activated - the store is activated with refund, wait_accept - the store is activated without refund
rrn_credit String Unique transaction ID in authorization and settlement system of issuer bank Retrieval Reference number
rrn_debit String Unique transaction ID in authorization and settlement system of issuer bank Retrieval Reference number
sender_bonus Number Sender's bonus in the payment currency
sender_card_bank String Sender's card bank
sender_card_country String Sender's card country. Digital ISO 3166-1 code
sender_card_mask2 String Sender's card
sender_card_type String Sender's card type MC/Visa
sender_commission Number Commission from the sender in the payment currency
sender_first_name String The name of the sender
sender_last_name String sender's last name
sender_phone String Sender's phone number
status String Payment status.
Available values:
Final payment statuses
error Failed payment. Data is incorrect
failure Failed payment
reversed Payment refunded
success Successful payment
Statuses that required payment confirmation
3ds_verify 3DS verification is required.
To finish the payment you will require a 3ds_verify
cvv_verify Sender's card CVV is required.
To finish the payment you will require a cvv_verify
otp_verify OTP confirmation is required. OTP is sent to a customer phone number.
To finish the payment it is required otp_verify
receiver_verify Receiver additional data is required.
To finish the payment you will require a receiver_verify
sender_verify Sender's additional data is required.
To finish the payment you will require a sender_verify
Other payment statuses
wait_accept Money are withdrawn from client but the store is still not verified. If the store is not activated for 90 days, payment will be automatically cancelled
wait_secure Payment is verified
transaction_id Number Id transactions in the LiqPay system
type String Payment type
version Number Version API. Present value - 3
dcc_allowed Object Data of alternative amount for payment with DCC:
amount Amount of payment in alternative currency
currency Alternative currency
rate Conversion rate
commission Commission on payment in alternative currency