An online payment order can be created to be processed in two ways: Automatic mode and Manual mode.

The automatic mode is the default mode of the application. Through this mode, the transaction is completed in a single step, and modifications are limited. To create the order in automatic mode, the processing_mode field, which is responsible for defining the creation and processing format of the transaction, will be set to automatic, and all information is sent in a single request.

The allowed operations are:

• Create and process order: responsible for creating the order and simultaneously processing the transaction.
• Get order: allows you to obtain information about an order, including its status in real time.
• Capture order: enables the capture of the authorized amount of an order. This option is only valid for credit cards.
• Cancel order: responsible for canceling an existing order that has not yet been processed/ finalized.
• Refund order: in automatic mode, total or partial refunds can be created for a payment. The order will be fully refunded if all transactions are refunded completely.
  • Total refund: the value to be refunded should not be indicated in the request’s body, that must be empty.
  • Partial refund: the amount to be refunded must be specified in the request’s body along with de transaction ID. All other transactions will remain as they are, and only the modified transaction will be refunded.

The Manual Mode is where it is possible to divide the processing of the transaction into steps that can be configured and executed incrementally. It allows customization of each step of the payment process, adapting to different needs and scenarios. To create the order in manual mode, you need to ensure that the processing_mode field, that is responsible for defining the format of creation and processing of the transaction, is set to manual.

The allowed operations are:

• Create order (with or without transactions): responsible for creating and authorizing the order without simultaneous processing.
• Add transaction: this operation can only be performed in manual mode and is responsible for adding more than one transaction in the same payload.
• Modify and/or remove transaction: modifying and removing transactions can only be done in manual mode, and allow to change payment information that had been previously added to the order. These are operations that modifies an item within any field of the transactions parameter.
• Capture order: responsible for capturing the authorized amount of an order. This option is only valid for credit cards.
• Process transaction: allows executing the transactions created and/or modified in manual mode.
• Get order: allows you to locate an existing order intent.
• Cancel order: responsible for canceling an existing order that has not yet been processed.
• Refund order or transaction: in manual mode, total or partial refunds can be created for a payment. The order will be fully refunded if all transactions are refunded completely.
  • Total refund: the value to be refunded should not be indicated in the request’s body, that must be empty.
  • Partial refund: the amount to be refunded must be specified in the request’s body along with de transaction ID. All other transactions will remain as they are, and only the modified transaction will be refunded.