📘

Before you begin, it is highly recommended to review the Withdraw Flows (Pay-out) start page, as it explains some of the terms used here as well, in case you haven't seen it yet.

Overview

The purpose of this endpoint is to provide a preview of a payment flow. It decodes the information sent through the QR code or barcode, along with the associated account details, and returns all relevant payment information to the requester.

A key benefit of using this endpoint is that it provides the status of the payment, ensuring that you do not attempt to initiate a payment that has already been completed.

The typical response from this endpoint will include the following properties:

• id: The barcode or QR code used in the request.
• type: The type of payment specified in the request.
• status: The current status of the payment.
• name: The name of the receiving account.
• taxId: The tax identification of the payer for this payment.
• amount: The amount to be withdrawn.
• interestAmount: The interest fee associated with the request (optional, only included if applicable).
• fineAmount: The penalty fee (optional, only included if applicable).
• discountAmount: The discount applied to the payment (optional, only included if applicable).
• brCode: An object containing the code details as specified in the id property in the request.
  • bankcode: The bank's identification code.
  • accountType: The type of account involved in the transaction.
  • reconciliationId: The bank reconciliation identifier.
  • description: The description of the payment.
  • keyId: The identifier for the payment.
  • nominalAmount: The total amount in the barcode or QR code.
  • reductionAmount: The total reduction in value, if applicable.
• scheduled: The date and time if the payment is scheduled.