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 |
---|---|
| Disbursed payment is returned, but not voided as yet. Payer has the option to void & credit or void & reissue payment. |
| 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. |
| 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. |
| Disbursed payment funds are not claimed by the vendor. |
| Payment is canceled. |
| Payment is voided and is not eligible for a credit to the payer. |
| Payment is voided and is credited to the payer. |
| 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.
|
| 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 is manually held for BILL to complete risk verification. BILL may reach out to the payer about the payment. |
| 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). |
| BILL has debited the payer's funding account (bank account, debit card, credit card, or BILL balance) to fund the payment. |
| 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. |
| Payment is scheduled. |
| Disbursement is manually held for BILL to complete risk verification. BILL may reach out to the payer to complete verification. |
| BILL has not attempted to debit the payer account. The payer organization risk verification is incomplete. |
| Payment is successfully sent and a void payment is requested. |
| Payment is scheduled and is waiting on approval. |
| BILL is ready to start debiting the payer's funding account. |
| Payment cancellation is in progress. |
| A virtual card payment has been claimed by the vendor for less than the full amount. |
| Payment is sent outside BILL, and then recorded in BILL |
| If none of the above conditions are met. |
Updated 7 days ago