Class BankTransfersService

Index

Constructors

Methods

create getStatus listBanks validate

Constructors

constructor

new BankTransfersService(http: HttpClient): BankTransfersService
Parameters
- http: HttpClient
Returns BankTransfersService
- Defined in src/services/bank-transfers.ts:13

Methods

create

create(
params: CreateBankTransferParams,
options?: RequestOptions,
): Promise<APIResponseEnvelope<BankTransferData>>
Create and submit a bank transfer from merchant wallet to bank account.
Parameters
- params: CreateBankTransferParams
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<BankTransferData>>
Example
```
const transfer = await marzpay.bankTransfers.create({
  bank_account_number: '0123456789',
  bank_account_name: 'John Doe',
  bank_name: 'Equity Bank',
  amount: 150000,
  description: 'Vendor payment'
}, { idempotencyKey: 'idemp-bank-001' });
```
- Defined in src/services/bank-transfers.ts:51

getStatus

getStatus(
reference: string,
options?: RequestOptions,
): Promise<APIResponseEnvelope<BankTransferData>>
Check bank transfer status by transaction reference or UUID.
Parameters
- reference: string
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<BankTransferData>>
- Defined in src/services/bank-transfers.ts:78

listBanks

listBanks(
params?: { country?: string },
options?: RequestOptions,
): Promise<APIResponseEnvelope<SupportedBanksData>>
Get list of supported commercial banks by country.
Parameters
- Optionalparams: { country?: string }
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<SupportedBanksData>>
- Defined in src/services/bank-transfers.ts:65

validate

validate(
params: ValidateBankAccountParams,
options?: RequestOptions,
): Promise<APIResponseEnvelope<ValidateBankAccountData>>
Validate bank account number and retrieve account holder name before sending funds.
Parameters
- params: ValidateBankAccountParams
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<ValidateBankAccountData>>
Example
```
const account = await marzpay.bankTransfers.validate({
  account_number: '0123456789',
  bank_name: 'Equity Bank'
});
```
- Defined in src/services/bank-transfers.ts:26