Skip to content

Payment

Money that moved against invoices: a customer paying us (receivable), us paying a vendor (payable), or a refund of either.

PackBilling
Versionv1 (latest)
URNurn:postware:billing:payment
Identityidentifiers
Status categoriespending, succeeded, failed, cancelled

Fields

FieldTypeReqNotes
directionenum(receivable|payable)yesdefault receivable
kindenum(payment|refund)yesdefault payment
counterpartyRef<Organization | Person>yes
amountMoneyyes
paid_atdatetimeyes
methodenum(card|bank_transfer|direct_debit|cash|check|wallet|other)no
statusStatus(pending|succeeded|failed|cancelled)yesdefault map[category:succeeded]
appliedobject[]no{invoice: Ref<Invoice>, amount: Money}
refund_ofRef<Payment>no
referencestringnocheck number, bank reference, processor id or remittance text

Events

payment.succeeded when status.category becomes succeeded; payment.failed when status.category becomes failed.