liqpay-nestjs 0.2.1

package/dist/core/schemas/payment-status/payment-status-response.schema.d.ts

@@ -0,0 +1,213 @@
+import { z } from 'zod';
+export declare const LiqPayRawPaymentStatusResponseSchema: z.ZodObject<{
+    acq_id: z.ZodOptional<z.ZodNumber>;
+    action: z.ZodOptional<z.ZodString>;
+    agent_commission: z.ZodOptional<z.ZodNumber>;
+    amount: z.ZodOptional<z.ZodNumber>;
+    amount_bonus: z.ZodOptional<z.ZodNumber>;
+    amount_credit: z.ZodOptional<z.ZodNumber>;
+    amount_debit: z.ZodOptional<z.ZodNumber>;
+    authcode_credit: z.ZodOptional<z.ZodString>;
+    authcode_debit: z.ZodOptional<z.ZodString>;
+    bonus_procent: z.ZodOptional<z.ZodNumber>;
+    bonus_type: z.ZodOptional<z.ZodString>;
+    card_token: z.ZodOptional<z.ZodString>;
+    commission_credit: z.ZodOptional<z.ZodNumber>;
+    commission_debit: z.ZodOptional<z.ZodNumber>;
+    confirm_phone: z.ZodOptional<z.ZodString>;
+    create_date: z.ZodOptional<z.ZodString>;
+    currency: z.ZodOptional<z.ZodString>;
+    currency_credit: z.ZodOptional<z.ZodString>;
+    currency_debit: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    end_date: z.ZodOptional<z.ZodString>;
+    info: z.ZodOptional<z.ZodString>;
+    ip: z.ZodOptional<z.ZodString>;
+    is_3ds: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>;
+    language: z.ZodOptional<z.ZodString>;
+    liqpay_order_id: z.ZodOptional<z.ZodString>;
+    moment_part: z.ZodOptional<z.ZodString>;
+    mpi_eci: z.ZodOptional<z.ZodNumber>;
+    order_id: z.ZodOptional<z.ZodString>;
+    payment_id: z.ZodOptional<z.ZodNumber>;
+    paytype: z.ZodOptional<z.ZodString>;
+    public_key: z.ZodOptional<z.ZodString>;
+    receiver_commission: z.ZodOptional<z.ZodNumber>;
+    result: z.ZodOptional<z.ZodString>;
+    rrn_credit: z.ZodOptional<z.ZodString>;
+    rrn_debit: z.ZodOptional<z.ZodString>;
+    sender_bonus: z.ZodOptional<z.ZodNumber>;
+    sender_card_bank: z.ZodOptional<z.ZodString>;
+    sender_card_country: z.ZodOptional<z.ZodString>;
+    sender_card_mask2: z.ZodOptional<z.ZodString>;
+    sender_iban: z.ZodOptional<z.ZodString>;
+    sender_card_type: z.ZodOptional<z.ZodString>;
+    sender_commission: z.ZodOptional<z.ZodNumber>;
+    sender_first_name: z.ZodOptional<z.ZodString>;
+    sender_last_name: z.ZodOptional<z.ZodString>;
+    sender_phone: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodString>;
+    wait_reserve_status: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>;
+    transaction_id: z.ZodOptional<z.ZodNumber>;
+    type: z.ZodOptional<z.ZodString>;
+    version: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type LiqPayRawPaymentStatusResponse = z.infer<typeof LiqPayRawPaymentStatusResponseSchema>;
+export declare const LiqPayPaymentStatusResponseSchema: z.ZodPipe<z.ZodObject<{
+    acq_id: z.ZodOptional<z.ZodNumber>;
+    action: z.ZodOptional<z.ZodString>;
+    agent_commission: z.ZodOptional<z.ZodNumber>;
+    amount: z.ZodOptional<z.ZodNumber>;
+    amount_bonus: z.ZodOptional<z.ZodNumber>;
+    amount_credit: z.ZodOptional<z.ZodNumber>;
+    amount_debit: z.ZodOptional<z.ZodNumber>;
+    authcode_credit: z.ZodOptional<z.ZodString>;
+    authcode_debit: z.ZodOptional<z.ZodString>;
+    bonus_procent: z.ZodOptional<z.ZodNumber>;
+    bonus_type: z.ZodOptional<z.ZodString>;
+    card_token: z.ZodOptional<z.ZodString>;
+    commission_credit: z.ZodOptional<z.ZodNumber>;
+    commission_debit: z.ZodOptional<z.ZodNumber>;
+    confirm_phone: z.ZodOptional<z.ZodString>;
+    create_date: z.ZodOptional<z.ZodString>;
+    currency: z.ZodOptional<z.ZodString>;
+    currency_credit: z.ZodOptional<z.ZodString>;
+    currency_debit: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    end_date: z.ZodOptional<z.ZodString>;
+    info: z.ZodOptional<z.ZodString>;
+    ip: z.ZodOptional<z.ZodString>;
+    is_3ds: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>;
+    language: z.ZodOptional<z.ZodString>;
+    liqpay_order_id: z.ZodOptional<z.ZodString>;
+    moment_part: z.ZodOptional<z.ZodString>;
+    mpi_eci: z.ZodOptional<z.ZodNumber>;
+    order_id: z.ZodOptional<z.ZodString>;
+    payment_id: z.ZodOptional<z.ZodNumber>;
+    paytype: z.ZodOptional<z.ZodString>;
+    public_key: z.ZodOptional<z.ZodString>;
+    receiver_commission: z.ZodOptional<z.ZodNumber>;
+    result: z.ZodOptional<z.ZodString>;
+    rrn_credit: z.ZodOptional<z.ZodString>;
+    rrn_debit: z.ZodOptional<z.ZodString>;
+    sender_bonus: z.ZodOptional<z.ZodNumber>;
+    sender_card_bank: z.ZodOptional<z.ZodString>;
+    sender_card_country: z.ZodOptional<z.ZodString>;
+    sender_card_mask2: z.ZodOptional<z.ZodString>;
+    sender_iban: z.ZodOptional<z.ZodString>;
+    sender_card_type: z.ZodOptional<z.ZodString>;
+    sender_commission: z.ZodOptional<z.ZodNumber>;
+    sender_first_name: z.ZodOptional<z.ZodString>;
+    sender_last_name: z.ZodOptional<z.ZodString>;
+    sender_phone: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodString>;
+    wait_reserve_status: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>;
+    transaction_id: z.ZodOptional<z.ZodNumber>;
+    type: z.ZodOptional<z.ZodString>;
+    version: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>, z.ZodTransform<{
+    action: "" | "pay" | "hold" | "paysplit" | "subscribe" | "paydonate" | "auth" | "regular" | "status" | undefined;
+    bonusType: "" | "bonusplus" | "discount_club" | "personal" | "promo" | undefined;
+    createDate: Date | undefined;
+    currency: "" | "USD" | "EUR" | "UAH" | undefined;
+    currencyCredit: "" | "USD" | "EUR" | "UAH" | undefined;
+    currencyDebit: "" | "USD" | "EUR" | "UAH" | undefined;
+    endDate: Date | undefined;
+    is3ds: boolean | undefined;
+    language: "" | "uk" | "en" | undefined;
+    momentPart: boolean | undefined;
+    mpiEci: 0 | 5 | 6 | 7 | undefined;
+    paytype: "" | "apay" | "gpay" | "card" | "privat24" | "masterpass" | "moment_part" | "paypart" | "cash" | "invoice" | "qr" | undefined;
+    result: "" | "error" | "ok" | undefined;
+    status: "" | "success" | "error" | "failure" | "reversed" | "subscribed" | "unsubscribed" | "3ds_verify" | "captcha_verify" | "cvv_verify" | "ivr_verify" | "otp_verify" | "password_verify" | "phone_verify" | "pin_verify" | "receiver_verify" | "sender_verify" | "senderapp_verify" | "wait_qr" | "wait_sender" | "p24_verify" | "mp_verify" | "cash_wait" | "hold_wait" | "invoice_wait" | "prepared" | "processing" | "wait_accept" | "wait_card" | "wait_compensation" | "wait_lc" | "wait_reserve" | "wait_secure" | "try_again" | undefined;
+    waitReserveStatus: boolean | undefined;
+    version: 0 | 7 | undefined;
+    acqId?: number | undefined;
+    agentCommission?: number | undefined;
+    amount?: number | undefined;
+    amountBonus?: number | undefined;
+    amountCredit?: number | undefined;
+    amountDebit?: number | undefined;
+    authcodeCredit?: string | undefined;
+    authcodeDebit?: string | undefined;
+    bonusProcent?: number | undefined;
+    cardToken?: string | undefined;
+    commissionCredit?: number | undefined;
+    commissionDebit?: number | undefined;
+    confirmPhone?: string | undefined;
+    description?: string | undefined;
+    info?: string | undefined;
+    ip?: string | undefined;
+    liqpayOrderId?: string | undefined;
+    orderId?: string | undefined;
+    paymentId?: number | undefined;
+    publicKey?: string | undefined;
+    receiverCommission?: number | undefined;
+    rrnCredit?: string | undefined;
+    rrnDebit?: string | undefined;
+    senderBonus?: number | undefined;
+    senderCardBank?: string | undefined;
+    senderCardCountry?: string | undefined;
+    senderCardMask2?: string | undefined;
+    senderIban?: string | undefined;
+    senderCardType?: string | undefined;
+    senderCommission?: number | undefined;
+    senderFirstName?: string | undefined;
+    senderLastName?: string | undefined;
+    senderPhone?: string | undefined;
+    transactionId?: number | undefined;
+    type?: string | undefined;
+}, {
+    acq_id?: number | undefined;
+    action?: string | undefined;
+    agent_commission?: number | undefined;
+    amount?: number | undefined;
+    amount_bonus?: number | undefined;
+    amount_credit?: number | undefined;
+    amount_debit?: number | undefined;
+    authcode_credit?: string | undefined;
+    authcode_debit?: string | undefined;
+    bonus_procent?: number | undefined;
+    bonus_type?: string | undefined;
+    card_token?: string | undefined;
+    commission_credit?: number | undefined;
+    commission_debit?: number | undefined;
+    confirm_phone?: string | undefined;
+    create_date?: string | undefined;
+    currency?: string | undefined;
+    currency_credit?: string | undefined;
+    currency_debit?: string | undefined;
+    description?: string | undefined;
+    end_date?: string | undefined;
+    info?: string | undefined;
+    ip?: string | undefined;
+    is_3ds?: string | boolean | undefined;
+    language?: string | undefined;
+    liqpay_order_id?: string | undefined;
+    moment_part?: string | undefined;
+    mpi_eci?: number | undefined;
+    order_id?: string | undefined;
+    payment_id?: number | undefined;
+    paytype?: string | undefined;
+    public_key?: string | undefined;
+    receiver_commission?: number | undefined;
+    result?: string | undefined;
+    rrn_credit?: string | undefined;
+    rrn_debit?: string | undefined;
+    sender_bonus?: number | undefined;
+    sender_card_bank?: string | undefined;
+    sender_card_country?: string | undefined;
+    sender_card_mask2?: string | undefined;
+    sender_iban?: string | undefined;
+    sender_card_type?: string | undefined;
+    sender_commission?: number | undefined;
+    sender_first_name?: string | undefined;
+    sender_last_name?: string | undefined;
+    sender_phone?: string | undefined;
+    status?: string | undefined;
+    wait_reserve_status?: string | boolean | undefined;
+    transaction_id?: number | undefined;
+    type?: string | undefined;
+    version?: number | undefined;
+}>>;
+export type LiqPayPaymentStatusResponse = z.infer<typeof LiqPayPaymentStatusResponseSchema>;

package/dist/core/schemas/payment-status/payment-status-response.schema.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LiqPayPaymentStatusResponseSchema = exports.LiqPayRawPaymentStatusResponseSchema = void 0;
+const ts_case_convert_1 = require("ts-case-convert");
+const zod_1 = require("zod");
+const utils_1 = require("../../utils");
+const enums_1 = require("../common/enums");
+// TODO: check for optional fields on real api responses
+exports.LiqPayRawPaymentStatusResponseSchema = zod_1.z.object({
+    acq_id: zod_1.z.number().optional(),
+    action: zod_1.z.string().optional(),
+    agent_commission: zod_1.z.number().optional(),
+    amount: zod_1.z.number().optional(),
+    amount_bonus: zod_1.z.number().optional(),
+    amount_credit: zod_1.z.number().optional(),
+    amount_debit: zod_1.z.number().optional(),
+    authcode_credit: zod_1.z.string().optional(),
+    authcode_debit: zod_1.z.string().optional(),
+    bonus_procent: zod_1.z.number().optional(),
+    bonus_type: zod_1.z.string().optional(),
+    card_token: zod_1.z.string().optional(),
+    commission_credit: zod_1.z.number().optional(),
+    commission_debit: zod_1.z.number().optional(),
+    confirm_phone: zod_1.z.string().optional(),
+    create_date: zod_1.z.string().optional(),
+    currency: zod_1.z.string().optional(),
+    currency_credit: zod_1.z.string().optional(),
+    currency_debit: zod_1.z.string().optional(),
+    description: zod_1.z.string().optional(),
+    end_date: zod_1.z.string().optional(),
+    info: zod_1.z.string().optional(),
+    ip: zod_1.z.string().optional(),
+    is_3ds: zod_1.z.union([zod_1.z.string(), zod_1.z.boolean()]).optional(),
+    language: zod_1.z.string().optional(),
+    liqpay_order_id: zod_1.z.string().optional(),
+    moment_part: zod_1.z.string().optional(),
+    mpi_eci: zod_1.z.number().optional(),
+    order_id: zod_1.z.string().optional(),
+    payment_id: zod_1.z.number().optional(),
+    paytype: zod_1.z.string().optional(),
+    public_key: zod_1.z.string().optional(),
+    receiver_commission: zod_1.z.number().optional(),
+    result: zod_1.z.string().optional(),
+    rrn_credit: zod_1.z.string().optional(),
+    rrn_debit: zod_1.z.string().optional(),
+    sender_bonus: zod_1.z.number().optional(),
+    sender_card_bank: zod_1.z.string().optional(),
+    sender_card_country: zod_1.z.string().optional(),
+    sender_card_mask2: zod_1.z.string().optional(),
+    sender_iban: zod_1.z.string().optional(),
+    sender_card_type: zod_1.z.string().optional(),
+    sender_commission: zod_1.z.number().optional(),
+    sender_first_name: zod_1.z.string().optional(),
+    sender_last_name: zod_1.z.string().optional(),
+    sender_phone: zod_1.z.string().optional(),
+    status: zod_1.z.string().optional(),
+    wait_reserve_status: zod_1.z.union([zod_1.z.string(), zod_1.z.boolean()]).optional(),
+    transaction_id: zod_1.z.number().optional(),
+    type: zod_1.z.string().optional(),
+    version: zod_1.z.number().optional(),
+});
+exports.LiqPayPaymentStatusResponseSchema = exports.LiqPayRawPaymentStatusResponseSchema.transform(raw => {
+    const camelized = (0, ts_case_convert_1.objectToCamel)(raw);
+    return {
+        ...camelized,
+        action: camelized.action && enums_1.LiqPayActionSchema.parse(camelized.action),
+        bonusType: camelized.bonusType && enums_1.LiqPayBonusTypeSchema.parse(camelized.bonusType),
+        createDate: (0, utils_1.parseDate)(camelized.createDate),
+        currency: camelized.currency && enums_1.LiqPayCurrencySchema.parse(camelized.currency),
+        currencyCredit: camelized.currencyCredit &&
+            enums_1.LiqPayCurrencySchema.parse(camelized.currencyCredit),
+        currencyDebit: camelized.currencyDebit &&
+            enums_1.LiqPayCurrencySchema.parse(camelized.currencyDebit),
+        endDate: (0, utils_1.parseDate)(camelized.endDate),
+        is3ds: (0, utils_1.parseBool)(camelized.is3ds),
+        language: camelized.language && enums_1.LiqPayLanguageSchema.parse(camelized.language),
+        momentPart: (0, utils_1.parseBool)(camelized.momentPart),
+        mpiEci: camelized.mpiEci && enums_1.LiqPayMpiEciSchema.parse(camelized.mpiEci),
+        paytype: camelized.paytype && enums_1.LiqPayPaytypeSchema.parse(camelized.paytype),
+        result: camelized.result && enums_1.LiqPayRequestResultSchema.parse(camelized.result),
+        status: camelized.status && enums_1.LiqPayPaymentStatusSchema.parse(camelized.status),
+        waitReserveStatus: (0, utils_1.parseBool)(camelized.waitReserveStatus),
+        version: camelized.version && enums_1.LiqPayVersionSchema.parse(camelized.version),
+    };
+});

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

@@ -0,0 +1,250 @@
+import { LiqPayAction, LiqPayCurrency, LiqPayMpiEci, LiqPayPaymentStatus, LiqPayPaytype } from './types';
+/**
+ * Contract of decoded format of API parameters received in a request from LiqPay after payment
+ */
+export interface LiqPayCheckoutCallback {
+    /**
+     * Acquirer ID
+     */
+    acq_id: number;
+    /**
+     * Operation type. Possible values:
+     * - `pay` - payment
+     * - `hold` - blocking of funds on the sender's account
+     * - `subscribe` - creation of a regular payment
+     * - `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;
+    /**
+     * Transaction amount debit in currency `currency_debit`
+     */
+    amount_debit: number;
+    /**
+     * Authorization code for credit transaction
+     */
+    authcode_credit: string;
+    /**
+     * Authorization code for debit transaction
+     */
+    authcode_debit: string;
+    /**
+     * Sender card token
+     */
+    card_token: string;
+    /**
+     * Recipient fee in `currency_credit` currency
+     */
+    commission_credit: number;
+    /**
+     * Sender fee in `currency_debit`
+     */
+    commission_debit: number;
+    /**
+     * Date of debiting funds
+     */
+    completion_date: Date;
+    /**
+     * Payment creation date
+     */
+    create_date: Date;
+    /**
+     * Payment currency
+     */
+    currency: LiqPayCurrency;
+    /**
+     * Transaction currency credit
+     */
+    currency_credit: LiqPayCurrency;
+    /**
+     * Transaction currency debit
+     */
+    currency_debit: LiqPayCurrency;
+    /**
+     * A unique user identifier on the merchant's website. Maximum length __100__ characters.
+     */
+    customer: string;
+    /**
+     * Payment comment
+     */
+    description: string;
+    /**
+     * Payment completion/change date
+     */
+    end_date: Date;
+    /**
+     * Error code
+     */
+    err_code: string;
+    /**
+     * Error description
+     */
+    err_description: string;
+    /**
+     * Additional payment information
+     */
+    info: string;
+    /**
+     * Sender IP address
+     */
+    ip: string;
+    /**
+     * Represents whether 3D-Secure verification was performed during payment. Possible values: `true` - the transaction went through with 3DS verification, `false` - the transaction went through without 3DS verification
+     */
+    is_3ds: boolean;
+    /**
+     * `Order_id` of payment in the LiqPay system
+     */
+    liqpay_order_id: string;
+    /**
+     * Code that represents whether 3D-Secure verification was performed during payment. 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;
+    /**
+     * Link to which the client must be redirected to complete 3DS verification
+     */
+    redirect_to: string;
+    /**
+     * Date of last payment refund
+     */
+    refund_date_last: Date;
+    /**
+     * 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;
+    /**
+     * Payment Token
+     */
+    token: string;
+    /**
+     * Payment type
+     */
+    type: string;
+    /**
+     * API version. Current value is `7`
+     */
+    version: 7;
+    /**
+     * Error code
+     */
+    err_erc: string;
+    /**
+     * Product category
+     */
+    product_category: string;
+    /**
+     * Product description
+     */
+    product_description: string;
+    /**
+     * Product name
+     */
+    product_name: string;
+    /**
+     * Product page address
+     */
+    product_url: string;
+    /**
+     * Refund amount
+     */
+    refund_amount: number;
+    /**
+     * Verification code
+     */
+    verifycode?: string;
+}

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

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