liqpay-nestjs 0.2.1

package/dist/core/types/documented/checkout.request.d.ts

@@ -0,0 +1,236 @@
+import { LiqPayDetailAddenda } from './detail-addenda';
+import { LiqPayFiscalData } from './fiscal-data';
+import { LiqPaySplitRule } from './split-rule';
+import { LiqPayAction, LiqPayCurrency, LiqPayLanguage, LiqPayPaytype, LiqPaySubscribePeriodicity } from './types';
+/**
+ * Contract of data that is passed when forming a payment request as `base64` encoded string data when calling the LiqPay API
+ */
+export interface LiqPayCheckoutRequest {
+    /**
+     * @group shared
+     */
+    /**
+     * API version. Current version: `7`
+     */
+    version: 7;
+    /**
+     * Public API key: ID of created company. Example: `i00000000`
+     *
+     * You can get the key in the store settings.
+     */
+    public_key: string;
+    /**
+     * @group payment core
+     */
+    /**
+     * Operation type. Possible values:
+     * - `pay` - payment
+     * - `hold` - blocking of funds on sender's account
+     * - `subscribe` - regular payment
+     * - `paydonate` - donation
+     */
+    action: LiqPayAction;
+    /**
+     * Payment amount. For example: `5`, `7.34`
+     */
+    amount: number;
+    /**
+     * Payment currency. Possible values: `USD`, `EUR`, `UAH`
+     */
+    currency: LiqPayCurrency;
+    /**
+     * Payment purpose
+     */
+    description: string;
+    /**
+     * Unique purchase ID in your store. Maximum length __255__ characters
+     */
+    order_id: string;
+    /**
+     * @group invoice lifetime
+     */
+    /**
+     * The time by which the customer can pay the invoice in `UTC`. Transmitted in the format `2016-04-24 00:00:00`
+     */
+    expired_date?: string;
+    /**
+     * @group checkout UI
+     */
+    /**
+     * Client language: `uk`, `en`
+     */
+    language?: LiqPayLanguage;
+    /**
+     * Parameter that transmits payment methods to be displayed at checkout.
+     * If the parameter is not provided, the store settings are applied. Possible values:
+     * - `apay` - Apple Pay
+     * - `gpay` - Google Pay
+     * - `card` - card payment
+     * - `privat24` - via Privat24 account
+     * - `moment_part` - installments
+     * - `paypart` - payment in parts
+     * - `cash` - cash
+     * - `invoice` - invoice to e-mail
+     * - `qr` - scanning a QR code
+     */
+    paytypes?: LiqPayPaytype[];
+    /**
+     * @group checkout flow
+     */
+    /**
+     * The URL in your store to which the buyer will be redirected after completing the purchase. Maximum length __510__ characters
+     */
+    result_url?: string;
+    /**
+     * API URL in your store for notifications about payment status changes (`server -> server`). Maximum length __510__ characters.
+     */
+    server_url?: string;
+    /**
+     * @group fiscalization
+     */
+    /**
+     * Data for fiscalization
+     */
+    rro_info?: LiqPayFiscalData;
+    /**
+     * @group sender
+     */
+    /**
+     * Sender address
+     */
+    sender_address?: string;
+    /**
+     * Sender city
+     */
+    sender_city?: string;
+    /**
+     * Sender country code. Numeric __ISO 3166-1__ code
+     */
+    sender_country_code?: string;
+    /**
+     * Sender first name
+     */
+    sender_first_name?: string;
+    /**
+     * Sender's last name
+     */
+    sender_last_name?: string;
+    /**
+     * Sender's postal code
+     */
+    sender_postal_code?: string;
+    /**
+     * @group subscription
+     */
+    /**
+     * Regular payment. Possible values: `1`
+     */
+    subscribe?: '1';
+    /**
+     * Date of first payment. The time must be specified in the format `2015-03-31 00:00:00` in `UTC`. If the date is past, the subscription will be activated from the current date of receipt of the request
+     */
+    subscribe_date_start?: string;
+    /**
+     * The frequency of funds write-off. Possible values:
+     * - `day` - daily
+     * - `week` - weekly
+     * - `month` - once a month
+     * - `year` - once a year, раз
+     */
+    subscribe_periodicity?: LiqPaySubscribePeriodicity;
+    /**
+     * Payment with splitting the amount into several recipients. This parameter specifies a `JSON` array with payment splitting rules.
+     * One debit is made from the client and several credits are made to the recipients. If you need to transfer your purpose for each amount, use the `description` parameter.
+     * If you need to fiscalize payments for each recipient, add the `rro_info` object. The acquiring fee is charged for each recipient.
+     * @example
+     * ```json
+     * [
+     *   {
+     *     "public_key": "i000000001",
+     *     "amount": 404,
+     *     "commission_payer": "sender",
+     *     "server_url": "https://server1/callback",
+     *     "rro_info": {
+     *       "items": [
+     *         {
+     *           "amount": 2, // quantity
+     *           "price": 202, // unit price
+     *           "cost": 404, // total cost
+     *           "id": 123456 // product id
+     *         }
+     *       ],
+     *       "delivery_emails": [
+     *         "email1@email.com",
+     *         "email2@email.com"
+     *       ]
+     *     }
+     *   },
+     *   {
+     *     "public_key": "i000000002",
+     *     "amount": 200,
+     *     "commission_payer": "receiver",
+     *     "server_url": "https://server2/callback"
+     *   }
+     * ]
+     * ```
+     */
+    split_rules?: LiqPaySplitRule[];
+    /**
+     * @group one-click payment / tokenization
+     */
+    /**
+     * Unique client identifier on the merchant's website. When transmitting the parameter, LiqPay remembers the client's payment details and his identifier - further payment can be made in 1 click. Maximum length __100__ characters. (When using the parameter for __Masterpass 1 click__, a valid payer's phone number is transmitted in this field)
+     */
+    customer?: string;
+    /**
+     * Allows you to generate a `card_token` of the payer, which you will receive in a callback request to `server_url`. `card_token` allows you to make payments without entering the payer's card details, using the token payment API - that is, in 1 click. To receive `card_token`, you must pass the value: `1` in the request
+     */
+    recurringbytoken?: '1';
+    /**
+     * User ID in the merchant system, transmitted with each user payment (must not match `customer`, used for payment using the __Masterpass 1 click__ wallet)
+     */
+    customer_user_id?: string;
+    /**
+     * @group product
+     */
+    /**
+     * Product category. Maximum length `25` characters
+     */
+    product_category?: string;
+    /**
+     * Product description. Maximum length `500` characters.
+     */
+    product_description?: string;
+    /**
+     * Product name. Maximum length `100` characters.
+     */
+    product_name?: string;
+    /**
+     * Product page address. Maximum length `510` characters
+     */
+    product_url?: string;
+    /**
+     * @group metadata
+     */
+    /**
+     * Information to add data to the payment. For example: `"External information for payments"`
+     */
+    info?: string;
+    /**
+     * @group verification
+     */
+    /**
+     * Possible value `Y`. Dynamic verification code, generated and returned in `Callback`. Similarly, the generated code will be passed in the verification transaction to be displayed in the client's card statement. Works for `action = auth`
+     */
+    verifycode?: 'Y';
+    /**
+     * @group special (mcc 4511 / airline data)
+     */
+    /**
+     * Long Detail Addenda entry. __Required for merchants with MCC 4511__.
+     *
+     * The `dae` parameter is a `JSON` string to which `base64` has been applied.
+     * It can contain the parameters given in the example below.
+     */
+    dae?: LiqPayDetailAddenda;
+}

