Skip to content

    CommerceWeb Portal

    Overview

    This section introduces the gateway's back office features via CommerceWeb portal for handling payments. These tools are made available in the form of APIs for complete integration within your ecommerce or management site, but are also available by accessing the site dedicated to the portal. For more information about the portal and its features, refer to the CommerceWeb.

    The gateway allows you to intervene on Orders, Operations, and Contracts.

    Orders

    An order identifies a transaction, which is the purchase of a good or service. The order is encoded in the APIs using the "orderId" parameter, which must be generated at checkout in solutions:

    The APIs made available for order management are presented below.

    Order Lookup (GET /orders/{orderId}): Returns information about an order GET/orders: Returns the list of orders that meet the filters set in the request.

    Operations

    A transaction represents an action performed on an order, such as a payment or reversal. The operation is coded in the APIs using the "operationId" parameter, the value of which is always assigned by the gateway and returned in response in calls of:

    The APIs available for operations management are presented below:

    • Task Search (GET/operations/{operationId}): Returns information about an operation.
    • GET/operations – Returns the list of operations that satisfy the filters set in the request.
    • POST/operations/{operationId}/refunds: Performs a reversal operation. A reversal is the cancellation of a payment, resulting in the amount being credited to the customer.
    • Accounting (POST/operations/{operationId}/captures): performs an accounting operation. Accounting is the confirmation of an authorized payment. It is necessary to distinguish between two methods of accounting: - Implicit: at the same time as the payment phase, each authorized transaction is implicitly accounted for. You don't need to use the Accounting API. - Explicit: After the payment phase you will need to explicitly confirm the authorized transactions that you want to be accounted for and settled via the accounting API.
    • Cancel (POST/operations/{operationId}/cancels)

    Contracts

    A contract is an identifier that allows the gateway to save the match between the customer and the payment card used. Contracts are used in OneClick and recurring payments.

    A contract is coded in APIs using the "contractId" parameter, which must be generated at the first payment stage in the solutions listed below, when you want to tokenize a card for subsequent OneClick and recurring payments:

    The APIs made available for contract management are presented below.

    Contract lookup (GET/contracts/customers/{customerId}): Returns contracts associated with a customer. Deactivate contract (POST/contracts/{contractId}/deactivation): Deactivates a contract. Once deactivated, you will no longer be able to make OneClick or recurring payments on your contract.