Private
Token payment
Withdrawal from client's card by card's token

Scheme of API token payment
Forming a request to API for self-integration:
Example of using SDK:
#!/bin/bash
PUBLIC_KEY='your_public_key'
PRIVATE_KEY='your_private_key'
API_URL='https://www.liqpay.ua/api/request'
JSON="{ 
    \"action\" : \"paytoken\", 
    \"version\" : 3,
    \"public_key\" : \"${PUBLIC_KEY}\", 
    \"phone\" : \"380950000001\",
    \"amount\" : 1,
    \"currency\" : \"USD\",
    \"description\" : \"description text\",
    \"order_id\" : \"order_id_1\",
    \"card_token\" : \"B5BВB0D00B88B00ED00A00D0D\"
}"
# DATA is base64_encode result from JSON string
DATA=$(echo -n ${JSON} | base64)
# SIGNATURE is base64 encode result from sha1 binary hash from concatenate string ${PRIVATE_KEY}${DATA}${PRIVATE_KEY}
SIGNATURE=$(echo -n "${PRIVATE_KEY}${DATA}${PRIVATE_KEY}" | openssl dgst -binary -sha1 | base64)
# REQ is json response from liqpay
REQ=$(curl --silent -XPOST ${API_URL} --data-urlencode data="${DATA}" --data-urlencode signature="${SIGNATURE}")
echo "Result: ${REQ}"
$liqpay = new LiqPay($public_key, $private_key);
$res = $liqpay->api("request", array(
'action'         => 'paytoken',
'version'        => '3',
'phone'          => '380950000001',
'amount'         => '1',
'currency'       => 'USD',
'description'    => 'description text',
'order_id'       => 'order_id_1',
'card_token'     => 'B5BВB0D00B88B00ED00A00D0D'
));
HashMap<String, String> params = new HashMap<String, String>();
params.put("action", "paytoken");
params.put("version", "3");
params.put("phone", "380950000001");
params.put("amount", "1");
params.put("currency", "USD");
params.put("description", "description text");
params.put("order_id", "order_id_1"); 
params.put("card_token", "B5BВB0D00B88B00ED00A00D0D");

LiqPay liqpay = new LiqPay(PUBLIC_KEY, PRIVATE_KEY);
HashMap<String, Object> res = liqpay.api("request", params);    
System.out.println(res.get("status"));
  
