basalt / subscriptions/src / PaymentInstruction
Interface: PaymentInstruction
Defined in: subscriptions/src/payment.ts:36
How the customer is told to pay — a reference, a redirect, or a push.
Properties
id
> id: string
Defined in: subscriptions/src/payment.ts:38
The gateway's id for this payment (status checks + reconciliation).
push?
> optional push?: object
Defined in: subscriptions/src/payment.ts:45
Push-based (mobile money): a prompt was sent to this phone.
phone
> phone: string
raw?
> optional raw?: unknown
Defined in: subscriptions/src/payment.ts:47
The raw gateway payload, for logging/debugging.
reference?
> optional reference?: object
Defined in: subscriptions/src/payment.ts:41
Reference-based (Multicaixa/EMIS): the entity + reference to pay.
amount
> amount: number
entity
> entity: string
reference
> reference: string
status
> status: "pending" | "paid" | "failed"
Defined in: subscriptions/src/payment.ts:39
url?
> optional url?: string
Defined in: subscriptions/src/payment.ts:43
Redirect-based (hosted page): send the customer here.