Skip to main content

Payment and transfer status

Payments and transfers have two status fields, returned together by the API:

FieldWhat it answers
registration_statusWas the order requested from the bank? Did the bank respond?
statusWhere is the order now?

When the two disagree, status wins. An order can have status confirmed and registration_status requested or failed: the bank reported the settlement before Kobana recorded the acceptance. While status is pending, registration_status tells you whether the order was requested from the bank and whether the bank has responded.

registration_status​

ValueMeaning
pendingNot yet sent to the bank.
requestedKobana requested the order from the bank and awaits the response. In a CNAB remittance, the order can still be in the queue for the next remittance, and the API does not show when the file reached the bank.
confirmedThe bank accepted the order.
rejectedThe bank refused the registration.
failedThe submission did not complete. On a temporary error, Kobana tries again, and the API does not tell this retry apart from a permanent failure. Do not create a new order while status is not final: check the order and, if it is still failed, contact Support before creating another one.

status​

ValueMeaningWho acts nowFinal?
pendingOrder created. Check registration_status.Kobana or the bankNo
awaiting_approvalAwaiting release.YouNo
approvedRelease accepted, awaiting execution.BankNo
reprovedRefused at the release step.Create a new orderYes, it can only be canceled
scheduledThe bank accepted it for the scheduled date.BankNo
awaiting_scheduled_dateKobana sends it to the bank on the scheduled date.KobanaNo
awaiting_fundsThe bank is waiting for funds in the account.YouNo
finishingThe bank is completing the order.BankNo
confirmedExecuted.No oneYes
rejectedThe bank refused it. The reason is in rejected_error.Create a new orderYes
canceledCanceled.No oneYes
overdueTransfers only. The expiration date passed without execution.Bank; you, on the screen, if the transfer has not been sent yetNo

failed exists only in registration_status, never in status.

confirmed and canceled are final in the normal flow. A later notice from the bank can still change them: with a return or reversal, confirmed can become rejected or canceled; with a settlement or refusal reported in the return file, canceled can become confirmed or rejected.

Main transitions​

Not every bank goes through every status: some go straight from pending to confirmed.

All transitions​

The diagrams below show, by stage, every status change in the regular flow. Each arrow is a possible change, not a required path. The bank can report an outcome out of sequence, so an order can reach a status with no matching arrow.

registration_status​

Changes to the registration_status field, the same for payments and transfers.

Start and release​

Execution​

Entries into awaiting_funds and finishing.

Outcomes​

Entries into confirmed, rejected and canceled.

These diagrams are for payments. In transfers, there is the overdue status, described below.

overdue in transfers​

Only transfers expire. A transfer in pending, awaiting_approval or awaiting_scheduled_date becomes overdue when the expiration date passes without execution. From there, the bank can still report another status.

The return to pending only happens for a transfer not yet sent to the bank (registration_status pending), when you save a new date from today onward on the transfer screen. The API cannot change this date. If the bank has already received the transfer, only the bank moves the order out of overdue.

Common points of confusion​

  • rejected, reproved and failed. rejected is a refusal by the bank. reproved is a refusal at the release step. failed is a submission that did not complete.
  • awaiting_funds. It does not become overdue or failed. The outcome comes from the bank.
  • overdue. It exists only in transfers and is not final: the bank can still execute or refuse it. See overdue in transfers.
  • Canceling in finishing, awaiting_funds or overdue. The status does not change. For payments, the API refuses the request. For transfers, the API accepts the request, but the status stays the same: if the transfer was already sent to the bank, the request goes to the bank and the cancellation is not applied.

Tracking changes​

Every change triggers payment.db.updated or transfer.db.updated. See Webhook events.

See also Payment status and Transfer tracking, with the screens and actions available in each status.