liqpay = LiqPay(public_key, private_key)
res = liqpay.api("request", {
"action"         : "paytoken",
"version"        : "3",
"phone"          : "380950000001",
"amount"         : "1",
"currency"       : "USD",
"description"    : "description text",
"order_id"       : "order_id_1",
"card_token"     : "B5BВB0D00B88B00ED00A00D0D"
})
liqpay = Liqpay::Liqpay.new(
:public_key  => 'public_key',
:private_key => 'private_key'
)
res = liqpay.api("request", {
:action         => "paytoken",
:version        => "3",
:phone          => "380950000001",
:amount         => "1",
:currency       => "USD",
:description    => "description text",
:order_id       => "order_id_1",
:card_token     => "B5BВB0D00B88B00ED00A00D0D"
})
LiqPay = liqpay:init(PublicKey, PrivateKey),
Res = liqpay:api("request", [
{<<"action">>, <<"paytoken">>}, 
{<<"version">>, <<"3">>}, 
{<<"phone">>, <<"380950000001">>}, 
{<<"amount">>, <<"1">>}, 
{<<"currency">>, <<"USD">>}, 
{<<"description">>, <<"description text">>}, 
{<<"order_id">>, <<"order_id_1">>}, 
{<<"card_token">>, <<"B5BВB0D00B88B00ED00A00D0D">>}
], LiqPay)
var LiqPay = require('liqpay');
var liqpay = new LiqPay(public_key, private_key);
liqpay.api("request", {
"action"         : "paytoken",
"version"        : "3",
"phone"          : "380950000001",
"amount"         : "1",
"currency"       : "USD",
"description"    : "description text",
"order_id"       : "order_id_1",
"card_token"     : "B5BВB0D00B88B00ED00A00D0D"
}, function( json ){
console.log( json.status );
});
my $liqpay = Liqpay->new($public_key,$private_key);
my $res = $liqpay->api("request",
{
'action'         => 'paytoken',
'version'        => '3',
'phone'          => '380950000001',
'amount'         => '1',
'currency'       => 'USD',
'description'    => 'description text',
'order_id'       => 'order_id_1',
'card_token'     => 'B5BВB0D00B88B00ED00A00D0D'
}
);
Init("my_public_key", "my_private_key")
Api("request", map[string]interface{}{
    "action": "paytoken",
    "version": 3,
    "public_key": PublicKey,
    "phone": "380950000001",
    "amount": 1,
    "currency": "UAH",
    "description": "Test payment",
    "order_id": "order_id_1",
    "card_token": "B5BВB0D00B88B00ED00A00D0D",
})
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 paytoken
amount Required Number Payment amount. For example: 5, 7.34
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.
ip Required String Client IP
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
prepare Optional String The preliminary preparation of the payment. This mode allows to check if all data are filled in, if 3DS authentication is required, if transaction is within limit. Payer card will not be charged. To enable this mode you will need to transmit value 1
server_url Optional String URL API in your store for notifications of payment status change (server->server). Maximum length is 510 symbols. Learn more
Regular payment parameters
subscribe Optional String Regular payment. Possible values: 1
subscribe_date_start Optional String Date of the first payment. Time must be specified in the following format 2015-03-31 00:00:00 по UTC. If past date is indicated - subscription will be activated with the date and time of request
subscribe_periodicity Optional String Period of payments. Possible values:
month - once in a month
year - once in a year
Letter of credit parameters
letter_of_credit Optional String To enable receipt of payments within letter of credit send request with the value1
letter_of_credit_date Optional String The expiry date of the letter of credit in the following format 2015-03-31 00:00:00 by UTC.
Parameters of splitting the payments
split_rules Optional String Payment with split amount for a few receivers. This parameter is a JSON array containing split rules. While using split_rules parameter, card is being charged and amount is split and credited to a few receivers. Acquiring fee is being charged from each shop in the split_rules. Example JSON string:
[
  {
    "public_key": "i000000001",
    "amount": 1,
    "commission_payer": "sender",
    "server_url": "https://server1/callback"
  },
  {
    "public_key": "i000000002",
    "amount": 2,
    "commission_payer": "receiver",
    "server_url": "https://server2/callback"
  }
]
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
Other parameters
customer Optional String Unique customer ID in your shop. Max length 100 symbols.
dae Optional String Detail Addenda.
Parameter dae is JSON string, to which function base64. JSON can contain the following parameters:
{
  "airLine": "Avia", // airline abbreviation, max 4 symbols.
  "ticketNumber": "ACSFD12354SA", // ticket number, max 15 symbols. 
  "passengerName": "John Doe", // passenger name, max 29 symbols.
  "flightNumber": "742", // flight number, max 5 number.
  "originCity": "DP", // departure city/airport code, max 5 symbols.
  "destinationCity": "NY", // arrival city/airport code, max 5 symbols.
  "departureDate": "100514" // departure date in format YYMMDD, max 6 number.
}
Example of parameter dae: ewogICJhaXJMaW5lIjogIkROSVBST0FWSUEiLAogICJ0aWNrZXROdW1iZXIiOiAiQUNTRkQxMjM1NFNBIiwKICAicGFzc2VuZ2VyTmFtZSI6ICJKb2huIERvZSIsCiAgImZsaWdodE51bWJlciI6ICI3NDIiLAogICJvcmlnaW5DaXR5IjogIkRQIiwKICAiZGVzdGluYXRpb25DaXR5IjogIk5ZIiwKICAiZGVwYXJ0dXJlRGF0ZSI6ICIxMDA1MTQiCn0=
info Optional String Information to add details to payment. For example: "External information for payments"
product_category Optional String Product category in your shop. The maximum length is 25 symbols.
product_description Optional String Product description in your shop. The maximum length is 500 symbols.
product_name Optional String Product name in your shop. The maximum length is 100 symbols.
product_url Optional String Product page address. The maximum length is 2000 symbols.
Example response:
{
  "action": "pay",
  "payment_id": 165167,
  "status": "success",
  "version": 3,
  "type": "buy",
  "paytype": "card",
  "public_key": "i000000000",
  "acq_id": 414963,
  "order_id": "98R1U1OV1485849059893399",
  "liqpay_order_id": "NYMK3AE61501685438251925",
  "description": "description text",
  "sender_phone": "380950000001",
  "sender_card_mask2": "414961*99",
  "sender_card_bank": "pb",
  "sender_card_type": "visa",
  "sender_card_country": 804,
  "amount": 0.02,
  "currency": "UAH",
  "sender_commission": 0.0,
  "receiver_commission": 0.0,
  "agent_commission": 0.0,
  "amount_debit": 0.02,
  "amount_credit": 0.02,
  "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": 7.0,
  "authcode_debit": "366297",
  "authcode_credit": "538974",
  "rrn_debit": "000663740464",
  "rrn_credit": "000663740472",
  "mpi_eci": "7",
  "is_3ds": false,
  "create_date": 1501684842777,
  "end_date": 1501684842777,
  "transaction_id": 165167
}
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
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
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
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_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
Other payment statuses
wait_accept Money are withdrawn from client but the store is still not verified. If the store is not activated for 180 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