Single status payment values

When you create a payment (POST /v3/payments) or bulk payment (POST /v3/payments/bulk), the API response includes a singleStatus field for providing a unified payment status.

This field provides a complete view of your payment based on status and disbursementStatus at different stages of your payment lifecycle.

StatusDescription
DISBURSEMENT_FAILED_ACTION_NEEDEDDisbursed payment is returned, but not voided as yet. Payer has the option to void & credit or void & reissue payment.
DISBURSEMENT_FAILED_VENDOR_BANK_REJECTEDDisbursed payment sent to the network vendor is returned, but not voided as yet. Payer must notify the network vendor to update their bank account in BILL.
FUNDING_FAILED_ACTION_NEEDEDBILL attempted to, but could not debit funds from the payer's funding account. However, BILL disbursed the payment, and the payer must wire funds to BILL.
FUNDS_ESCHEATEDDisbursed payment funds are not claimed by the vendor.
CANCELEDPayment is canceled.
FUNDING_FAILED_VOIDEDPayment is voided and is not eligible for a credit to the payer.
VOIDEDPayment is voided and is credited to the payer.
CLEAREDDisbursed payment is successfully settled by the vendor bank account. For example, a check is cashed, a virtual card payment is settled, or an ePayment is deposited to the vendor bank account.
DELIVEREDPayment is successfully sent, but the vendor is yet to take action to settle the payment. For example, an uncashed check or an unprocessed virtual card.
DISBURSEMENT_ON_HOLDDisbursement is manually held for BILL to complete risk verification. BILL may reach out to the payer about the payment.
SENTDisbursed payment is not delivered or settled as yet. The payment is issued or reissued, but not delivered (check or virtual card) or settled (ePayment).
PROCESSEDBILL has debited the payer's funding account (bank account, debit card, credit card, or BILL balance) to fund the payment.
FUNDING_STARTEDBILL has started to debit the payer's funding account (bank account, debit card, credit card, or BILL balance), but the process is not complete.
SCHEDULEDPayment is scheduled.
DISBURSEMENT_ON_HOLD_PAYER_IN_REVIEWDisbursement is manually held for BILL to complete risk verification. BILL may reach out to the payer to complete verification.
FUNDING_ON_HOLDBILL has not attempted to debit the payer account. The payer organization risk verification is incomplete.
VOID_PENDINGPayment is successfully sent and a void payment is requested.
WAITING_ON_APPROVALPayment is scheduled and is waiting on approval.
READY_TO_FUNDBILL is ready to start debiting the payer's funding account.
CANCELLATION_IN_PROGRESSPayment cancellation is in progress.
PARTIALLY_CLAIMEDA virtual card payment has been claimed by the vendor for less than the full amount.
UNDEFINEDIf none of the above conditions are met.