@mnpay/hipay
Version:
68 lines (67 loc) • 4.92 kB
TypeScript
import { type GetAccessTokenParams, type GetAccessTokenParamsApi } from './types';
import { type HipayConfig } from './definitions';
export * from './types';
export * from './helpers';
export * from './configs';
export * from './constants';
export * from './lib';
export * from './errors';
export declare const createHipay: (config: HipayConfig) => {
/**
* Хандалтын токен авах (get auth token)
* Байгууллага системд хандахдаа хамгийн түрүүнд хийх үйлдэл гэж ойлгож болно.
* Уг хүсэлтийн хариунд ирсэн хандалтын токений (access_token) тусламжтай дараа
* дараагийн үйлдлийг хийх боломжтой болно.
*/
getAccessToken: (params?: GetAccessTokenParams) => Promise<import("./types").HipayAccessTokenResponseSuccess>;
/**
* Хандалтын токен дуудаж хадгалах. Нэг дуудсан тохиолдолд дахиж дуудах шаардлагагүй.
* Байгууллага системд хандахдаа хамгийн түрүүнд хийх үйлдэл гэж ойлгож болно.
* Уг хүсэлтийн хариунд ирсэн хандалтын токений (access_token) тусламжтай дараа
* дараагийн үйлдлийг хийх боломжтой болно.
*/
loadAccessToken: (params?: GetAccessTokenParamsApi) => Promise<{
access_token: string;
expires: string;
} | undefined>;
/**
* Карт лавлах (Get card)
* Карт нэмэх хүсэлт амжилттай болсоны дараагаар тухайн карт бүртгэлийн дугаараар картын дэлгэрэнгүй мэдээллийг авна.
*/
getCard: (params: import("./types").CardGetParams) => Promise<import("./types").HipayCardGetResponseSuccess>;
/** Карт нэмэх (Card add)
* Картын бүртгэлийн дугаар авах хүсэлт.
* хүсэлтээс ирсэн {initId} утгаар форм авна.
* Карт нэмэх хүсэлтийг дуудах Hi-Pay-ийн карт нэмэх цонх гарч ирэх бөгөөд тус цонхны тусламжтай
* картын мэдээллийг оруулж и-пин кодоор баталгаажуулсны дараа карт нэмэгдэнэ. */
addCard: (params: import("./types").CardAddParams) => Promise<import("./types").HipayCardAddResponseSuccess>;
/**
* Карт хасах (Remove card)
* Hipay системээр үүсгүүлсэн картын токенийг устгах зориулалттай.
*/
removeCard: (params: import("./types").CardRemoveParams) => Promise<import("./types").HipayResponseSuccess>;
/**
* Төлбөрийн нэхэмжлэх үүсгэх (Checkout)
* Байгууллагын программаас барааны мэдээлэл болон худалдан авалтын мэдээллүүдийг Hi-Pay-руу илгээнэ.
* Checkout сервисийг дуудахад амжилттай болсон тохиолдолд checkoutId (дахин давтагдахгүй) дугаар
* буцаах бөгөөд уг дугаараар төлбөрийн гүйлгээ хийх хүсэлтийг илгээнэ.
* Жич. Checkout утгыг Order буюу захиалга, нэхэмжлэх гэж ойлгоно.
* @param {'MNT' | 'USD'} params.currency - default value = MNT
*/
checkout: (params: import("./types").CheckoutParams) => Promise<import("./types").HipayCheckoutResponseSuccess>;
/**
* Төлбөр нэхэмжлэх лавлах (get checkout)
* Тухайн төлбөр төлөгдсөн эсэхийг нэхэмжлэхийн дугаар ашиглан лавлах
* @param {string} params.checkoutId - Нэхэмжлэхийн (checkout) дугаар
*/
getCheckout: (params: import("./types").GetCheckoutParams) => Promise<import("./types").HipayGetCheckoutResponseSuccess>;
/**
* Төлбөрийн гүйлгээ хийх (Payment)
* Төлбөрийн гүйлгээ хийх хүсэлтэд өмнө нь үүсгэсэн төлбөрийн нэхэмжлэхийг (checkout) төлөх үйлдэл хийгдэнэ.
* Төлбөрийн гүйлгээний хүсэлтэд ашиглагдах токен талбарт Байгууллагын токен-ийг байршуулж ашиглана.
*/
payment: (params: import("./types").PaymentParams) => Promise<import("./types").HipayPaymentResponseSuccess>;
/** Hi-Pay-ийн карт нэмэх цонх */
getCardAddFormUrl: () => string;
resetToken: () => void;
};