@spreeloop/orange_money
Version:
A orange money api integration package
45 lines • 2.18 kB
TypeScript
import { OrangeMoneyPaymentConfigs } from '../utils/joi_schema';
import { OrangeMoneyPaymentInterface } from '../payments';
import { Routes } from '../routes/routes';
import { GetAccessTokenResponse, GetOrangeMoneyPaymentRequest, GetOrangeMoneyPaymentResponse, GetPayTokenResponse, InitializeOrangeMoneyRequest, InitializeOrangeMoneyResponse } from '../utils/request_model';
/**
* Implements the orange money live payment.
*/
export declare class OrangeMoneyPaymentLive implements OrangeMoneyPaymentInterface {
protected readonly config: OrangeMoneyPaymentConfigs;
protected readonly route: Routes;
/**
* Creates a new instance of the PaymentConfig class.
*
* @param {PaymentConfig} config - The configuration for the PaymentConfig instance.
*/
constructor(config: OrangeMoneyPaymentConfigs);
/**
* Gets a pay token using the provided access token.
*
* @param {string} accessToken - The access token used to create the pay token.
* @return {Promise<GetPayTokenResponse>} A promise that resolves to the pay token response.
*/
getPayToken(accessToken: string): Promise<GetPayTokenResponse>;
/**
* Gets an access token.
*
* @return {Promise<GetAccessTokenResponse>} the access token response
*/
getAccessToken(): Promise<GetAccessTokenResponse>;
/**
* Initializes the orange money payment.
*
* @param {InitializeOrangeMoneyRequest} mobileInitParams - Parameters for mobile initialization
* @return {Promise<InitializeOrangeMoneyResponse>} A promise that resolves with the mobile payment initialization response
*/
initializeOrangeMoneyPayment(mobileInitParams: InitializeOrangeMoneyRequest): Promise<InitializeOrangeMoneyResponse>;
/**
* Gets the status of a payment.
*
* @param {GetOrangeMoneyPaymentRequest} checkStatusParams - The parameters for checking the status.
* @return {Promise<GetOrangeMoneyPaymentResponse>} The response containing the payment status.
*/
getOrangeMoneyPaymentStatus(checkStatusParams: GetOrangeMoneyPaymentRequest): Promise<GetOrangeMoneyPaymentResponse>;
}
//# sourceMappingURL=live.d.ts.map