UNPKG

@mnpay/qpay

Version:
61 lines (60 loc) 3.92 kB
import { type QpayConfig } from './types'; export * from './constants'; export * from './types'; /** * https://developer.qpay.mn * QPay төлбөрийн үйлчилгээнд өөрийн үйлчилгээг холбон төлбөр тооцоогоо * худалдан QPay QR кодоор авах боломжыг мерчантуудад олгох зорилготой бүтээгдсэн платформ юм. * Мерчант өөрийн бүтээгдэхүүн үйлчилгээг дараах алхмын дагуу QPay системд нэмэх боломжтой. * Бидэнтэй холбогдож ID болон OAuth 2.0 (clientID, хэрэглэгчийн нууц үг) нууцлалаа авна. (Холбоо барих имэйл хаяг: info@qpay.mn) */ export declare const useQpay: (config: QpayConfig) => { api: import("axios").AxiosInstance; /** * #### Токен авах хүсэлт * Access token авах API. * `{ username: client_id, password: client_secret }`-ийг qPay -ээс авна. */ authenticate: (data: import("./types").AuthenticateParams) => Promise<import("axios").AxiosResponse<import("./types").AuthenticateResponse, any>>; /** * #### Access token шинэчлэн авах API. * refresh_token -ийг ашиглана. */ refreshToken: (data: import("./types").RefreshRequestParams) => Promise<import("axios").AxiosResponse<import("./types").RefreshResponse, any>>; /** * #### Төлбөрийн нэхэмжлэл үүсгэх. * `invoice_code` -ийг qPay -ээс олгоно. */ createInvoice: (data: import("./types").CreateInvoiceRequestParams) => Promise<import("axios").AxiosResponse<import("./types").InvoiceResponse, any>>; /** * #### Үүсгэсэн нэхэмжлэлийн мэдээллийг харах * Query Parameter -д qPay invoice_id -ийг илгээнэ. */ getInvoice: (data: import("./types").GetOrCancelInvoiceRequestParams) => Promise<import("axios").AxiosResponse<import("./types").InvoiceResponse, any>>; /** * #### Төлбөрийн нэхэмжлэл цуцлах * Query Parameter -д qPay invoice_id -ийг илгээнэ. */ cancelInvoice: (data: import("./types").GetOrCancelInvoiceRequestParams) => Promise<import("axios").AxiosResponse<import("./types").InvoiceResponse, any>>; /** * #### Үүсгэсэн нэхэмжлэлийн мэдээллийг харах * Query Parameter -д qPay payment_id -ийг илгээнэ. */ getPayment: (data: import("./types").PaymentGetRequestParams) => Promise<import("axios").AxiosResponse<import("./types").PaymentGetResponse, any>>; /** * #### Төлбөр төлөгдсөн эсэхийг шалгах * Нэхэмжлэлийн төлбөр шалгах бол object_type=INVOICE */ checkPayment: (data: import("./types").PaymentCheckRequestParams) => Promise<import("axios").AxiosResponse<import("./types").PaymentCheckResponse, any>>; /** * #### Төлбөрийг цуцлах * Query Parameter -д qPay payment_id -ийг илгээнэ. */ cancelPayment: (data: import("./types").PaymentCancelRequestParams) => Promise<import("axios").AxiosResponse<import("./types").PaymentCancelResponse, any>>; refundPayment: (data: import("./types").PaymentCancelRequestParams) => Promise<import("axios").AxiosResponse<import("./types").PaymentCancelResponse, any>>; /** * #### Төлбөр төлөлтийн жагсаалт авах * customer_id, card_terminal_id, p2p_terminal_id -ийн мэдээллийг qPay merchant web admin-аас эсвэл qPay -ээс авна. */ getPaymentList: (data: import("./types").PaymentListRequestParams) => Promise<import("axios").AxiosResponse<import("./types").PaymentListResponse, any>>; };