package/dist/core/types/documented/checkout.request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/types/documented/detail-addenda.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Contract of data of Long Detail Addenda entry. __Required for merchants with MCC 4511__.
+ */
+export interface LiqPayDetailAddenda {
+    /**
+     * Airline abbreviation, max 4 characters
+     */
+    airLine: string;
+    /**
+     * Reservation number (locator), max 15 characters
+     */
+    ticketNumber: string;
+    /**
+     * Passenger name, max 29 characters
+     */
+    passengerName: string;
+    /**
+     * Flight number, max 5 digits
+     */
+    flightNumber: string;
+    /**
+     * Departure city/airport code, max 5 characters
+     */
+    originCity: string;
+    /**
+     * Destination city/airport code, max 5 characters
+     */
+    destinationCity: string;
+    /**
+     * Departure date in YYMMDD format, max 6 digits
+     */
+    departureDate: string;
+}

package/dist/core/types/documented/detail-addenda.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/types/documented/envelope.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Base LiqPay request/response envelope
+ *
+ * Contains the payload as a stringified and encrypted JSON (`data`) and a cryptographic `signature`.
+ */
+export interface LiqPayEnvelope {
+    /**
+     * Stringified and encrypted payload
+     */
+    data: string;
+    /**
+     * Signature for verifying payload integrity
+     */
+    signature: string;
+}

package/dist/core/types/documented/envelope.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/types/documented/fiscal-data.d.ts

