Class MpgsDirectIntegrationService

Hierarchy

Base
- MpgsDirectIntegrationService
  - JengaApiSdk

Index

Constructors

Methods

generateToken getConfig mpgsAuthenticatePayment mpgsAuthorizePayment mpgsQueryPayment mpgsRefundPayment mpgsValidatePayment updateConfig

Constructors

constructor

new MpgsDirectIntegrationService(config: Config): MpgsDirectIntegrationService
Parameters
- config: Config
Returns MpgsDirectIntegrationService

Inherited from Base.constructor

Methods

generateToken

generateToken<AuthResponse>(): Promise<AuthResponse>
Type Parameters
- AuthResponse
Returns Promise<AuthResponse>

Inherited from Base.generateToken

getConfig

getConfig(): {
    apiKey: string;
    consumerSecret: string;
    enableAuthorization: boolean;
    enableLogging: boolean;
    env: string;
    merchantCode: string;
    privateKeyPath: string;
    verbose: boolean;
}
Gets the current configuration of the SDK

Returns {
    apiKey: string;
    consumerSecret: string;
    enableAuthorization: boolean;
    enableLogging: boolean;
    env: string;
    merchantCode: string;
    privateKeyPath: string;
    verbose: boolean;
}
- apiKey: string
- consumerSecret: string
- enableAuthorization: boolean
- enableLogging: boolean
- env: string
- merchantCode: string
- privateKeyPath: string
- verbose: boolean
Inherited from Base.getConfig

mpgsAuthenticatePayment

mpgsAuthenticatePayment<T>(options: {
data: mpgsAuthenticatePaymentData;
headers?: any;
}): Promise<T>
MPGS Authenticate Payment

https://developer.jengaapi.io/reference/mpgs-authenticate-payment

This API will be used to authenticate payments on MPGS.cardNumber and cardSecurity are encrypted using AES encryption then the cypher is base64 encoded.
Type Parameters
- T
Parameters
- options: {
  data: mpgsAuthenticatePaymentData;
  headers?: any;
  }
  - data: mpgsAuthenticatePaymentData
  - Optional headers?: any
Returns Promise<T>

mpgsAuthorizePayment

mpgsAuthorizePayment<T>(options: {
data: mpgsAuthorizePaymentData;
headers?: any;
}): Promise<T>
MPGS Authorize Payment

https://developer.jengaapi.io/reference/mpgs-authorize-payment

This API will be initiated by the merchant and will authorize payment on Mastercard.cardNumber and cardSecurity are encrypted using AES encryption then the cypher is base64 encoded.
Type Parameters
- T
Parameters
- options: {
  data: mpgsAuthorizePaymentData;
  headers?: any;
  }
  - data: mpgsAuthorizePaymentData
  - Optional headers?: any
Returns Promise<T>

mpgsQueryPayment

mpgsQueryPayment<T>(options: {
data: mpgsQueryPaymentData;
headers?: any;
}): Promise<T>
MPGS Query Payment

https://developer.jengaapi.io/reference/payment-payment

This API will query the status of a transaction.
Type Parameters
- T
Parameters
- options: {
  data: mpgsQueryPaymentData;
  headers?: any;
  }
  - data: mpgsQueryPaymentData
  - Optional headers?: any
Returns Promise<T>

mpgsRefundPayment

mpgsRefundPayment<T>(options: {
data: mpgsRefundPaymentData;
headers?: any;
}): Promise<T>
MPGS Refund Payment

https://developer.jengaapi.io/reference/mpgs-refund-payment

This API will refund a payment.
Type Parameters
- T
Parameters
- options: {
  data: mpgsRefundPaymentData;
  headers?: any;
  }
  - data: mpgsRefundPaymentData
  - Optional headers?: any
Returns Promise<T>

mpgsValidatePayment

mpgsValidatePayment<T>(options: {
data: mpgsValidatePaymentData;
headers?: any;
}): Promise<T>
MPGS Validate Payment

https://developer.jengaapi.io/reference/mpgs-validate-payment

This API will validate payment before card authorization. The API will do the following

Check if the merchant is subscribed to the Card APIs service

Check if they are subscribed to the MID they are using.

Fetch the relevant charges

