Search operations

Log in to the Addon Payments BackOffice Portal

Addon Payments has a management portal that, among other things, allows you to do the following:
  • Search for operations.
  • Capture or void pending operations.
  • Refund previous operations.
You can go into the Addon Payments BackOffice Portal as follows:
  1. Click on the link or put the following URL into your browser. Choose the environment you want to use.
  2. You can change the language on the login screen. At the top right, click to choose one of the options available: Spanish (ES), English (EN) or Catalan (CA).
  3. Enter your username and password and click on “LOG IN”. Remember, these values depend on the environment you are using.

List/see transactions (search operations)

You can see all the operations that have been correctly sent by Addon Payments by searching operations on the BackOffice Portal. You will see all the operations, regardless of whether they are authorized, declined or unfinished.

Below are the steps for an operation search:

  1. Access the BackOffice Portal.
  2. In the left-hand side menu, click on "Transaction search" (magnifying glass icon on a sheet of paper).
  3. A list will be displayed with the operations of your commerce and your child commerces (if any).
    By default, the last 10 operations of the last 24 hours are displayed. You can expand the number of operations displayed by using the drop-down menu at the bottom right.

Below is a list of all the columns available on the operation search and what they mean: 

  • ID: Transaction ID on Addon Payments. 
  • Amount: Total amount of the transaction. 
  • Currency: Currency used for the transaction.
  • Payment solution: Payment solution that processed the transaction. 
  • Operation: Type of transaction. The most common are:
    • ACCOUNT_REGISTRATION: Registration of a customer account on the payment gateway.
    • DEBIT: Charge customer.
    • CREDIT: Pay to customer’s account.
    • CAPTURE: Capture and settlement of a payment authorized previously.
    • VOID: Void and release of a payment authorized previously. 
    • REFUND: Reimbursing the full amount of a previous payment.
    • REBATE: Reimbursing part of the total amount of a previous payment.
  • Status: Transaction status. The most common are:
    • SUCCESS: Transaction authorized.
    • AWAITING_PAYSOL: Pending response from payment solution. 
    • REDIRECTED: Transaction in which the customer has been redirected to the payment solution.
    • CANCELLED: Transaction cancelled by the customer.
    • ERROR: Transaction declined, normally by the issuer.
    • FAIL: Transaction failed, probably due to set-up error.
  • Country: ISO 3166.2 country code for transaction.
  • Merchant transaction ID: ID for the transaction on your ecommerce platform. 
  • Date created: Date the was created. 
  • Merchant ID: ID of the merchant that processed the transaction. It is useful to separate transactions for your daughter merchants.
  • Product name: Name of the product that processed the transaction. It is useful to separate transactions by products.
  • Message: Final message received from the acquirer.
  • Original transaction ID: Addon Payments ID for the original transaction the secondary operation applied to. Secondary operation may be to capture, void or refund payment.
  • FUC: FUC code that processed the transaction. Only for card and Bizum payments.
  • Payment solution transaction ID: Unique ID for the transaction received from the payment solution.
  • TRA rules applied: Result of ASC risk analysis.
  • Card: Token generated for the customer’s card.
  • Merchant’s customer ID: ID for the customer on your ecommerce platform.
  • Customer ID: ID for the customer on the Addon Payments platform.
  • First name: First name of the customer received from your ecommerce platform.
  • Surname: Surname of the customer received from your ecommerce platform.
  • Customer country: Customer’s country from your ecommerce platform.
  • Customer email address: Customer email address received from your ecommerce platform.

Filter transaction list

You have several options for filtering the list of operations. These options are not mutually exclusive.
  • You can choose which info columns are shown using the “Columns” button on the upper left. There are three white columns on a blue background. When you tick or untick boxes, these columns will appear or disappear automatically from the list.
  • You can choose the time period for the transactions shown on the list using the calendar on the upper left. It is a white calendar on a blue background. When you click on it, a dropdown menu will appear for you to choose the time period. You can choose a relative period, last 30 minutes, last 7 days, etc. Or an absolute period, which can be up to one (1) calendar year.
  • You can refine your search by sorting and filtering elements in the columns.
    • To sort, click on the column name and choose from the following options: ascending, descending or unsorted.
    • Sorting is cumulative, so previous sorting options aren’t eliminated when you sort based on another column.
    • For example, if you first sort by “Payment solution” and then by “Creation date”, you’ll get a list of operations sorted first by the payment solution and within each payment solution, by creation date.
    • To filter, click on the filter icon on each column. A menu will drop down where you can choose the elements you want to show. There is a search engine in the filter to quickly find the options you want.

