Last updated

Charges

A Charge in OFPI represents the actual payment that needs to be made in Brazil's Open FInance Network. Below we outline the various states in the OFPI 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 charge process.

State DescriptionTransitions toTrigger/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 netowrk
    - 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)
CANCELEDThe charge has been canceled.(End state - no further transitions)
FAILEDThe charge has failed.(End state - no further transitions)

Payment Intents

A Payment Intent in OFPI contains all the information required to process a payment in Brazil's Open FInance Network. Below we outline the various states in the OFPI 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 payment intent process.

State DescriptionTransitions toTrigger/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)
SUCCEEDEDThe payment intent has been successfully processed.(End state - no further transitions)
CANCELEDThe payment intent has been canceled.(End state - no further transitions)
FAILEDThe payment intent has failed.(End state - no further transitions)
Previous page
 
Copyright © 2020-2025 Belvo. All rights reserved