DisbursementDriverInterface

Source: view src/Contracts/DisbursementDriverInterface.php

Generated from the public PHP contract and its PHPDoc. Driver support varies; check instanceof or GatewayCapabilities before calling optional gateway capabilities.

transfer

Initiate a single transfer to a bank account or mobile money wallet. Expected $data keys: amount (float) required — amount in major currency unit currency (string) required — ISO 4217 currency code recipient_code (string) required — gateway recipient/beneficiary code from createTransferRecipient() reference (string) optional — unique caller-supplied reference reason (string) optional — narration / description shown on statement

public function transfer(array $data): array;

bulkTransfer

Initiate multiple transfers in a single API call. Each item in $transfers follows the same shape as transfer() $data, but recipient_code is required for every item.

public function bulkTransfer(array $transfers): array;

verifyTransfer

Verify / query the status of an existing transfer.

public function verifyTransfer(string $reference): array;

listTransfers

List transfers with optional filters.

public function listTransfers(array $params = []): array;

createTransferRecipient

Create a reusable transfer recipient (beneficiary). Expected $data keys: type (string) required — 'bank_account' | 'mobile_money' | 'nuban' etc. name (string) required — account/recipient name account_number (string) required — bank account number or mobile number bank_code (string) required for bank transfers currency (string) optional — defaults to gateway default description (string) optional

public function createTransferRecipient(array $data): array;

listBanks

List supported banks for the given country.

public function listBanks(array $filters = []): array;

resolveAccountNumber

Resolve / validate a bank account number to get the account holder name.

public function resolveAccountNumber(array $data): array;