liqpay-nestjs 0.3.2 → 0.3.4

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

@@ -110,7 +110,7 @@ export interface CheckoutCallback {
     /**
      * `Order_id` of payment in the LiqPay system
      */
-    _order_id: string;
+    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)
@@ -172,7 +172,7 @@ export interface CheckoutCallback {
      */
     sender_card_country: string;
     /**
-     * Sender's card
+     * Sender's card mask
      */
     sender_card_mask2: string;
     /**

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

@@ -113,7 +113,7 @@ export interface PaymentStatusResponse {
     /**
      * `Order_id` of payment in the LiqPay system
      */
-    _order_id: string;
+    liqpay_order_id: string;
     /**
      * Payment in installments sign
      */

package/dist/core/clients/payments.client.d.ts

@@ -1,14 +1,15 @@
 import { Result } from '../types/base';
 import { CheckoutInput } from '../types/checkout';
-import { Action } from '../types/common/enums';
-import { PaymentStatusResponse } from '../types/payment-status';
+import { CheckoutAction } from '../types/common/enums';
+import { PaymentStatusInput, PaymentStatusResponse } from '../types/payment-status';
 import { UtilsClient } from './utils.client';
 export declare class PaymentsClient {
     private readonly utils;
     constructor(utils: UtilsClient);
     private prepare;
     private buildUrl;
-    pay(payload: CheckoutInput): {
+    private checkout;
+    getCheckoutUrl(payload: CheckoutInput): {
         url: string;
         data: string;
         signature: string;
@@ -16,8 +17,6 @@ export declare class PaymentsClient {
         currency: "USD" | "EUR" | "UAH";
         description: string;
         orderId: string;
-        cardToken?: string | undefined;
-        ip?: string | undefined;
         fiscalData?: {
             items?: ({
                 amount: number;
@@ -108,7 +107,7 @@ export declare class PaymentsClient {
         productUrl?: string | undefined;
         version: import("../types/common/enums").LiqPayVersion;
         publicKey: string;
-        action: Action;
+        action: CheckoutAction;
     };
     hold(payload: CheckoutInput): {
         url: string;
@@ -118,8 +117,6 @@ export declare class PaymentsClient {
         currency: "USD" | "EUR" | "UAH";
         description: string;
         orderId: string;
-        cardToken?: string | undefined;
-        ip?: string | undefined;
         fiscalData?: {
             items?: ({
                 amount: number;
@@ -210,7 +207,7 @@ export declare class PaymentsClient {
         productUrl?: string | undefined;
         version: import("../types/common/enums").LiqPayVersion;
         publicKey: string;
-        action: Action;
+        action: CheckoutAction;
     };
     subscribe(payload: CheckoutInput): {
         url: string;
@@ -220,8 +217,6 @@ export declare class PaymentsClient {
         currency: "USD" | "EUR" | "UAH";
         description: string;
         orderId: string;
-        cardToken?: string | undefined;
-        ip?: string | undefined;
         fiscalData?: {
             items?: ({
                 amount: number;
@@ -312,8 +307,8 @@ export declare class PaymentsClient {
         productUrl?: string | undefined;
         version: import("../types/common/enums").LiqPayVersion;
         publicKey: string;
-        action: Action;
+        action: CheckoutAction;
     };
-    getPayButton(payload: CheckoutInput, buttonText?: string, buttonColor?: string): string;
-    getStatus(orderId: string): Promise<Result<PaymentStatusResponse>>;
+    getCheckoutButton(payload: CheckoutInput, buttonText?: string, buttonColor?: string): string;
+    getStatus(payload: PaymentStatusInput): Promise<Result<PaymentStatusResponse>>;
 }

package/dist/core/clients/payments.client.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PaymentsClient = void 0;
 const checkout_1 = require("../types/checkout");
+const common_1 = require("../types/common");
 const payment_status_1 = require("../types/payment-status");
-const url_type_1 = require("../url.type");
 class PaymentsClient {
     utils;
     constructor(utils) {
@@ -23,9 +23,18 @@ class PaymentsClient {
         return { fullfilled, data, signature };
     }
     buildUrl(data, signature) {
-        return `${url_type_1.CHECKOUT_URL}?data=${data}&signature=${signature}`;
+        return `${common_1.CHECKOUT_URL}?data=${data}&signature=${signature}`;
     }
-    pay(payload) {
+    checkout(payload, action) {
+        const { fullfilled, data, signature } = this.prepare(payload, action);
+        return {
+            ...fullfilled,
+            url: this.buildUrl(data, signature),
+            data,
+            signature,
+        };
+    }
+    getCheckoutUrl(payload) {
         const { fullfilled, data, signature } = this.prepare(payload, 'pay');
         return {
             ...fullfilled,
@@ -55,10 +64,10 @@ class PaymentsClient {
             signature,
         };
     }
-    getPayButton(payload, buttonText = 'Pay', buttonColor = '#77CC5D') {
+    getCheckoutButton(payload, buttonText = 'Pay', buttonColor = '#77CC5D') {
         const { data, signature } = this.prepare(payload, 'pay');
         return `
-      <form method="POST" action="${url_type_1.CHECKOUT_URL}" accept-charset="utf-8">
+      <form method="POST" action="${common_1.CHECKOUT_URL}" accept-charset="utf-8">
         <input type="hidden" name="data" value="${data}" />
         <input type="hidden" name="signature" value="${signature}" />
         <script type="text/javascript" src="https://static.liqpay.ua/libjs/sdk_button.js"></script>
@@ -66,8 +75,14 @@ class PaymentsClient {
       </form>
     `;
     }
-    async getStatus(orderId) {
-        return await this.utils.call({ action: 'status', orderId }, payment_status_1.RawPaymentStatusRequestSchema, payment_status_1.PaymentStatusResponseSchema, url_type_1.REQUEST_URL);
+    async getStatus(payload) {
+        const request = {
+            ...payload,
+            action: 'status',
+            version: 7,
+            publicKey: this.utils.publicKey,
+        };
+        return await this.utils.call(request, payment_status_1.RawPaymentStatusRequestSchema, payment_status_1.PaymentStatusResponseSchema, common_1.REQUEST_URL);
     }
 }
 exports.PaymentsClient = PaymentsClient;

package/dist/core/types/checkout/{checkout-callback.schema.d.ts → checkout.callback.d.ts}

@@ -1,8 +1,11 @@
 import { z } from 'zod';
+/**
+ * Contract of decoded format of API parameters received in a request from LiqPay after payment
+ */
 export declare const RawCheckoutCallbackSchema: z.ZodObject<{
     version: z.ZodOptional<z.ZodNumber>;
     public_key: z.ZodOptional<z.ZodString>;
-    acq_id: z.ZodOptional<z.ZodNumber>;
+    acq_id: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
     action: z.ZodOptional<z.ZodString>;
     agent_commission: z.ZodOptional<z.ZodNumber>;
     amount: z.ZodOptional<z.ZodNumber>;
@@ -27,10 +30,10 @@ export declare const RawCheckoutCallbackSchema: z.ZodObject<{
     info: z.ZodOptional<z.ZodString>;
     ip: z.ZodOptional<z.ZodString>;
     is_3ds: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>;
-    _order_id: z.ZodOptional<z.ZodString>;
+    liqpay_order_id: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
     mpi_eci: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
-    order_id: z.ZodOptional<z.ZodString>;
-    payment_id: z.ZodOptional<z.ZodNumber>;
+    order_id: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    payment_id: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
     paytype: z.ZodOptional<z.ZodString>;
     receiver_commission: z.ZodOptional<z.ZodNumber>;
     redirect_to: z.ZodOptional<z.ZodString>;
@@ -60,10 +63,13 @@ export declare const RawCheckoutCallbackSchema: z.ZodObject<{
     verifycode: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type RawCheckoutCallback = z.infer<typeof RawCheckoutCallbackSchema>;
+/**
+ * Contract of decoded format of API parameters received in a request from LiqPay after payment
+ */
 export declare const CheckoutCallbackSchema: z.ZodPipe<z.ZodObject<{
     version: z.ZodOptional<z.ZodNumber>;
     public_key: z.ZodOptional<z.ZodString>;
-    acq_id: z.ZodOptional<z.ZodNumber>;
+    acq_id: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
     action: z.ZodOptional<z.ZodString>;
     agent_commission: z.ZodOptional<z.ZodNumber>;
     amount: z.ZodOptional<z.ZodNumber>;
@@ -88,10 +94,10 @@ export declare const CheckoutCallbackSchema: z.ZodPipe<z.ZodObject<{
     info: z.ZodOptional<z.ZodString>;
     ip: z.ZodOptional<z.ZodString>;
     is_3ds: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodBoolean]>>;
-    _order_id: z.ZodOptional<z.ZodString>;
+    liqpay_order_id: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
     mpi_eci: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
-    order_id: z.ZodOptional<z.ZodString>;
-    payment_id: z.ZodOptional<z.ZodNumber>;
+    order_id: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    payment_id: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
     paytype: z.ZodOptional<z.ZodString>;
     receiver_commission: z.ZodOptional<z.ZodNumber>;
     redirect_to: z.ZodOptional<z.ZodString>;
@@ -120,22 +126,95 @@ export declare const CheckoutCallbackSchema: z.ZodPipe<z.ZodObject<{
     refund_amount: z.ZodOptional<z.ZodNumber>;
     verifycode: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, z.ZodTransform<Partial<{
+    /**
+     * API version. Current value is `7`
+     */
     version: 7 | undefined;
+    /**
+     * Acquirer ID
+     */
     acqId: string | undefined;
-    action: "pay" | "paytoken" | "hold" | "paysplit" | "subscribe" | "paydonate" | "auth" | "regular" | "status" | undefined;
+    /**
+     * 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: "pay" | "hold" | "subscribe" | "regular" | undefined;
+    /**
+     * Date of debiting funds
+     */
     completionDate: Date | undefined;
+    /**
+     * Payment creation date
+     */
     createDate: Date | undefined;
+    /**
+     * Payment currency
+     */
     currency: "USD" | "EUR" | "UAH" | undefined;
+    /**
+     * Transaction currency credit
+     */
     currencyCredit: "USD" | "EUR" | "UAH" | undefined;
+    /**
+     * Transaction currency debit
+     */
     currencyDebit: "USD" | "EUR" | "UAH" | undefined;
+    /**
+     * Payment completion/change date
+     */
     endDate: Date | undefined;
+    /**
+     * Error code
+     */
     errCode: "5" | "limit" | "frod" | "decline" | "err_auth" | "err_cache" | "user_not_found" | "err_sms_send" | "err_sms_otp" | "shop_blocked" | "shop_not_active" | "invalid_signature" | "order_id_empty" | "err_shop_not_agent" | "err_card_def_notfound" | "err_no_card_token" | "err_card_liqpay_def" | "err_card_type" | "err_card_country" | "err_limit_amount" | "err_payment_amount_limit" | "amount_limit" | "payment_err_sender_card" | "payment_processing" | "err_payment_discount" | "err_wallet" | "err_get_verify_code" | "err_verify_code" | "wait_info" | "err_path" | "err_payment_cash_acq" | "err_split_amount" | "err_card_receiver_def" | "payment_err_status" | "public_key_not_found" | "payment_not_found" | "payment_not_subscribed" | "wrong_amount_currency" | "err_amount_hold" | "err_access" | "order_id_duplicate" | "err_blocked" | "err_empty" | "err_empty_phone" | "err_missing" | "err_wrong" | "err_wrong_currency" | "err_phone" | "err_card" | "err_card_bin" | "err_terminal_notfound" | "err_commission_notfound" | "err_payment_create" | "err_mpi" | "err_currency_is_not_allowed" | "err_look" | "err_mods_empty" | "payment_err_type" | "err_payment_currency" | "err_payment_exchangerates" | "err_signature" | "err_api_action" | "err_api_callback" | "err_api_ip" | "expired_phone" | "expired_3ds" | "expired_otp" | "expired_cvv" | "expired_p24" | "expired_sender" | "expired_pin" | "expired_ivr" | "expired_captcha" | "expired_password" | "expired_senderapp" | "expired_prepared" | "expired_mp" | "expired_qr" | "90" | "101" | "102" | "103" | "104" | "105" | "106" | "107" | "108" | "109" | "110" | "111" | "112" | "113" | "114" | "115" | "2903" | "2915" | "3914" | "9851" | "9852" | "9854" | "9855" | "9857" | "9859" | "9860" | "9861" | "9863" | "9867" | "9868" | "9872" | "9882" | "9886" | "9961" | "9989" | undefined;
+    /**
+     * 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
+     */
     is3ds: boolean | undefined;
+    /**
+     * `Order_id` of payment in the LiqPay system
+     */
+    liqpayOrderId: string | undefined;
+    /**
+     * 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
+     */
     mpiEci: "5" | "6" | "7" | undefined;
+    /**
+     * Payment `OrderId`
+     */
+    orderId: string | undefined;
+    /**
+     * Payment ID in the LiqPay system
+     */
     paymentId: string | undefined;
-    paytype: "apay" | "gpay" | "card" | "privat24" | "masterpass" | "moment_part" | "paypart" | "cash" | "invoice" | "qr" | undefined;
+    /**
+     * Payment method. Possible values:
+     * - `card` - payment by card
+     * - `privat24` - through the Privat24 account
+     * - `masterpass` - through the Masterpass account
+     * - `moment_part` - installment
+     * - `cash` - by cash
+     * - `invoice` - invoice to e-mail
+     * - `qr` - by scanning qr code
+     */
+    paytype: "card" | "privat24" | "masterpass" | "moment_part" | "cash" | "invoice" | "qr" | undefined;
+    /**
+     * Date of last payment refund
+     */
     refundDateLast: Date | undefined;
+    /**
+     * Payment status
+     */
     status: "error" | "failure" | "reversed" | "subscribed" | "success" | "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;
+    /**
+     * 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
+     */
     waitReserveStatus: boolean | undefined;
     publicKey?: string | undefined;
     agentCommission?: number | undefined;
@@ -153,8 +232,6 @@ export declare const CheckoutCallbackSchema: z.ZodPipe<z.ZodObject<{
     errDescription?: string | undefined;
     info?: string | undefined;
     ip?: string | undefined;
-    OrderId?: string | undefined;
-    orderId?: string | undefined;
     receiverCommission?: number | undefined;
     redirectTo?: string | undefined;
     rrnCredit?: string | undefined;
@@ -181,7 +258,7 @@ export declare const CheckoutCallbackSchema: z.ZodPipe<z.ZodObject<{
 }>, {
     version?: number | undefined;
     public_key?: string | undefined;
-    acq_id?: number | undefined;
+    acq_id?: string | number | undefined;
     action?: string | undefined;
     agent_commission?: number | undefined;
     amount?: number | undefined;
@@ -206,10 +283,10 @@ export declare const CheckoutCallbackSchema: z.ZodPipe<z.ZodObject<{
     info?: string | undefined;
     ip?: string | undefined;
     is_3ds?: string | boolean | undefined;
-    _order_id?: string | undefined;
+    liqpay_order_id?: string | number | undefined;
     mpi_eci?: string | number | undefined;
-    order_id?: string | undefined;
-    payment_id?: number | undefined;
+    order_id?: string | number | undefined;
+    payment_id?: string | number | undefined;
     paytype?: string | undefined;
     receiver_commission?: number | undefined;
     redirect_to?: string | undefined;
@@ -238,4 +315,7 @@ export declare const CheckoutCallbackSchema: z.ZodPipe<z.ZodObject<{
     refund_amount?: number | undefined;
     verifycode?: string | undefined;
 }>>;
+/**
+ * Contract of decoded format of API parameters received in a request from LiqPay after payment
+ */
 export type CheckoutCallback = z.infer<typeof CheckoutCallbackSchema>;