CSQ Docs
    CSQ Docs
    CSQ API Doc
    • CSQ API Doc
    • Dummy Product Usage Guide
    • Back to home
    • Utils
    • Balances
      GET
    • Prices Direct
      GET
    • Prices Reverse
      GET
    • Transaction Info
      GET
    • Revert
      POST

    Utils

    šŸ’± Pricing & Balance Utilities#

    This section includes endpoints designed to support real-time pricing calculations, balance validation, transaction tracking, and reversal flows. These methods are essential for pre-transaction simulations and post-transaction audits, as well as undoing operations when needed.

    šŸ” Overview of Methods#

    MethodPurpose
    GET /balancesRetrieves the current available balance for the authenticated terminal or user. Useful for validating funds before initiating a transaction.
    GET /prices/directCalculates the destination amount (what the end user receives) based on a given sale price. Ideal when the user specifies how much they want to pay.
    GET /prices/reverseCalculates the required sale price based on a desired destination amount. Useful when the user wants to receive an exact value.
    GET /transaction/infoRetrieves the status and metadata of a previously submitted transaction using its unique identifier. Useful for reconciliation, support, or audit trails.
    POST /transaction/revertAllows manual reversal of a transaction using its localReference. Ideal for internal operations or support cases where a refund or rollback is needed — provided the product configuration allows reversals.

    These endpoints are lightweight and optimized for:
    Front-end applications that need to preview pricing
    Middleware that must validate balances and simulate outcomes
    Back-office systems that track, reverse, and reconcile transactions
    šŸ“Ž Tip: Use /prices/direct when the user enters how much they want to pay, /prices/reverse when they specify how much they want to receive, and /transaction/revert when support teams need to manually undo operations.
    Modified atĀ 2025-07-08 11:01:23
    Built with