Export results of the operations list

You can export the results of your search for operations. On the lower left, click on “Download Report”.

When you do, you can choose whether to download the results of your search as CSV (text separated by commas) or as an Excel file. When you choose the format, the file will be downloaded to your device.

Transaction search

In this video you will see the different ways to search for transactions in the Addon Payments BackOffice Portal.

See transaction details

You can get more details on the transactions by double-clicking on the transaction in the list of operations. To return to the list of operations, click on the back button (white arrow) on the upper left of the details screen.

When you do, you will see a screen with all the information available on the transaction. The following sections are available:

  • Summary of transactions: The most important details of the transaction: status, transaction ID, payment solution, amount, etc. For authorized transactions, you can also download the receipt. To do so, click on “Download receipt”. This will save a receipt of the transaction that you can send to the customer if they request it.
  • Graphs with statistics: These graphs have statistics for the customer based on their locations, transactions and transaction totals.
  • Customer and account details: Shows customer details like name, address, city, etc. Also shows their account info. The customer account is used to process payment. It can be Bizum, credit card, etc. For credit cards, there will be a section with all the BIN details.
  • Payment solution details: Shows all the information received from the payment solution for the transaction. The information and its structure depends on the payment solution.
  • Transaction audit: Shows the workflow and rules applied to the transaction.
  • Transaction notifications: List of notifications AP has generated and sent to your ecommerce platform related to the transaction. The information is broken down in the following columns:
    • Date created: Date the notification was sent.
    • Notification URL: URL the notification was sent to.
    • Received: Boolean that shows your ecommerce platform received the notification.
        • true: The notification was received properly by your web server. A confirmation code (HTTP 200) was received
        • false: The notification was not received properly by your ecommerce platform’s web server. May be due to non-existent URL, restricted-access URL (HTTP 403), URL not found (HTTP 404) or internal server error (HTTP 500) on your platform.
      • Message: Content of notification generated.

    Note: If the notification can’t be delivered to the business site provided, AP will try again four (4) more times five (5) seconds apart.

Check transactions details

In this video you will see with examples how to check the details of any transaction though the BackOffice Portal.

List/advanced search of transactions

On the operations search list, you can use operators to refine your search. Enter them in the “Search” box at the top.

You can use the following operators:

1. Operators related to the transaction:

  • id: Transaction identifier.
  • merchant_txn_id: Merchant's transaction identifier.
  • date_created: Date of creation.
  • amount: Amount.
  • currency: Currency in ISO-4217.3 format.
  • status: Status.
  • merchant_id: Merchant's ID.
  • product_name: Product name.
  • payment_solution: Payment solution.
  • operation: Operation.
  • country: Country in ISO-3166.2 format.
  • message: Message.
  • original_txn_id: Original transaction identifier.
  • fuc: FUC.
  • paysol_txn_id: Transaction identifier in the payment solution.

2. Operators related to the customer:

  • card_number_token: Card.
  • customer_merchant_id: Identifier of the customer's merchant.
  • customer_id: Identifier of the customer.
  • customer_first_name: Name
  • customer_last_name: Surname.
  • customer_country: Country of the cusromer.
  • customer_email: Email of the customer.

Use of operators on the advanced list

There are some rules for using operators:

  • The operators must always be followed by a colon (:) and a space ( ) before the value to apply. Example: amount: 10.
  • The values of the operators can include “less than” (<) and “greater than” (>) symbols.
    For example, a search for transactions between two amounts would be “amount: >10 AND amount: <50”.
  • When searching for operations, you can join or link two (2) or more operators with “AND” and “OR”.
    • Use “OR” to accept more than one value for the same operator. For example: “status: SUCCESS OR status: REDIRECTED”.
    • Use “AND” to set up a range of values accepted (amount, creation date).  For example, to search for operations with a payment solution for an amount range: “payment_solution: CaixaPucPuce AND amount: >10 AND amount: <50”.
  • You can group the operators and prioritize them with parenthesis. You can search for operations in various statuses (SUCCESS and REDIRECTED) and various payment solutions (CaixaPucPuce and Bizum).
    For example: “( status: SUCCESS OR status: REDIRECTED ) AND ( payment_solution: CaixaPucPuce OR payment_solution: Bizum )”.

