UNPKG

@tashie/mpesa-sdk

Version:

Mpesa sdk based on daraja 3.0 for the nodejs lovers

32 lines (31 loc) 1.9 kB
import { AccountBalanceQueryConfig, AuthResponse, B2CTransactionConfig, ClientConfig, DynamicQRCodeQuery, DynamicQRCodeResponse, STKQuery, TransactionStatusQuery, APIResponseSuccessType, UrlRegisterConfig, InitiateReversalQuery, RemittTaxQuery, B2BPaymentQuery, StandingOrderCreationQuery } from "../interfaces"; export declare class Mpesa { private readonly config; private BASE_URL; private token; constructor(configs: ClientConfig); /** * Retrieves an access token with a set expiry date * @returns */ getAccessToken(): Promise<AuthResponse>; /** * C2B Operations */ registerUrls(registerParams: UrlRegisterConfig): Promise<any>; B2C(b2cTransaction: B2CTransactionConfig): Promise<any>; getAccountBalance(balanceQuery: AccountBalanceQueryConfig): Promise<any>; sendSTKPush(stkQuery: STKQuery): Promise<any>; generateDynamicQRCode(dynamicQRCodeQuery: DynamicQRCodeQuery): Promise<DynamicQRCodeResponse>; getTransactionStatus(transactionStatusQuery: TransactionStatusQuery): Promise<APIResponseSuccessType>; initiateReversal(initiateReversalQuery: InitiateReversalQuery): Promise<APIResponseSuccessType>; remittTax(remittTaxQuery: RemittTaxQuery): Promise<APIResponseSuccessType>; initiateB2BPayment(b2bPaymentQuery: B2BPaymentQuery): Promise<APIResponseSuccessType>; /** * This API is intended for businesses who wish to integrate with standing orders for the automation of recurring revenue collection. * This is a commercial API and will require communication with the safaricom team to enable the M-pesa Ratiba product. * @param {StandingOrderCreationQuery} standingOrderCreationQuery - The query to create a standing order * @returns The response from the API */ createStandingOrder(standingOrderCreationQuery: StandingOrderCreationQuery): Promise<APIResponseSuccessType>; }