Worldline Retrieve transaction totals per brand API

The Retrieve transaction totals per brand API from Worldline — 2 operation(s) for retrieve transaction totals per brand.

Operations 2

GET /v1/analysis/brandtotals/day/levelid/{levelId}/levelidvalue/{levelIdValue} Retrieve daily totals #
GET /v1/analysis/brandtotals/month/levelid/{levelId}/levelidvalue/{levelIdValue} Retrieve monthly totals #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/wordline-retrieve-transaction-totals-per-brand-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

wordline-retrieve-transaction-totals-per-brand-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: This is the API server supplied by Equens.
  version: '1.0'
  title: Equens API store Retrieve transaction totals per brand API
  termsOfService: termsOfLicenseURL:API License
  contact:
    name: Equens API team
    url: www.equens.com
    email: apiteam@equens.com
  license:
    name: License
    url: license-url
servers:
- url: https://developer.equensworldline.com/MerchantApiAnalysis/api
tags:
- name: Retrieve transaction totals per brand
paths:
  /v1/analysis/brandtotals/day/levelid/{levelId}/levelidvalue/{levelIdValue}:
    get:
      tags:
      - Retrieve transaction totals per brand
      summary: Retrieve daily totals
      description: "This operation of the Analysis API will help you to retrieve aggregated data from different levels \nof the equensWorldline Acquiring Contract hierarchy, divided by brand. \nYou can do this using by providing an entity from the equensWorldline contract hierarchy, such as a contractId. \nThe results are aggregated transaction numbers and revenue, split by brand, on a daily basis, \ndivided by type Purchases, refunds and chargebacks. \n"
      operationId: getBrandTotalsPerDayUsingGET
      parameters:
      - name: levelId
        in: path
        description: Any ID of a level of the Equens contract administration
        required: true
        example: terminal_id
        schema:
          type: string
          enum:
          - cluster_id
          - merchant_id
          - contract_id
          - location_id
          - terminal_id
      - name: levelIdValue
        in: path
        description: 'ID value at this level.

          Example value

          clusterId 1000,

          merchantId 2000,

          contractId 3000,

          siteId 4000,

          terminalId 5000

          '
        required: true
        example: '5000'
        schema:
          type: string
      - name: type
        in: query
        description: "Transaction type Filter. \nValues (optional):\npurchase, refund or chargeback\n"
        required: false
        schema:
          type: string
          enum:
          - purchase
          - refund
          - chargeback
      - name: begin
        in: query
        description: 'Start day (yyyymmdd)

          '
        required: true
        example: '20160901'
        schema:
          type: string
      - name: end
        in: query
        description: 'End day (yyyymmdd)

          '
        required: true
        example: '20160920'
        schema:
          type: string
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RestPeriodTotalBrand'
        '400':
          description: Invalid input provided
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Unexpected error
        '502':
          description: Backend service not available
  /v1/analysis/brandtotals/month/levelid/{levelId}/levelidvalue/{levelIdValue}:
    get:
      tags:
      - Retrieve transaction totals per brand
      summary: Retrieve monthly totals
      description: "This operation of the Analysis API will help you to retrieve aggregated data from different levels of \nthe equensWorldline Acquiring Contract hierarchy, divided by brand. You can do this using by providing \nan entity from the equensWorldline contract hierarchy, such as a contractId. \nThe results are aggregated transaction numbers and revenue, split by brand, on a monthly basis, \ndivided by type Purchases, refunds and chargebacks.\n"
      operationId: getBrandTotalsPerMonthUsingGET
      parameters:
      - name: levelId
        in: path
        description: Any ID of a level of the Equens contract administration
        required: true
        example: merchant_id
        schema:
          type: string
          enum:
          - cluster_id
          - merchant_id
          - contract_id
          - location_id
          - terminal_id
      - name: levelIdValue
        in: path
        description: 'ID value at this level.

          Example value

          clusterId 1000,

          merchantId 2000,

          contractId 3000,

          siteId 4000,

          terminalId 5000

          '
        required: true
        example: '2000'
        schema:
          type: string
      - name: type
        in: query
        description: "Transaction type Filter. \nValues (optional):\npurchase, refund or chargeback\n"
        required: false
        schema:
          type: string
          enum:
          - purchase
          - refund
          - chargeback
      - name: begin
        in: query
        description: 'Start month (yyyymm)

          '
        required: true
        example: '201609'
        schema:
          type: string
      - name: end
        in: query
        description: 'End month (yyyymm)

          '
        required: true
        example: '201610'
        schema:
          type: string
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RestPeriodTotalBrand'
        '400':
          description: Invalid input provided
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Unexpected error
        '502':
          description: Backend service not available
components:
  schemas:
    RestTotalBrand:
      type: object
      properties:
        brand:
          type: string
          example: VISA, MAST, MAES, etc
        total:
          $ref: '#/components/schemas/RestTotal'
    RestPeriodTotalBrand:
      type: object
      properties:
        period:
          type: string
          description: YYYYMMDD for day-period. YYYYMM for month-period
          example: 20161231 for day-period or 201612 for month-period
        totalbrandList:
          type: array
          description: List of totals per brand
          items:
            $ref: '#/components/schemas/RestTotalBrand'
    RestTotal:
      type: object
      properties:
        amountPurchases:
          type: number
          description: Total amount purchases
        amountRefunds:
          type: number
          description: Total amount refunds
        amountChargebacks:
          type: number
          description: Total amount chargebacks
        numberPurchases:
          type: integer
          format: int64
          description: Total number of purchases
        numberRefunds:
          type: integer
          format: int64
          description: Total number of refunds
        numberChargebacks:
          type: integer
          format: int64
          description: Total number of chargebacks