@@ -0,0 +1,80 @@
+import { LiqPayFiscalTax, LiqPayUnit } from './types';
+/**
+ * Fiscalization data provided by ID contract
+ */
+export interface LiqPayFiscalData {
+    /**
+     * Data about the goods for which payment is made
+     */
+    items?: LiqPayFiscalProductById[] | LiqPayFiscalProductByApi[];
+    /**
+     * List of e-mails to which receipts should be sent after fiscalization
+     */
+    delivery_emails?: string[];
+}
+/**
+ * Contract of data about the product for which payment is being made provided by ID
+ */
+export interface LiqPayFiscalProductById {
+    /**
+     * Quantity/volume
+     */
+    amount: number;
+    /**
+     * The cost of all units of the specified product in the check (`quantity * unit_cost`)
+     */
+    cost: number;
+    /**
+     * Product identifier. You can get it in your `Liqpay account - PPO - Cash register - Products`
+     */
+    id: number;
+    /**
+     * Unit price of the product
+     */
+    price: number;
+}
+/**
+ * Contract of data about the product for which payment is being made provided by API
+ */
+export interface LiqPayFiscalProductByApi {
+    /**
+     * Quantity/volume
+     */
+    amount: number;
+    /**
+     * The cost of all units of the specified product in the check (`quantity * unit_cost`)
+     */
+    cost: number;
+    /**
+     * Unit price of the product
+     */
+    price: number;
+    /**
+     * Category name
+     */
+    categoryname: string;
+    /**
+     * Product name
+     */
+    name: string;
+    /**
+     * Unit of measure code
+     */
+    unitcode: LiqPayUnit;
+    /**
+     * Digital value of the product barcode
+     */
+    barcode?: string;
+    /**
+     * Code according to the UKTZED directory
+     */
+    codifier?: string;
+    /**
+     * Internal product code
+     */
+    vndcode?: string;
+    /**
+     * Tax rate for the product
+     */
+    taxs?: LiqPayFiscalTax[];
+}

package/dist/core/types/documented/fiscal-data.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/types/documented/payment-status.request.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Contract of data that is passed when forming a request to receive payment status as data in `base64` encoded string form when calling the LiqPay API
+ */
+export interface LiqPayPaymentStatusRequest {
+    /**
+     * API version. Current version: `7`
+     */
+    version: 7;
+    /**
+     * Public API key: ID of created company. Example: `i00000000`
+     *
+     * You can get the key in the store settings.
+     */
+    public_key: string;
+    /**
+     * Operation type. Possible values: `status`
+     */
+    action: 'status';
+    /**
+     * Unique purchase ID in your store. Maximum length __255__ characters
+     */
+    order_id: string;
+}

package/dist/core/types/documented/payment-status.request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/types/documented/payment-status.response.d.ts

