VoltaxProvider
Defined in: packages/node/src/core/interfaces.ts:18
Interface that all Voltax Gateways must implement.
Methods
Section titled “Methods”getPaymentStatus()
Section titled “getPaymentStatus()”getPaymentStatus(
reference):Promise<PaymentStatus>
Defined in: packages/node/src/core/interfaces.ts:43
Gets the status of a payment. In many cases aliases to verifyTransaction, but explicit for clarity.
Parameters
Section titled “Parameters”reference
Section titled “reference”string
The transaction reference
Returns
Section titled “Returns”Promise<PaymentStatus>
initializePayment()
Section titled “initializePayment()”initializePayment(
payload):Promise<VoltaxPaymentResponse>
Defined in: packages/node/src/core/interfaces.ts:28
Initiates a payment transaction.
Parameters
Section titled “Parameters”payload
Section titled “payload”The payment details
amount
Section titled “amount”number = ...
callbackUrl?
Section titled “callbackUrl?”string = ...
currency
Section titled “currency”Currency = ...
description?
Section titled “description?”string = ...
string = ...
metadata?
Section titled “metadata?”Record<string, any> = ...
mobileNumber?
Section titled “mobileNumber?”string = ...
options?
Section titled “options?”{ flutterwave?: { customerName?: string; linkExpiration?: Date; logoUrl?: string; maxRetryAttempts?: number; pageTitle?: string; paymentOptions?: string; paymentPlan?: number; sessionDuration?: number; subaccounts?: object[]; }; hubtel?: { cancellationUrl?: string; returnUrl?: string; }; paystack?: { bearer?: "subaccount" | "account"; channels?: PaystackChannel[]; invoiceLimit?: number; plan?: string; splitCode?: string; subaccount?: string; transactionCharge?: number; }; } | null = ...
reference?
Section titled “reference?”string = ...
Returns
Section titled “Returns”Promise<VoltaxPaymentResponse>
verifyTransaction()
Section titled “verifyTransaction()”verifyTransaction(
reference):Promise<VoltaxPaymentResponse>
Defined in: packages/node/src/core/interfaces.ts:36
Verifies a transaction by its reference.
Parameters
Section titled “Parameters”reference
Section titled “reference”string
The transaction reference
Returns
Section titled “Returns”Promise<VoltaxPaymentResponse>