Transaction | mtn-pay

class: BaseTransaction(config: ITransactionConfig) Class for requesting for payments from customers
method: initialize()
method: pollStatus()
method: getDetails()
property: { string } referenceId
property: { IStatus } status
property: { number } timeout Number of microseconds before pollStatus times out; defaults to 35000 (35 seconds)

Hierarchy

BaseProduct
- Transaction

Index

Constructors

constructor

Properties

Methods

Object literals

status

Constructors

constructor

new Transaction(transactionType?: string, config: ITransactionConfig): Transaction

Overrides BaseProduct.constructor
- Defined in transaction/index.ts:57
Parameters
- Default value transactionType: string = TransactionTypes.COLLECTION
- config: ITransactionConfig
Returns Transaction

Properties

Protected apiToken

apiToken: IApiToken | undefined

commonHeaders

commonHeaders: object

Type declaration

Authorization: string
Content-Type: string
Ocp-Apim-Subscription-Key: string
X-Target-Environment: string

Private details

details: ITransactionDetails | undefined

Private interval

interval: number = 30000

Protected receipientType

receipientType: string

referenceId

referenceId: string

Private requestBody

requestBody: ITransactionBody

Private timeout

timeout: number = 35000

Private transactionResource

transactionResource: IResource

Protected transactionType

transactionType: string

Methods

Private _pollStatus

_pollStatus(): Promise<object>

- Defined in transaction/index.ts:173
Returns Promise<object>

Protected authenticate

authenticate(): Promise<void>

Inherited from BaseProduct.authenticate
- Defined in core/index.ts:57
Authenticates with remote api if the apiToken is expired or non-existent

Returns Promise<void>

getDetails

getDetails(): Promise<ITransactionDetails | undefined>

- Defined in transaction/index.ts:128
is sort of a getter for the details of this payment request

Returns Promise<ITransactionDetails | undefined>

initialize

initialize(): Promise<AxiosResponse<any>>

- Defined in transaction/index.ts:97
makes a POST request to the resourceUrl ednpoint to create a transaction request

Returns Promise<AxiosResponse<any>>

pollStatus

pollStatus(): Promise<object>

- Defined in transaction/index.ts:114
makes repetitive GET requests to the '${resourceUrl}/{this.referenceId}' until timeout or until status is not PENDING

Returns Promise<object>

Protected secondsSince

secondsSince(startingTime: Date): number

Inherited from BaseProduct.secondsSince
- Defined in core/index.ts:86
Returns the number of seconds between now and the given startingTime

Parameters
- startingTime: Date
Returns number

Protected shouldAuthenticate

shouldAuthenticate(): boolean

Inherited from BaseProduct.shouldAuthenticate
- Defined in core/index.ts:74
Checks whether the apiToken has expired or not; or whether it is exists or not

Returns boolean

Private updateDetails

updateDetails(__namedParameters: object): void

- Defined in transaction/index.ts:155
It updates the details of this payment request

Parameters
- __namedParameters: object
  - amount: any
  - currency: any
  - externalId: any
  - financialTransactionId: any
  - payee: any
  - payer: any
  - reason: any
  - status: any
Returns void

Private updateStatus

updateStatus(__namedParameters: object): void

- Defined in transaction/index.ts:141
It updates the status of this payment request

Parameters
- __namedParameters: object
  - reason: any
  - status: any
Returns void

Object literals

status

status: object

code

code: string = ""

reason

reason: string = ""

text

text: Status = Status.UNINITIALIZED

Generated using TypeDoc