@@ -0,0 +1,225 @@
+import { LiqPayAction, LiqPayBonusType, LiqPayCurrency, LiqPayLanguage, LiqPayMpiEci, LiqPayPaymentStatus, LiqPayPaytype, LiqPayRequestResult } from './types';
+/**
+ * Contract of data that comes in response to a request to get payment status
+ */
+export interface LiqPayPaymentStatusResponse {
+    /**
+     * Acquirer ID
+     */
+    acq_id: number;
+    /**
+     * Transaction type. Possible values:
+     * - `pay` - payment
+     * - `hold` - blocking funds on the sender's account
+     * - `paysplit` - splitting the payment
+     * - `subscribe` - creating a regular payment
+     * - `paydonate` - donation
+     * - `auth` - card pre-authorization
+     * - `regular` - regular payment
+     */
+    action: LiqPayAction;
+    /**
+     * Agent commission in payment currency
+     */
+    agent_commission: number;
+    /**
+     * Payment amount
+     */
+    amount: number;
+    /**
+     * Sender bonus in debit payment currency
+     */
+    amount_bonus: number;
+    /**
+     * Transaction amount credit in currency `currency_credit`
+     */
+    amount_credit: number;
+    /**
+     * Amount of debit transaction in currency `currency_debit`
+     */
+    amount_debit: number;
+    /**
+     * Authorization code for credit transaction
+     */
+    authcode_credit: string;
+    /**
+     * Authorization code for debit transaction
+     */
+    authcode_debit: string;
+    /**
+     * Discount amount in percentage
+     */
+    bonus_procent: number;
+    /**
+     * Bonus type, possible values: `bonusplus`, `discount_club`, `personal`, `promo`
+     */
+    bonus_type: LiqPayBonusType;
+    /**
+     * Sender card token
+     */
+    card_token: string;
+    /**
+     * Recipient fee in `currency_credit` currency
+     */
+    commission_credit: number;
+    /**
+     * Sender fee in `currency_debit`
+     */
+    commission_debit: number;
+    /**
+     * Payer's phone. An OTP payment confirmation password was sent to this number and the payer's LiqPay account was linked. The phone number is indicated in the international format (Ukraine `+380`). For example: +380950000001 (with +) or 380950000001 (without +)
+     */
+    confirm_phone: string;
+    /**
+     * Payment creation date
+     */
+    create_date: Date;
+    /**
+     * Payment currency
+     */
+    currency: LiqPayCurrency;
+    /**
+     * Transaction currency credit
+     */
+    currency_credit: LiqPayCurrency;
+    /**
+     * Transaction currency debit
+     */
+    currency_debit: LiqPayCurrency;
+    /**
+     * Payment comment
+     */
+    description: string;
+    /**
+     * Payment completion/change date
+     */
+    end_date: Date;
+    /**
+     * Additional payment information
+     */
+    info: string;
+    /**
+     * Sender IP address
+     */
+    ip: string;
+    /**
+     * Possible values: `true` - the transaction went through with 3DS verification, `false` - the transaction went through without 3DS verification
+     */
+    is_3ds: boolean;
+    /**
+     * Client language: `uk`, `en`
+     */
+    language: LiqPayLanguage;
+    /**
+     * `Order_id` of payment in the LiqPay system
+     */
+    liqpay_order_id: string;
+    /**
+     * Payment in installments sign
+     */
+    moment_part: boolean;
+    /**
+     * Represents whether 3D-Secure verification was performed during payment by code value. Possible values:
+     * - `5` - the transaction was completed with 3DS (the issuer and acquirer support 3D-Secure technology)
+     * - `6` - the payer's card issuer does not support 3D-Secure technology
+     * - `7` - the transaction was completed without 3D-Secure
+     */
+    mpi_eci: LiqPayMpiEci;
+    /**
+     * Payment `Order_id`
+     */
+    order_id: string;
+    /**
+     * Payment ID in the LiqPay system
+     */
+    payment_id: number;
+    /**
+     * Payment method. Possible values:
+     * - `card` - payment by card
+     * - `privat24` - through the Privat24 account
+     * - `moment_part` - installment
+     * - `invoice` - invoice to e-mail
+     * - `qr` - scan qr code
+     */
+    paytype: LiqPayPaytype;
+    /**
+     * Store public key
+     */
+    public_key: string;
+    /**
+     * Recipient fee in payment currency
+     */
+    receiver_commission: number;
+    /**
+     * Result of query execution: `ok`, `error`
+     */
+    result: LiqPayRequestResult;
+    /**
+     * Unique transaction number in the authorization and settlement system of the servicing bank `Retrieval Reference number`
+     */
+    rrn_credit: string;
+    /**
+     * Unique transaction number in the authorization and settlement system of the servicing bank `Retrieval Reference number`
+     */
+    rrn_debit: string;
+    /**
+     * Sender bonus in payment currency
+     */
+    sender_bonus: number;
+    /**
+     * Sender's bank
+     */
+    sender_card_bank: string;
+    /**
+     * Country of the sender's card. Numeric __ISO 3166-1__ code
+     */
+    sender_card_country: string;
+    /**
+     * Sender's card
+     */
+    sender_card_mask2: string;
+    /**
+     * Sender's IBAN
+     */
+    sender_iban: string;
+    /**
+     * Sender's card type MC/Visa
+     */
+    sender_card_type: string;
+    /**
+     * Sender's fee in payment currency
+     */
+    sender_commission: number;
+    /**
+     * Sender's first name
+     */
+    sender_first_name: string;
+    /**
+     * Sender's last name
+     */
+    sender_last_name: string;
+    /**
+     * Sender's phone number
+     */
+    sender_phone: string;
+    /**
+     * Payment status
+     */
+    status: LiqPayPaymentStatus;
+    /**
+     * An additional payment status indicating that the current payment is reserved for a refund on your store. Possible values: `true` - the payment is reserved for a refund
+     */
+    wait_reserve_status?: boolean;
+    /**
+     * Transaction ID in the LiqPay system
+     */
+    transaction_id: number;
+    /**
+     * Payment type
+     */
+    type: string;
+    /**
+     * API version. Current value is `7`
+     */
+    version: 7;
+}

package/dist/core/types/documented/payment-status.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/types/documented/split-rule.d.ts

@@ -0,0 +1,29 @@
+import { LiqPayFiscalData } from './fiscal-data';
+import { LiqPayCommisionPayer } from './types';
+/**
+ * Payment splitting options contract
+ */
+export interface LiqPaySplitRule {
+    /**
+     * Public API key: ID of created company. Example: `i00000000`
+     *
+     * You can get the key in the store settings.
+     */
+    public_key: string;
+    /**
+     * Total payment amount. For example: `5`, `7.34`
+     */
+    amount: number;
+    /**
+     * Payer of the acquiring fee. Possible values: `sender`, `receiver`
+     */
+    commission_payer: LiqPayCommisionPayer;
+    /**
+     * API URL in your store for notifications about payment status changes (`server -> server`). Maximum length __510__ characters.
+     */
+    server_url: string;
+    /**
+     * Data on fiscalization of payments for each recipient
+     */
+    rro_info?: LiqPayFiscalData;
+}

package/dist/core/types/documented/split-rule.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });