In this section · 3 articles

Payment statuses and fields

Every column and panel on Billing › Payments, the sixteen payment statuses and how a payment moves between them, the channels, and what the background tasks do.

Applies to
Billing 2.0 and later
Who can do this
Administrator, Team member
Where
Billing › Payments
On this page

Billing › Payments lists every payment your business has taken through a gateway, newest first. You need feature.bill.payment.list to open it and feature.bill.payment.view to open a payment. Payments can't be added, edited or deleted on screen. The one action is Refund. See Refund a payment.

The list

ColumnShows
ReferenceThe payment's permanent reference. Give this to support. Searchable.
GatewayThe gateway it went through. Searchable and filterable.
AmountThe amount and currency, such as 11800.00 INR.
StatusSee Statuses below. Filterable.
ChannelWhere it started: Admin, Website, Mobile app, API or Internal. Filterable.
CreatedWhen it started.
The Payments list in Billing, showing Reference, Gateway, Amount, Status, Channel and Created columns, with Gateway, Status and Channel filters above and payments that are Captured, Failed and Refunded.

In All Workspaces a Business column shows whose payment it is.

A payment's page

PanelFields
SummaryReference, Gateway, Driver key (the provider add-on's key, such as razorpay), Status, Channel
MoneyAmount, Currency, Refunded (the total returned so far)
ProviderProvider reference (the provider's own id for the charge, to search for in their dashboard), Paying for (what the payment is for, such as an invoice), Failure reason, Needs attention (why Billing can't move it on by itself)
TimelineCreated, Paid at, Expires at (when an unfinished checkout closes)
A captured payment's page in Billing, showing the Summary, Money, Provider and Timeline panels with its reference, driver key, amount, refunded total, invoice paid for and timestamps.

Statuses

Billing allows only the moves in the Next column, and refuses any other, such as from Failed back to Pending. Any payment that isn't final can also move to Needs attention.

StatusMeansNext
InitiatedRecorded, but the provider hasn't been contacted yet.Pending, Awaiting verification, Failed or Cancelled
PendingWith the provider. The customer is paying, or deciding.Authorized, Captured, Cancelled, Failed or Expired
AuthorizedThe money is held but not taken yet. Only with providers that take payment in two steps.Captured, Cancelled, Expired or Failed
CapturedThe money has been taken. This is the status that means you've been paid.Partially refunded, Refunded or Disputed
FailedThe provider or the customer's bank declined. Final. Failure reason says why.
CancelledThe customer chose not to continue. Final, and not a fault.
ExpiredNobody finished the checkout before it closed. Final.
Partially refundedPart of the money has been returned. More can be refunded.Refunded or Disputed
RefundedAll of it has been returned.Disputed
DisputedThe customer disputed the charge with their bank. The money is held back for now.Chargeback won or Chargeback lost
Chargeback wonThe dispute went your way. Final.
Chargeback lostThe dispute went against you. The money is gone, usually with a fee. Final.
Awaiting verificationA customer says they paid offline, for example by bank transfer, and someone must check.Verified or Rejected
VerifiedSomeone confirmed the offline payment. It counts as paid.Partially refunded, Refunded or Disputed
RejectedSomeone rejected the offline payment claim. Final.
Needs attentionBilling can't move the payment on by itself, usually because its gateway's add-on was removed or the provider's answer doesn't match. See A payment is stuck, or can't be refunded.The status the provider later confirms

[Confirm: Billing 2.0.0 has no button to verify or reject an offline payment. The Awaiting verification branch can only be moved by an add-on or integration. A Verified payment also has no Refund action, which is offered on Captured and Partially refunded payments only.]

When a payment for an invoice is Captured, Billing applies it to the invoice: the invoice's Paid goes up, its status becomes Partially Paid or Paid, and a Payment Received entry is added to the ledger. A payment for an invoice that's still a draft, already closed or in another currency isn't applied, and a warning is written to the server log.

Background tasks

Three scheduled tasks keep payments and invoices moving. They need your Laramin's scheduler to be running.

TaskRunsDoes
Reconcile paymentsEvery 15 minutesAsks the provider what happened to payments that stopped moving, in case its notification never arrived, and applies the answer.
Expire paymentsHourlyMarks payments whose checkout window (Expires at) has passed as Expired, recording The checkout window passed without a payment.
Mark invoices overdueDailyMarks unpaid invoices past their due date as Overdue.

When a gateway's notification can't be matched to a payment yet, because it arrived before the provider's reference was saved, Billing keeps it and tries again for a while rather than dropping it.