Skip to main content

Transaction Status

This page contains the list of all possible transaction statuses of the Billings Efí API.


Transactions (Billet and Credit card)

Below is a table containing the list of all possible statuses of a transaction:

StatusDescription
newCharge generated, awaiting payment method selection.
waitingPayment method selected, awaiting payment confirmation.
identifiedPayment identified. Indicates that the payment was made before the money was credited.
approvedPayment approved. Indicates that the payment was approved by the card operator but has not yet been credited.
paidPayment confirmed.
unpaidUnable to confirm the payment of the charge.
refundedPayment refunded by the merchant or the intermediary Efí.
contestedPayment in dispute process.
canceledCharge canceled by the seller or the payer.
settledCharge was manually confirmed.
linkStatus applicable to Payment Link. This status indicates that it is a charge associated with a payment link.
expiredStatus applicable to Payment Link. A payment link will receive this status when it reaches the expiration date defined in the expire_at field when consuming the /charge/:id/link endpoint.

Subscriptions

Below is a table containing the list of all possible statuses of a subscription:

StatusDescription
newSubscription created, but no charge has been paid.
activeActive subscription. All charges are being generated.
new_chargeActive subscription generating new transactions. The term "new_charge" appears whenever a new subscription charge is created.
canceledSubscription was canceled by the seller or the payer.
expiredExpired subscription. All charges configured for the subscription have been issued.

Carnets

Below is a table containing the list of all possible statuses of a payment booklet:

StatusDescription
up_to_dateBooklet is up to date, there are no overdue installments. When the booklet is created, it also receives this up_to_date status.
unpaidBooklet is overdue. If we identify the overdue status of at least one installment, the booklet status is changed to unpaid.
finishedBooklet is finished, meaning all installments have been resolved and have a final status. From this moment on, the booklet status never changes.

Resolved Charges

By resolved charge, it is understood to be any charge that has reached a final status. It no longer changes from this status except to another final status. These are:

  • paid
  • contested
  • refunded
  • settled
  • canceled