Visa Business Data Transactions API API

openapi: 3.0.1
info:
  title: Foreign Exchange Rates Business Data Transactions API API
  description: Commercial Data API will provide the APIs to expose the commercial data i.e. card financial and invoice data through RESTful Services. The idea is to create an Enterprise Service with Restful architecture, which is robust, secured, scalable and high performance API. Data API provides functionality to fetch commercial data through following API. 1- Transaction API, 2- Enhanced Data API, 3- Starter Data API
  version: '1'
servers:
- url: https://sandbox.api.visa.com
  description: Sandbox server
security: []
tags:
- name: Business Data Transactions API
  description: Commercial Data API will provide the APIs to expose the commercial data i.e. card financial and invoice data through RESTful Services. The idea is to create an Enterprise Service with Restful architecture, which is robust, secured, scalable and high performance API. Data API provides functionality to fetch commercial data through following API. 1- Transaction API, 2- Enhanced Data API, 3- Starter Data API
paths:
  /cdsapi/commercial/v1/ob/trxndata:
    post:
      tags:
      - Business Data Transactions API
      summary: Get card transaction data
      description: ''
      operationId: getTransactionDataDetail
      parameters:
      - name: clientId
        in: header
        description: Client Identification Code
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Get Transaction data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/trxnRequest'
            examples:
              Default:
                summary: Default
                value:
                  bank:
                  - bankId: '999999'
        required: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResponse'
      x-codegen-request-body-name: Get Transaction data
      x-operationVersions:
      - label: v1 - Latest
        operationPointer: '#/paths/~1cdsapi~1commercial~1v1~1ob~1trxndata/post'
        default: false
  /vbs/dapi/v1/transaction_enhanced:
    post:
      tags:
      - Business Data Transactions API
      summary: Get Transaction and Enhanced Data
      description: Get Transaction & Enhanced Data
      operationId: fetchTransactionData
      parameters:
      - name: clientId
        in: header
        required: true
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransRequest'
            examples:
              Default:
                summary: Default
                value:
                  requestHeader:
                    clientId: '1111'
                    x-correlation-id: XXXX-111111-222222-333333
                  requestData:
                    issuerId: '9999'
                    companyId: '11112222'
                    pagination:
                      pageSize: 10
                      pageNum: '1'
                    processorId: '1'
                    regionId: '1'
                    filters:
                      enhancedData:
                        filterValues:
                        - supplier
                        - airline
                        filterType: ENHN_CAT
                      transactionDateTime:
                        filterValues:
                        - '2023-07-01T01:59:59'
                        - '2023-07-30T10:59:59'
                        filterType: BETWN
                    type: TRAN_ENHN
        required: true
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                type: object
            application/json:
              schema:
                type: object
              examples:
                Default:
                  summary: Default
                  value:
                    responseHeader:
                      Keep-Alive: timeout=60
                      X-Frame-Options: DENY
                      Strict-Transport-Security: max-age=31536000 ; includeSubDomains
                      Cache-Control: no-cache, no-store, max-age=0, must-revalidate
                      X-Correlation-Id: XXXX-111111-222222-333333
                      X-Content-Type-Options: nosniff
                      Pragma: no-cache
                      Expires: '0'
                      Content-Length: '149596'
                      X-XSS-Protection: '0'
                      Date: Thu, 31 Aug 2023 20:58:04 GMT
                      Content-Type: application/json
                    responseData:
                    - originalMccCode: 3333
                      period: 23072
                      virtual: {}
                      bilingPeriodCheckIndicator: 0
                      userData: {}
                      billingAmount: 53
                      enhancedData:
                        lodging:
                          lodgingSummary:
                          - itemSequenceNumber: 1
                            totalMiniBarCharges: 111
                            totalMovieCharges: 543
                            healthClubCharges: 324
                            totalValetParkingCharges: 123
                            totalLaundryCharges: 23
                            totalFoodOrBeverageCharges: 765
                            totalGiftShopPurchases: 0
                            sourceAmount: 23.5
                            totalNonRoomCharges: 9876
                            lodgingNights: 1
                            netValue: 123
                            totalRoomTaxAmount: 100
                            dailyRoomRate: 1987
                            totalPrepaidExpenses: 424.75
                            totalTelephoneCharges: 0
                            taxValue: 765
                            grossValue: 99
                            noShowIndicator: 0
                            totalBusinessCenterCharges: 564
                            merchantCategoryCode: 3040
                            totalDiscount: 10
                            totalOtherCharges: 24.5
                            totalTaxAmount: 99
                            totalFolioCashAdvances: 323
                          lodgingDetail:
                          - discountRate: 0
                            itemSequenceNumber: 1
                            foodOrBeverageCharges: 123
                            valetParkingCharges: 545
                            laundryCharges: 0
                            roomTax4Amount: 232
                            healthClubCharges: 324
                            roomTax3Amount: 0
                            roomRate: 0
                            telephoneCharges: 666
                            otherCharge: 87
                            businessCenterCharges: 213
                            miniBarCharges: 0
                            folioCashAdvances: 454
                            roomTaxAmount: 0
                            movieCharges: 54
                            sourceAmount: 23.5
                            roomTax2Amount: 0
                            giftShopPurchases: 1
                      memoPostFlag: 0
                      supplierIsoCountryCode: 840
                      sourceCurrencyCode: 840
                      billingCurrencyCode: 124
                      vatAmount: 0
                      originalSupplierCountryCode: 250
                      preprocessId: 8
                      bussinessNameSpace:
                        regionIdentification: 1
                        processorIdentification: 902
                      merchantCategoryCode: 3028
                      sourceLineNumber: 0
                      base2GmrIdentification:
                        $numberLong: '31023473433'
                      sourceAmount: 29
                      _id:
                        $oid: 645a7a55553bbbc444444f9b
                      transAudit:
                        kafkaMongoKey: 2023-05-09_2023-05-09
                        createTime: Tue May 09 11:53:06 CDT 2023
                        totalProcessTime: 0
                        transHotStoreProcessTime: 0
                        upStreamProcessTime: 0
                        rpicStampingProcessTime: 0
                        authUnixTime:
                          $numberLong: '1683608400000'
                      taxAmount: 0
                      key:
                        sequenceNumber: 297
                        recordKey: 10007130
                    - originalMccCode: 3007
                      period: 23072
                      virtual: {}
                      bilingPeriodCheckIndicator: 0
                      userData: {}
                      billingAmount: 53
                      enhancedData:
                        lodging:
                          lodgingSummary:
                          - itemSequenceNumber: 1
                            totalMiniBarCharges: 111
                            totalMovieCharges: 543
                            healthClubCharges: 324
                            totalValetParkingCharges: 123
                            totalLaundryCharges: 23
                            totalFoodOrBeverageCharges: 765
                            totalGiftShopPurchases: 0
                            sourceAmount: 23.5
                            totalNonRoomCharges: 9876
                            lodgingNights: 1
                            netValue: 123
                            totalRoomTaxAmount: 100
                            dailyRoomRate: 1987
                            totalPrepaidExpenses: 424.75
                            totalTelephoneCharges: 0
                            taxValue: 765
                            grossValue: 99
                            noShowIndicator: 0
                            totalBusinessCenterCharges: 564
                            merchantCategoryCode: 3040
                            totalDiscount: 10
                            totalOtherCharges: 24.5
                            totalTaxAmount: 99
                            totalFolioCashAdvances: 323
                          lodgingDetail:
                          - discountRate: 0
                            itemSequenceNumber: 1
                            foodOrBeverageCharges: 123
                            valetParkingCharges: 545
                            laundryCharges: 0
                            roomTax4Amount: 232
                            healthClubCharges: 324
                            roomTax3Amount: 0
                            roomRate: 0
                            telephoneCharges: 666
                            otherCharge: 87
                            businessCenterCharges: 213
                            miniBarCharges: 0
                            folioCashAdvances: 454
                            roomTaxAmount: 0
                            movieCharges: 54
                            sourceAmount: 23.5
                            roomTax2Amount: 0
                            giftShopPurchases: 1
                        fleet:
                          fleetService:
                          - serviceType: ' '
                            cityMotorFuelTaxExemptionIndicator: 0
                            fuelNetAmount: 0
                            itemSequenceNumber: null
                            matchType: P
                            nonFuelNetAmount: 0
                            fuelQuantity: 0
                            processorAddendumKey: '3333444455556666802                                 '
                            countyFuelSalesTaxAmount: 0
                            processorFinancialKey: ''
                            secondaryStateFuelTaxExemptionIndicator: 0
                            fleetAdditionalPromptedData1: ''
                            fleetAdditionalPromptedData2: ''
                            optionalField1: '                          '
                            checkOutDate: null
                            fuelMiscellaneousTaxAmount: 0
                            vatOrTaxRate: 40
                            optionalField4: '                          '
                            nonFuelGrossAmount: 0
                            optionalField2: '                          '
                            optionalField3: '                          '
                            cityFuelSalesTaxExemptionIndicator: 0
                            merchantSourceCode: PCR
                            matchReferenceKey: '                                                  '
                            countyFuelSalesTaxExemptionIndicator: 0
                            fuelFederalExciseTaxAmount: 0
                            cityFuelSalesTaxAmount: 0
                            countyMotorFuelTaxAmount: 0
                            stateMotorFuelTaxExemptionIndicator: 0
                            nonFuelStateAndLocalSalesTaxAmount: 0
                            supplierPostalCode: '12345'
                            fuelFederalExciseTaxExemptionIndicator: 0
                            allocationSequenceNumber: null
                            fileDatePartition: '20230826'
                            nonFuelMiscellaneousTaxAmount: 0
                            stateMotorFuelTaxAmount: 0
                            fuelUnitCost: 0
                            ticketNumber: ''
                            passengerName: ''
                            destinationAirportCode: ''
                            countyMotorFuelTaxExemptionIndicator: 0
                            fuelMiscellaneousTaxExemptionIndicator: 0
                            purchaseId: '3333                                              '
                            cityMotorFuelTaxAmount: 0
                            fuelGrossAmount: 0
                            tokenIndicator: ''
                            checkInDate: null
                            purchaseType: 2
                            fleetEmployeeNumber: ''
                            nonFuelFederalExciseTaxExemptionIndicator: 0
                            nonFuelStateAndLocalSalesTaxExemptInd: 0
                            sourceAmount: 27.98
                            productSequenceNumber: null
                            expandedFuelType: ''
                            federalSalesTaxAmount: 0
                            supplierName: CARQUEST 3333
                            legNumber: null
                            odometerReading: '0000000'
                            fuelUnitOfMeasureCode: G
                            nonFuelFederalExciseTaxAmount: 0
                            fleetTrailerNumber: ''
                            roomRate: null
                            secondaryStateFuelTaxAmount: 0
                            fuelType: '00'
                            merchantCategoryCode: 5555
                            nonFuelMiscellaneousTaxExemptionIndicator: 0
                            numberOfLegs: null
                            businessFormatCode: ''
                            originationAirportCode: ''
                            federalSalesTaxExemptionIndicator: 0
                          fleetProduct:
                          - ticketNumber: ''
                            passengerName: ''
                            destinationAirportCode: ''
                            itemSequenceNumber: null
                            matchType: P
                            purchaseId: '3333                                             '
                            processorAddendumKey: '3333444455556666802                                 '
                            tokenIndicator: ''
                            processorFinancialKey: ''
                            checkInDate: null
                            purchaseType: null
                            optionalField1: '                          '
                            checkOutDate: null
                            sourceAmount: 27.98
                            productSequenceNumber: 1
                            optionalField4: '                          '
                            optionalField2: '                          '
                            optionalField3: '                          '
                            supplierName: CARQUEST 3333
                            merchantSourceCode: PCR
                            legNumber: null
                            matchReferenceKey: '                                                  '
                            supplierPostalCode: '12345'
                            allocationSequenceNumber: null
                            roomRate: null
                            productCode: '00'
                            fuelType: ''
                            fileDatePartition: '20230826'
                            merchantCategoryCode: '5555'
                            numberOfLegs: null
                            businessFormatCode: ''
                            originationAirportCode: ''
                        carRental:
                          carRentalSummary:
                          - insuranceCharges: 0
                            itemSequenceNumber: null
                            corporateIdentification: ''
                            matchType: P
                            otherCharges: 0
                            extraMileageCharges: 0
                            processorAddendumKey: '4444555566668461   22223333444455559293673 08882222 '
                            mileageOrKmAtCheckOut: null
                            extraChargeCode: ''
                            carCompanyCode: ''
                            processorFinancialKey: ''
                            taBookingReferenceNumber: ''
                            optionalField1: '                          '
                            totalTaxOrVat: 0
                            checkOutDate: '2023-08-13'
                            vehicleGroupCharge: ''
                            dropOffStationCode: ''
                            optionalField4: '                          '
                            vehicleType: ''
                            optionalField2: '                          '
                            optionalField3: '                          '
                            merchantSourceCode: PCR
                            dailyRentalRate: 0
                            matchReferenceKey: ''
                            mileageOrKmDriven: null
                            netValue: null
                            costCenter: ''
                            glCode: ''
                            locationRentedFrom: ''
                            oneWayDropCharges: 0
                            supplierPostalCode: '12345'
                            lateReturnChargesOrHourlyRate: 0
                            allocationSequenceNumber: null
                            unitOfDistance: ''
                            autoTowing: 0
                            grossValue: null
                            noShowIndicator: 0
                            fileDatePartition: '20230826'
                            regularMileageCharges: 0
                            additionalServices: ''
                            ticketNumber: ''
                            passengerName: ''
                            destinationAirportCode: ''
                            returnLocation: ''
                            clientReferenceField6: ''
                            clientReferenceField7: ''
                            clientReferenceField9: ''
                            tokenIndicator: ''
                            checkInDate: null
                            purchaseType: null
                            clientReferenceField5: ''
                            clientReferenceField16: ''
                            clientReferenceField15: ''
                            clientReferenceField14: ''
                            clientReferenceField13: ''
                            clientReferenceField12: ''
                            clientReferenceField11: ''
                            clientReferenceField10: ''
                            sourceAmount: 123.45
                            productSequenceNumber: null
                            renterName: TEMP NAME
                            mileageOrKmAtCheckIn: null
                            fuelCharges: 0
                            checkInDateAndTime: ''
                            supplierName: TEMP CAR SUPPLIER
                            classCode: ''
                            legNumber: null
                            weeklyRentalRate: 0
                            daysRented: 0
                            pick_UpStationCode: ''
                            employeeId: ''
                            businessNumber: ''
                            locationReturnedTo: ''
                            checkOutDateAndTime: ''
                            vehicleRegistrationNumber: ''
                            roomRate: null
                            telephoneCharges: 0
                            productCode: ''
                            fuelType: ''
                            taxValue: null
                            merchantCategoryCode: 3333
                            totalDiscount: null
                            reservationNumber: ''
                            numberOfLegs: null
                            originationAirportCode: ''
                          carRentalDetail: []
                        purchase:
                          purchaseSummary:
                          - ticketNumber: ''
                            passengerName: ''
                            destinationAirportCode: ''
                            itemSequenceNumber: null
                            matchType: P
                            purchaseId: '3333'
                            destinationCountryCode: 840
                            discountAmount: 0
                            processorAddendumKey: '3333444455556666802                                 '
                            tokenIndicator: ''
                            processorFinancialKey: ''
                            checkInDate: null
                            purchaseType: null
                            optionalField1: '                          '
                            sourceStateOrProvince: ' '
                            checkOutDate: null
                            freightOrShippingVatOrTaxAmount: 0
                            sourceAmount: 27.98
                            productSequenceNumber: null
                            optionalField4: '                          '
                            optionalField2: '                          '
                            optionalField3: '                          '
                            supplierName: CARQUEST 3901
                            merchantSourceCode: PCR
                            legNumber: null
                            matchReferenceKey: '                                                  '
                            freightAmount: 0
                            freightOrShippingVatOrTaxRate: 0
                            supplierPostalCode: '12345'
                            vatReferenceNumber: ''
                            sourcePostalCode: ''
                            serviceIdentifier: PURCHA
                            allocationSequenceNumber: null
                            destinationStateOrProvince: ' '
                            roomRate: null
                            sourceCountryCode: 9000
                            destinationPostalCode: ''
                            fuelType: ''
                            fileDatePartition: '20230826'
                            merchantCategoryCode: 5555
                            numberOfLegs: null
                            originationAirportCode: ''
                            orderDate: ''
                            dutyAmount: 0
                          purchaseDetail:
                          - ticketNumber: ''
                            passengerName: ''
                            destinationAirportCode: ''
                            itemSequenceNumber: 1
                            itemLevelUsageCode: ''
                            matchType: P
                            purchaseId: '3362'
                            lineItemSource: VI
                            typeSupply: '0'
                            processorAddendumKey: '3333444455556666802                                 '
                            tokenIndicator: ''
                            processorFinancialKey: ''
                            checkInDate: null
                            purchaseType: null
                            optionalField1: '                          '
                            itemDiscountAmount: 0
                            checkOutDate: null
                            vatOrTaxRate: 0
                            sourceAmount: 27.98
                            lastItemIndicator: 1
                            productSequenceNumber: null
                            optionalField4: '                          '
                            optionalField2: '                          '
                            optionalField3: '                          '
                            supplierName: CARQUEST 3901
                            itemDescriptor: TEMP Merchandise
                            itemCommodityCode: ''
                            merchantSourceCode: PCR
                            legNumber: null
                            matchReferenceKey: '                                                  '
                            quantity: 1
                            itemTotalAmount: 27.98
                            lineItemSalesTaxChargedFlag: 0
                            itemProductCode: '72'
                            supplierPostalCode: '12345'
                            unitMeasure: ''
                            vatOrTaxAmount: 0
                            serviceIdentifier: PURCHL
                            allocationSequenceNumber: null
                            roomRate: null
                            fuelType: ''
                            unitCost: 27.98
                            fileDatePartition: '20230826'
                            merchantCategoryCode: 5555
                            numberOfLegs: null
                            originationAirportCode: ''
                        airline:
                          airlineDetail:
                          - departureTime: '0000'
                            ticketNumber: ''
                            passengerName: ''
                            itemSequenceNumber: 1
                            domesticOrInternationalIndicator: 0
                            matchType: P
                            purchaseId: ''
                            destinationOrAirportCode: XXX
                            dateOfTravel: '2023-08-24'
                            primaryTicketNumber: ''
                            processorAddendumKey: '475144811112222333344445555666677778888999912003    '
                            tokenIndicator: ''
                            processorFinancialKey: ''
                            checkInDate: null
                            purchaseType: null
                            optionalField1: ''
                            checkOutDate: null
                            arrivalTime: '0000'
                            sectorArrivalDateScheduled: ''
                            sectorNumber: 0
                            conjunctionTicketNumber: ''
                            sourceAmount: 497.8
                            productSequenceNumber: null
                            stopoverCode: 1
                            optionalField4: ''
                            optionalField2: ''
                            optionalField3: ''
                            supplierName: TEMP AIR  000011112222
                            originationAirportOrRailroadCode: XXX
                            merchantSourceCode: XXX
                            legNumber: 1
                            matchReferenceKey: ''
                            couponNumber: 0
                            serviceClass: L
                            supplierPostalCode: '123450000'
                            arrivalDate: ''
                            allocationSequenceNumber: null
                            roomRate: null
                            departureTax: 0
                            fuelType: ''
                            fareBasis: ''
                            carrierCode: XX
                            fileDatePartition: '20230825'
                            merchantCategoryCode: 3256
                            numberOfLegs: null
                            sectorFareAmount: 0
                            carrierReferenceNumber: ''
                            sectorRefundIndicator: ''
                          - departureTime: '0000'
                            ticketNumber: ''
                            passengerName: ''
                            itemSequenceNumber: 1
                            domesticOrInternationalIndicator: 0
                            matchType: P
                            purchaseId: ''
                            destinationOrAirportCode: XXX
                            dateOfTravel: '2023-08-24'
                            primaryTicketNumber: ''
                            processorAddendumKey: '475200011112222333344445555666677778888999912003    '
                            tokenIndicator: ''
                            processorFinancialKey: ''
                            checkInDate: null
                            purchaseType: null
                            optionalField1: ''
                            checkOutDate: null
                            arrivalTime: '0000'
                            sectorArrivalDateScheduled: ''
                            sectorNumber: 0
                            conjunctionTicketNumber: ''
                            sourceAmount: 497.8
                            productSequenceNumber: null
                            stopoverCode: 1
                            optionalField4: ''
                            optionalField2: ''
                            optionalField3: ''
                            supplierName: TEMP AIR  0000111122223
                            originationAirportOrRailroadCode: SFO
                            merchantSourceCode: PCR
                            legNumber: 2
                            matchReferenceKey: ''
                            couponNumber: 0
                            serviceClass: B
                            supplierPostalCode: '123450000'
                            arrivalDate: ''
                            allocationSequenceNumber: null
                            roomRate: null
                            departureTax: 0
                            fuelType: ''
                            fareBasis: ''
                            carrierCode: AS
                            fileDatePartition: '20230825'
                            merchantCategoryCode: 1111
                            numberOfLegs: null
                            sectorFareAmount: 0
                            carrierReferenceNumber: ''
                            sectorRefundIndicator: ''
                          airlineSummary:
                          - clientReference7: ''
                            clientReference6: ''
                            itemSequenceNumber: 1
                            endorsementOrRestrictions: '                    '
                            matchType: P
                            documentNumber: ''
                            processorAddendumKey: '475200011112222333344445555666677778888999912004    '
                            processorFinancialKey: ''
                            clientReference9: ''
                            primaryCarrierCode: ''
                            domesticTicketIndicator: ''
                            clientReference16: ''
                            clientReference15: ''
                            checkOutDate: null
                         

# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visa/refs/heads/main/openapi/visa-business-data-transactions-api-api-openapi.yml