Last updated

Introduction

In this article we provide you a detailed overview of entity states and their transitions within Belvo's payments product.

Charges

A Charge represents the actual payment that needs to be made in Brazil's Open Finance Network. Below we outline the various states in the charge process, detailing the possible transitions between these states and describing the conditions under which these transitions occur. Please see the table below to get a comprehensive overview of each state and the flow of the process.

State DescriptionTransitions To Trigger/Event
CREATEDInitial state when the charge is created.
  • PENDING
  • Charge is initiated but not yet processed by the OF network
PENDINGThe charge is awaiting further action or scheduling.
  • SCHEDULED
  • SUCCEEDED
  • CANCELED
  • FAILED
  • Charge is scheduled for processing
  • The Charge has successfully been processed in the OF network
  • Charge is canceled by OF network while pending
  • Charge fails in the OF network while pending.
SCHEDULEDThe charge is scheduled for processing at a future date.
  • SUCCEEDED
  • CANCELED
  • FAILED
  • Charge is successfully processed
  • Charge is canceled while scheduled
  • Charge fails while scheduled.
SUCCEEDEDThe charge has been successfully processed.(End state - no further transitions)None
CANCELEDThe charge has been canceled.(End state - no further transitions)None
FAILEDThe charge has failed.(End state - no further transitions)None

Enrollment

An Enrollment represents the authorization of a user's device in the Open Finance Network with their institution (required for Biometric Payments). Below we outline the various states in the Enrollment process, detailing the possible transitions between these states and describing the conditions under which these transitions occur. Please see the table below to get a comprehensive overview of each state and the flow of the process.

State DescriptionTransitions To Trigger/Event
InitialInitial State of the Enrollment.
  • PENDING
  • The Enrollment payload is accepted and is awaiting confirmation by the user.
PENDINGThe Enrollment has been created and is now waiting Authorization from the user.
  • SUCCEEDED
  • FAILED
  • The user has accepted the Enrollment and it was successfully registered in the network as well as in the institution.
  • The Enrollment failed, either due to user, network, or institution error.
SUCCEEDEDThe Enrollment processes were completed successfully.
  • CANCELED
  • The user canceled the Enrollment.
FAILEDThe Enrollment process failed.(End state - no further transitions)None
CANCELEDThe user canceled the Enrollment.(End state - no further transitions)None

Payment Authorization (Coming Soon!)

A Payment Authorization is the consent that your user gives you to charge (debit money from) their accounts. Below we outline the various states in the Payment Authorization process, detailing the possible transitions between these states and describing the conditions under which these transitions occur. Please see the table below to get a comprehensive overview of each state and the flow of the process.

State DescriptionTransitions To Trigger/Event
InitialInitial state when the Payment Authorization is created.
  • AWAITING_AUTHORIZATION
  • FAILED
  • The network accepts the Payment Authorization payload.
  • The network rejects (fails) the Payment Authorization payload.
AWAITING_AUTHORIZATIONThe Payment Authorization is awaiting confirmation by the user in the institution.
  • AUTHORIZED
  • PARTIALLY_ACCEPTED
  • FAILED
  • The user has confirmed the Payment Authorization.
  • The user confirmed the Payment Authorization, however, the bank account requires an authorization from another party.
  • The authorization failed (the user may not have accepted the authorization).
PARTIALLY_ACCEPTEDThe user confirmed the Payment Authorization, however, the bank account requires an authorization from another party. The Institution will notify the relevant parties to approve the authorization.
  • AUTHORIZED
  • FAILED
  • All users have confirmed the Payment Authorization.
  • The authorization failed (the user may not have accepted the authorization).
AUTHORIZEDThe user (or all users) have confirmed the Payment Authorization.
  • CONSUMED
  • REVOKED
  • FAILED
  • The authorization period (or number of transactions) has finished.
  • The user has revoked the authorization.
CONSUMEDThe authorization period (or number of transactions) has finished.(End state - no further transitions)None
REVOKEDThe user has revoked the authorization.(End state - no further transitions)None
FAILEDThe Payment Authorization has failed.(End state - no further transitions)None

Payment Intents

A Payment Intent contains all the information required to process a payment in Brazil's Open Finance Network. Below we outline the various states in the Payment Intent process, detailing the possible transitions between these states and describing the conditions under which these transitions occur. Please see the table below to get a comprehensive overview of each state and the flow of the process.

State DescriptionTransitions To Trigger/Event
Created & ConfirmedInitial state when the Payment Intent is created and is confirmed by the user in the customer's flow.
  • REQUIRES_ACTION
  • Payment intent is created and confirmed.
REQUIRES_ACTIONThe Payment Intent requires further action.
  • PROCESSING
  • FAILED
  • Payment intent contains all required information
  • Payment intent fails (for example, the user did not grant their consent in the banking application).
PROCESSINGThe Payment Intent is being processed.
  • SCHEDULED
  • SUCCEEDED
  • CANCELED
  • FAILED
  • Payment intent moves to scheduled state
  • Payment intent is successfully processed
  • Payment intent is canceled
  • Payment intent fails.
SCHEDULEDThe Payment Intent is scheduled for processing.
  • SCHEDULE_FINISHED
  • CANCELED
  • Payment intent completed schedule payments
  • Payment intent is canceled.
SCHEDULE_FINISHEDThe Payment Intent has finished the scheduled processing. Only used if not 100% of a schedule succeeded. Otherwise the final status is SUCCEEDED.(End state - no further transitions)None
SUCCEEDEDThe Payment Intent has been successfully processed.(End state - no further transitions)None
CANCELEDThe Payment Intent has been canceled.(End state - no further transitions)None
FAILEDThe Payment Intent has failed.(End state - no further transitions)None
Previous page
 
Copyright © 2020-2025 Belvo. All rights reserved