cardNumber and cardSecurity are encrypted using AES encryption then the cypher is base64 encoded.
Type Parameters
- T
Parameters
- options: {
  data: mpgsValidatePaymentData;
  headers?: any;
  }
  - data: mpgsValidatePaymentData
  - Optional headers?: any
Returns Promise<T>

updateConfig

updateConfig(config: UpdateConfig, callback?: Function): {
    apiKey: string;
    consumerSecret: string;
    enableAuthorization: boolean;
    enableLogging: boolean;
    env: string;
    merchantCode: string;
    privateKeyPath: string;
    verbose: boolean;
}
Updates the current configuration of the SDK
Parameters
- config: UpdateConfig
- callback: Function = null
Returns {
    apiKey: string;
    consumerSecret: string;
    enableAuthorization: boolean;
    enableLogging: boolean;
    env: string;
    merchantCode: string;
    privateKeyPath: string;
    verbose: boolean;
}
- apiKey: string
- consumerSecret: string
- enableAuthorization: boolean
- enableLogging: boolean
- env: string
- merchantCode: string
- privateKeyPath: string
- verbose: boolean
Inherited from Base.updateConfig

Class MpgsDirectIntegrationService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

config: Config

Returns MpgsDirectIntegrationService

Methods

generateToken

Type Parameters

AuthResponse

Returns Promise<AuthResponse>

getConfig

Returns { apiKey: string; consumerSecret: string; enableAuthorization: boolean; enableLogging: boolean; env: string; merchantCode: string; privateKeyPath: string; verbose: boolean; }

apiKey: string

consumerSecret: string

enableAuthorization: boolean

enableLogging: boolean

env: string

merchantCode: string

privateKeyPath: string

verbose: boolean

mpgsAuthenticatePayment

Type Parameters

T

Parameters

options: { data: mpgsAuthenticatePaymentData; headers?: any; }

data: mpgsAuthenticatePaymentData

Optional headers?: any

Returns Promise<T>

mpgsAuthorizePayment

Type Parameters

T

Parameters

options: { data: mpgsAuthorizePaymentData; headers?: any; }

data: mpgsAuthorizePaymentData

Optional headers?: any

Returns Promise<T>

mpgsQueryPayment

Type Parameters

T

Parameters

options: { data: mpgsQueryPaymentData; headers?: any; }

data: mpgsQueryPaymentData

Optional headers?: any

Returns Promise<T>

mpgsRefundPayment

Type Parameters

T

Parameters

options: { data: mpgsRefundPaymentData; headers?: any; }

data: mpgsRefundPaymentData

Optional headers?: any

Returns Promise<T>

mpgsValidatePayment

Type Parameters

T

Parameters

options: { data: mpgsValidatePaymentData; headers?: any; }

data: mpgsValidatePaymentData

Optional headers?: any

Returns Promise<T>

updateConfig

Parameters

config: UpdateConfig

callback: Function = null

Returns { apiKey: string; consumerSecret: string; enableAuthorization: boolean; enableLogging: boolean; env: string; merchantCode: string; privateKeyPath: string; verbose: boolean; }

apiKey: string

consumerSecret: string

enableAuthorization: boolean

enableLogging: boolean

env: string

merchantCode: string

privateKeyPath: string

verbose: boolean

Settings

Member Visibility

Returns {
apiKey: string;
consumerSecret: string;
enableAuthorization: boolean;
enableLogging: boolean;
env: string;
merchantCode: string;
privateKeyPath: string;
verbose: boolean;
}

options: {
data: mpgsAuthenticatePaymentData;
headers?: any;
}

`Optional` headers?: any

options: {
data: mpgsAuthorizePaymentData;
headers?: any;
}

`Optional` headers?: any

options: {
data: mpgsQueryPaymentData;
headers?: any;
}

`Optional` headers?: any

options: {
data: mpgsRefundPaymentData;
headers?: any;
}

`Optional` headers?: any

options: {
data: mpgsValidatePaymentData;
headers?: any;
}

`Optional` headers?: any

Returns {
apiKey: string;
consumerSecret: string;
enableAuthorization: boolean;
enableLogging: boolean;
env: string;
merchantCode: string;
privateKeyPath: string;
verbose: boolean;
}