Class SendMoneyService

Hierarchy

Base
- SendMoneyService
  - JengaApiSdk

Index

Constructors

Methods

generateToken getConfig sendMoneyPesaLinkToBank sendMoneyPesaLinkToMobileNumber sendMoneyRtgs sendMoneySwift sendMoneyToMobileWallet sendMoneyWithinEquity updateConfig

Constructors

constructor

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

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

sendMoneyPesaLinkToBank

sendMoneyPesaLinkToBank<T>(options: {
data: sendMoneyPesaLinkToBankData;
headers?: any;
}): Promise<T>
Pesalink - To Bank Account

https://developer.jengaapi.io/reference/pesalink2bank
Type Parameters
- T
Parameters
- options: {
  data: sendMoneyPesaLinkToBankData;
  headers?: any;
  }
  
  This web service enables an application to send money to a PesaLink participating bank. It is restricted to Kenya.
  - data: sendMoneyPesaLinkToBankData
  - Optional headers?: any
Returns Promise<T>

sendMoneyPesaLinkToMobileNumber

sendMoneyPesaLinkToMobileNumber<T>(options: {
data: sendMoneyPesaLinkToMobileData;
headers?: any;
}): Promise<T>
Pesalink - To Mobile Number

This web service enables an application to send money to mobile.
Type Parameters
- T
Parameters
- options: {
  data: sendMoneyPesaLinkToMobileData;
  headers?: any;
  }
  - data: sendMoneyPesaLinkToMobileData
  - Optional headers?: any
Returns Promise<T>

sendMoneyRtgs

sendMoneyRtgs<T>(options: {
data: sendMoneyToRtgsData;
headers?: any;
}): Promise<T>
RTGS

https://developer.jengaapi.io/reference/rtgs

The Real Time Gross Settlement (RTGS) web-service enables an application to send money intra-country to other bank accounts.
Type Parameters
- T
Parameters
- options: {
  data: sendMoneyToRtgsData;
  headers?: any;
  }
  - data: sendMoneyToRtgsData
  - Optional headers?: any
Returns Promise<T>

sendMoneySwift

sendMoneySwift<T>(options: {
data: sendMoneyToSwiftData;
headers?: any;
}): Promise<T>
SWIFT

https://developer.jengaapi.io/reference/swift

The swift web-service enables your application to send cross-border remittances
Type Parameters
- T
Parameters
- options: {
  data: sendMoneyToSwiftData;
  headers?: any;
  }
  - data: sendMoneyToSwiftData
  - Optional headers?: any
Returns Promise<T>

sendMoneyToMobileWallet

sendMoneyToMobileWallet<T>(options: {
data: sendMoneyToMobileWalletData;
headers?: any;
}): Promise<T>
To Mobile Wallets

https://developer.jengaapi.io/reference/remittance

This enables your application to send money to telco :iphone: wallets across Kenya, Uganda, Tanzania & Rwanda. kindly note in order to get a response you will need to test this in production.
Type Parameters
- T
Parameters
- options: {
  data: sendMoneyToMobileWalletData;
  headers?: any;
  }
  - data: sendMoneyToMobileWalletData
  - Optional headers?: any
Returns Promise<T>

sendMoneyWithinEquity

sendMoneyWithinEquity<T>(options: {
data: SendMoneyWithinEquityData;
headers?: any;
}): Promise<T>
Within Equity Bank

https://developer.jengaapi.io/reference/within-equity-bank

Move Funds Within Equity Bank Across Kenya, Uganda, Tanzania, Rwanda & South Sudan.
Type Parameters
- T
Parameters
- options: {
  data: SendMoneyWithinEquityData;
  headers?: any;
  }
  - data: SendMoneyWithinEquityData
  - 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 SendMoneyService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

config: Config

Returns SendMoneyService

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

sendMoneyPesaLinkToBank

Type Parameters

T

Parameters

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

data: sendMoneyPesaLinkToBankData

Optional headers?: any

Returns Promise<T>

sendMoneyPesaLinkToMobileNumber

Type Parameters

T

Parameters

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

data: sendMoneyPesaLinkToMobileData

Optional headers?: any

Returns Promise<T>

sendMoneyRtgs

Type Parameters

T

Parameters

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

data: sendMoneyToRtgsData

Optional headers?: any

Returns Promise<T>

sendMoneySwift

Type Parameters

T

Parameters

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

data: sendMoneyToSwiftData

Optional headers?: any

Returns Promise<T>

sendMoneyToMobileWallet

Type Parameters

T

Parameters

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

data: sendMoneyToMobileWalletData

Optional headers?: any

Returns Promise<T>

sendMoneyWithinEquity

Type Parameters

T

Parameters

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

data: SendMoneyWithinEquityData

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

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

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

`Optional` headers?: any

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

`Optional` headers?: any

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

`Optional` headers?: any

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

`Optional` headers?: any

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

`Optional` headers?: any

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

`Optional` headers?: any

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