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.

Status	Description
`DISBURSEMENT_FAILED_ACTION_NEEDED`	Disbursed payment is returned, but not voided as yet. Payer has the option to void & credit or void & reissue payment.
`DISBURSEMENT_FAILED_VENDOR_BANK_REJECTED`	Disbursed 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_NEEDED`	BILL 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_ESCHEATED`	Disbursed payment funds are not claimed by the vendor.
`CANCELED`	Payment is canceled.
`FUNDING_FAILED_VOIDED`	Payment is voided and is not eligible for a credit to the payer.
`VOIDED`	Payment is voided and is credited to the payer.
`CLEARED`	Disbursed 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. Note: For ACH payments, the status is `CLEARED` when funds are sent to the vendor bank account. If the vendor bank rejects the payment (for reasons such as invalid vendor bank account information), the status changes to `DISBURSEMENT_FAILED_ACTION_NEEDED`.
`DELIVERED`	Payment 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_HOLD`	Disbursement is manually held for BILL to complete risk verification. BILL may reach out to the payer about the payment.
`SENT`	Disbursed payment is not delivered or settled as yet. The payment is issued or reissued, but not delivered (check or virtual card) or settled (ePayment).
`PROCESSED`	BILL has debited the payer's funding account (bank account, debit card, credit card, or BILL balance) to fund the payment.
`FUNDING_STARTED`	BILL has started to debit the payer's funding account (bank account, debit card, credit card, or BILL balance), but the process is not complete.
`SCHEDULED`	Payment is scheduled.
`DISBURSEMENT_ON_HOLD_PAYER_IN_REVIEW`	Disbursement is manually held for BILL to complete risk verification. BILL may reach out to the payer to complete verification.
`FUNDING_ON_HOLD`	BILL has not attempted to debit the payer account. The payer organization risk verification is incomplete.
`VOID_PENDING`	Payment is successfully sent and a void payment is requested.
`WAITING_ON_APPROVAL`	Payment is scheduled and is waiting on approval.
`READY_TO_FUND`	BILL is ready to start debiting the payer's funding account.
`CANCELLATION_IN_PROGRESS`	Payment cancellation is in progress.
`PARTIALLY_CLAIMED`	A virtual card payment has been claimed by the vendor for less than the full amount.
`PAID_OFFLINE`	Payment is sent outside BILL, and then recorded in BILL
`UNDEFINED`	If none of the above conditions are met.