basalt / subscriptions/src / PaymentRequest
Interface: PaymentRequest
Defined in: subscriptions/src/payment.ts:18
A one-off payment request handed to a PaymentGateway.
Properties
amount
> amount: number
Defined in: subscriptions/src/payment.ts:22
Amount in the currency's minor unit (integer; 500000 = 5.000,00 Kz).
billableId
> billableId: string
Defined in: subscriptions/src/payment.ts:20
Who is paying — a tenant/user/customer id you reconcile against.
currency?
> optional currency?: string
Defined in: subscriptions/src/payment.ts:24
ISO 4217. Defaults to the gateway's own (AOA for Angolan gateways).
customer?
> optional customer?: object
Defined in: subscriptions/src/payment.ts:28
email?
> optional email?: string
name?
> optional name?: string
phone?
> optional phone?: string
description?
> optional description?: string
Defined in: subscriptions/src/payment.ts:27
expiresAt?
> optional expiresAt?: number
Defined in: subscriptions/src/payment.ts:30
When the reference / request stops being payable (epoch ms).
metadata?
> optional metadata?: Record<string, string>
Defined in: subscriptions/src/payment.ts:32
Passed to the gateway and echoed back on the webhook.
reference?
> optional reference?: string
Defined in: subscriptions/src/payment.ts:26
Your order/invoice id — for idempotency and reconciliation.