code-coast-momo-api/lib/common.d.ts

MTN Mobile Money API Client for NodeJS written in TypeScript

export declare type Config = GlobalConfig & ProductConfig;
export declare type ProductConfig = SubscriptionConfig & UserConfig;
export interface GlobalConfig {
    /**
     * The provider callback host
     */
    callbackHost?: string;
    /**
     * The base URL of the EWP system where the transaction shall be processed.
     * This parameter is used to route the request to the EWP system that will
     * initiate the transaction.
     */
    baseUrl?: string;
    /**
     * The identifier of the EWP system where the transaction shall be processed.
     * This parameter is used to route the request to the EWP system that will
     * initiate the transaction.
     */
    environment?: Environment;
}
export interface SubscriptionConfig {
    /**
     * Subscription key which provides access to this API. Found in your Profile
     */
    primaryKey: string;
}
export interface UserConfig {
    /**
     * The API user's key
     */
    userSecret: string;
    /**
     * Resource ID for the API user
     */
    userId: string;
}
export interface Credentials {
    apiKey: string;
}
export interface AccessToken {
    /**
     * A JWT token which can be used to authorize against the other API end-points.
     * The format of the token follows the JWT standard format (see jwt.io for an example).
     * This is the token that should be sent in in the Authorization header when calling the other API end-points.
     */
    access_token: string;
    /**
     * The token type.
     *
     * TODO: Find list of complete token types
     */
    token_type: string;
    /**
     * The validity time in seconds of the token
     */
    expires_in: number;
}
/**
 * The available balance of the account
 */
export interface Balance {
    /**
     * The available balance of the account
     */
    availableBalance: string;
    /**
     * ISO4217 Currency
     */
    currency: string;
}
export interface Party {
    partyIdType: PartyIdType;
    partyId: string;
}
export declare enum PartyIdType {
    MSISDN = "MSISDN",
    EMAIL = "EMAIL",
    PARTY_CODE = "PARTY_CODE"
}
export declare enum Environment {
    SANDBOX = "sandbox",
    PRODUCTION = "production"
}
export declare enum TransactionStatus {
    SUCCESSFUL = "SUCCESSFUL",
    PENDING = "PENDING",
    FAILED = "FAILED"
}
export declare enum FailureReason {
    PAYEE_NOT_FOUND = "PAYEE_NOT_FOUND",
    PAYER_NOT_FOUND = "PAYER_NOT_FOUND",
    NOT_ALLOWED = "NOT_ALLOWED",
    NOT_ALLOWED_TARGET_ENVIRONMENT = "NOT_ALLOWED_TARGET_ENVIRONMENT",
    INVALID_CALLBACK_URL_HOST = "INVALID_CALLBACK_URL_HOST",
    INVALID_CURRENCY = "INVALID_CURRENCY",
    SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",
    INTERNAL_PROCESSING_ERROR = "INTERNAL_PROCESSING_ERROR",
    NOT_ENOUGH_FUNDS = "NOT_ENOUGH_FUNDS",
    PAYER_LIMIT_REACHED = "PAYER_LIMIT_REACHED",
    PAYEE_NOT_ALLOWED_TO_RECEIVE = "PAYEE_NOT_ALLOWED_TO_RECEIVE",
    PAYMENT_NOT_APPROVED = "PAYMENT_NOT_APPROVED",
    RESOURCE_NOT_FOUND = "RESOURCE_NOT_FOUND",
    APPROVAL_REJECTED = "APPROVAL_REJECTED",
    EXPIRED = "EXPIRED",
    TRANSACTION_CANCELED = "TRANSACTION_CANCELED",
    RESOURCE_ALREADY_EXIST = "RESOURCE_ALREADY_EXIST"
}