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:
| Status | Description |
|---|---|
new | Charge generated, awaiting payment method selection. |
waiting | Payment method selected, awaiting payment confirmation. |
identified | Payment identified. Indicates that the payment was made before the money was credited. |
approved | Payment approved. Indicates that the payment was approved by the card operator but has not yet been credited. |
paid | Payment confirmed. |
unpaid | Unable to confirm the payment of the charge. |
refunded | Payment refunded by the merchant or the intermediary Efí. |
contested | Payment in dispute process. |
canceled | Charge canceled by the seller or the payer. |
settled | Charge was manually confirmed. |
link | Status applicable to Payment Link. This status indicates that it is a charge associated with a payment link. |
expired | Status 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:
| Status | Description |
|---|---|
new | Subscription created, but no charge has been paid. |
active | Active subscription. All charges are being generated. |
new_charge | Active subscription generating new transactions. The term "new_charge" appears whenever a new subscription charge is created. |
canceled | Subscription was canceled by the seller or the payer. |
expired | Expired 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:
| Status | Description |
|---|---|
up_to_date | Booklet is up to date, there are no overdue installments. When the booklet is created, it also receives this up_to_date status. |
unpaid | Booklet is overdue. If we identify the overdue status of at least one installment, the booklet status is changed to unpaid. |
finished | Booklet is finished, meaning all installments have been resolved and have a final status. From this moment on, the booklet status never changes. |
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