Interface: PreviewResult
Defined in: packages/pesa/src/types/preview.ts:22
Result of a preview / dry-run validation before committing an action.
Use pesa.previewOrder() or pesa.previewDisburse() to validate
payloads and check fees before initiating real transactions.
Example
if (pesa.previewOrder) {
const preview = await pesa.previewOrder({
amount: 15000, currency: 'TZS', reference: 'pre_001',
customer: { name: 'Juma', phone: '255712345678' },
});
console.log(`Fee: TZS ${preview.fee}`);
console.log(`Total: TZS ${15000 + (preview.fee ?? 0)}`);
}Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
fee? | number | Expected transaction fee in TZS, if available. | packages/pesa/src/types/preview.ts:26 |
message? | string | Optional human-readable message (e.g., error details). | packages/pesa/src/types/preview.ts:28 |
raw? | unknown | Raw provider response. | packages/pesa/src/types/preview.ts:30 |
valid | boolean | Whether the payload is valid. | packages/pesa/src/types/preview.ts:24 |