@spreeloop/mtn_momo
Version:
A mtn momo api integration package
59 lines • 1.64 kB
TypeScript
import { TargetEnvironment } from "../../utils/constants";
/**
* Mtn Momo API routes builder.
* @class
*/
export declare class Routes {
private baseUrl;
/**
* Creates a new instance of the class route.
*
* @param {string} targetEnvironment - The optional target environment.
*/
constructor(targetEnvironment?: TargetEnvironment);
/**
* Returns the base route for the API.
*
* @return {string} The base route for the API.
*/
baseRoute: () => string;
/**
* Initializes the payment.
*
* @return {string} The endpoint URL for the payment.
*/
initPayment(): string;
/**
* Generates the payment status URL based on the provided parameters.
*
* @param {object} params - The parameters for generating the payment status URL.
* - {string} params.referenceId - The reference id.
* @return {string} The payment status URL.
*/
paymentStatus(params: {
referenceId: string;
}): string;
/**
* Generates the access token endpoint.
*
* @return {string} The access token endpoint.
*/
accessToken(): string;
/**
* Generates the api user endpoint.
*
* @return {string} The api user endpoint.
*/
apiUser(): string;
/**
* Generates the api key endpoint.
*
* @param {object} params - The parameters for generating the api key URL.
* - {string} params.referenceId - The reference id.
* @return {string} The api key endpoint.
*/
apiKey(params: {
referenceId: string;
}): string;
}
//# sourceMappingURL=routes.d.ts.map