Scheduling reports to be compiled and sent

When you do an advanced search of transactions, the “Save” button is activated on the lower right. This allows you to save your current search as a report. This way, you can execute it again with just one click and schedule it to be executed and sent automatically.

When you click “Save”, you will see a form to fill in the report details.

The fields to fill in are the following:

  • Activated/Deactivated: Shows whether the report is activated or not. If it is deactivated, the report won’t be generated or sent according to the schedule in the “Schedule” section.
  • Visibility: Allows you to decide whether the report is private or public.
    • Public: All users with access to the merchant can see the report.
    • Private: Only available to the user who generated the report.
  • Format: Format of the report. You can choose CSV (text values separated by commas) or Excel spreadsheet.
  • Period: Creation date for the transactions in the report.
    • When you click on calendar, you will see more setting options.
  • Name: Name to save the report as.
    • Can’t have spaces but you can use underscore (_) instead.
    • It can’t be changed after the report has been created.
  • Description: Description of the report.
  • Columns: Indicates the columns showing on the list when you did the search. They can’t be changed on this screen. To change, follow these steps:
    1. Cancel saving the report and go back to the list of transactions.
    2. Change the columns shown in column control.
    3. Click “Save” again to return to the form to save the report.
    4. Now the list of columns in this field will be the same as what you had on the list.
    • Email addresses: Email addresses to send the report to, according to the schedule.
      • To enter more than one (1) email address, separate with commas.
      • For example, to send to “management@mybusiness.com” and “accounting@mybusiness.com”, enter: “gestion@mybusiness.com,accounting@mybusiness.com”.
    • Search in progress: The search executed from the advanced search field on the transactions list. It can’t be changed on this screen. To change, follow these steps:
      1. Cancel saving the report and go back to the list of transactions.
      2. Change the advanced search to suit your needs.
      3. Click “Save” again to return to the form to save the report.
    In the “Schedule” section, you can schedule reports to be compiled and sent. These are the parameters you can schedule.
    • Frequency: Dropdown menu to choose how often to compile and send reports. It has the following options:
      • Daily: The report will be compiled and sent every day.
      • Day of the week: The report will be compiled and sent weekly on the day selected.
      • Day of the month: The report will be compiled and sent monthly on the day selected.
    • Compile at: Allows you to choose the exact time when the report will be compiled.
    • Send at: Allows you to choose the exact time when the report will be sent to the email addresses you entered in “Email addresses”. The “Send at” value must be at least one (1) minute after the “Generate at” value.
    When you fill in all the required fields, the “Create report” button will be activated on the lower right of the form. Saved reports are shown on a list below the transactions list.

    The columns on the saved reports provide the following information:

    • Code: Report name.
    • Description: Description of the report. Summary of the search.
    • Next execution: Date of the next report, according to the schedule you set up.
    • File type: Type of file that will be created and sent, which can be:
      • CSV (comma-separated values “,”): Text values separated by commas.
      • XLS (sheet with an “x”): Excel spreadsheet. 
    • Status: Shows whether the report is active or not.
      • Active: The report will be compiled and sent periodically according to the established schedule.
      • Inactive: The report will not be compiled and sent according to the established schedule. However, it can be executed manually using the “Actions” button.
    • Actions: You have 3 buttons with the following functions:
      • Load report search (cloud with arrow inside): Loads the search order for the report in the search bar of the list, but doesn’t execute it. After loading the search order for the report, click “Search” to execute it.
      • Edit report (pencil): Shows the form to set up the report, where you can change most of the values. To change the columns shown in the report, click on “Columns” on the top right and tick only the columns you want in the report.
        Note: There are fields that can’t be changed after the report is created, such as the name and search order.
      • Erase report (red rubbish bin): Allows you to delete a saved report. You have to confirm this after clicking.
        You can’t delete public reports created by other users. If you try, you will get an error message.

    Secondary transactions

    Secondary transactions are carried out on a transaction authorized previously to change its final status.

    Depending on the settlement status for the transaction, you can carry out the following secondary transactions:

    Transactions pending settlement:

    • Capture (settle): For your merchant to be paid the amounts pending. Order settlement of the amount captured by the issuer in the customer’s account.
    • Cancellation (void): Order release of the amount captured by the issuer in the customer’s account. Meaning the bank releases the amount held to the customer and the funds remain in their account.

    Addon Payments doesn’t currently allow partial settlement or release of transactions, only the full amount.

    Settled transactions:

    • Partial refund.
    • Full refund.

    Capture and void

    Follow these steps to capture or void the amount of a transaction pending settlement:
    1. Search for authorized transactions pending capture, which will have status “PENDING”. To search, choose “PENDING” from the filter on the “Status” column.
    2. Get the transaction details by double-clicking on it.
    3. At the bottom of the page, there are two buttons:
      • Capture (thumbs-up): Order settlement of the full amount. Meaning you will be paid the amount.
      • Cancel (thumbs-down): Order release of the full amount. Meaning the hold on the funds in the customer’s account will be released and once again be available to them.
    4. Clicking on “Capture”:
      • The settlement order is sent to the issuer (customer’s bank).
      • The status of the primary transaction will change to “Success”.
      • A button for refunds will appear.
      • Settlement transactions don’t show up on the transaction search list or the transaction tree.
    5. Clicking on “Void” :
      • The release order is sent to the issuer.
      • The release transaction will appear based on the primary and original transaction. Release transactions DO appear on the transaction search list.
      • The status of the primary transaction will remain “Pending” but it won’t allow any new secondary operations.
      • The release transaction will have the same “merchant transaction ID”, its status will be “Success” and the operation type will be “VOID”.

    Capture and void through the BackOffice

    The tutorial will guide you on how to make a capture or void through the BackOffice Portal with visual examples of the procedure.

    Refunds

    To refund an authorized transaction in full or part, follow these steps:

    1. Find the transaction you want to refund. You can make this easier by sorting by date or using filters on the columns.
      You can also search for the “merchant transaction ID” in the search bar above.
    2. When you find the transaction you want to refund, double-click on it to get the details. 
    3. At the bottom of the page, the “Refund” button will appear. It is a blue button with an exclamation point. If the operation to be returned is from Quix, please refer to the specific documentation.
    4. When you click on the button, you will see a dialogue box with several fields:
      • Amount available: The maximum amount you can refund.
        • For transactions without a previous partial refund, the amount will be the same as the order total.
        • For transactions with one or more previous partial refunds, the amount will be the order total minus the amount or amounts already refunded. For example, if you have refunded €50 from a €100 order, the amount available will be €50.
      • Amount: Enter refund amount. If the total has decimal places, the separator is a point (.).
      • Description: you can include a description of the reason for the refund to better identify it later.
    5. Click “Refund“.
      • Sends a refund operation for the amount entered to the payment solution that processed the original transaction.
      • The secondary transaction will appear based on the primary and original transaction.
        • If the refund is for the full total amount, the transaction type is “REFUND”.
        • If the refund is for part of the total amount, the transaction type is “REBATE”.
        • If the refund status is “SUCCESS”, it has been authorized correctly. If the status is “ERROR”, it has been declined.
              • The text in the “Description” is in the refund “Message”.

            So, if a transaction has two (2) partial refunds, both (with the original transaction) will be on the list of operations.

            Unlike capture and release, refund transactions do appear on the list of operations.

            How to make refunds

            In this video you will see the process of making refunds thought the Addon Payments BackOffice Portal.

            visto recientemente

            Comparte este documento
            Tabla de Contenidos

            Consulta la documentación de las distintas secciones de integraciones:

            Comienza a integrar

            undraw_add_to_cart_re_wrdo 1 (1) (1)

            Plugins para CMS

            Complementa la integración

            SDKs

            Métodos de pago

            Herramientas

            Addon Payments

            Consulta la documentación de Addon Payments. Aquí tienes las distintas secciones:

            Integraciones

            Consultas frecuentes

            Portal Backoffice

            Cyberpac

            We are currently working on the English version of the Cyberpac documentation. You can view the Spanish version using the buttons below:

            Canales BackOffice Portal

            Plugins integration

            Custom integrations

            POS integrated Payments

            Create a solution that will help you automate processes. You can even add payment processes on physical terminals.

            Payment Integrated with Android POS

            Payment Integrated with Smartphone POS

            POS Data sheets

            Addon Payments

            Comercia Global Payments has several integration options so you can choose the most efficient one for you.

            Integrations

            Frequently Asked Questions

            BackOffice Portal

            Consult the documentation of the different integrations sections:​

            Start integration

            undraw_add_to_cart_re_wrdo 1 (1) (1)

            CMS Plugins

            Complement your integration

            SDKs

            Payment Methods

            Tools