Interface: NameLookupResult
Defined in: packages/pesa/src/types/preview.ts:47
Result of a name lookup — resolves the account holder name for a phone number or bank account before disbursing.
Example
if (pesa.getNameLookup) {
const lookup = await pesa.getNameLookup('255712345678');
if (lookup.found) {
console.log(`Account: ${lookup.accountName}`);
}
}Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
accountName? | string | Account holder's name, if found. | packages/pesa/src/types/preview.ts:51 |
accountNumber? | string | Account number / phone number. | packages/pesa/src/types/preview.ts:53 |
found | boolean | Whether the account was found. | packages/pesa/src/types/preview.ts:49 |
message? | string | Optional human-readable message. | packages/pesa/src/types/preview.ts:57 |
provider? | string | Provider or network name (e.g., 'MPESA', 'CRDB'). | packages/pesa/src/types/preview.ts:55 |
raw? | unknown | Raw provider response. | packages/pesa/src/types/preview.ts:59 |