Visa Business Data Solutions

openapi: 3.0.1
info:
  title: Visa Business Data Solutions
  description: ''
  version: '1'
servers:
  - url: https://sandbox.api.visa.com
    description: Sandbox server
security: []
tags:
  - name: Authorization Data API
    description: >-
      Data API will provide the APIs to expose the commercial data (i.e. card
      financial, invoice data) and authorization 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 and authorization data
      through following API. 1: Transaction API, 2: Enhanced Data API, 3:
      Starter Data API, 4:Authorization Data (Authorization Data API is an
      on-demand web service which delivers the authorization details
      (approved/declined) to the end consumer for registered card accounts
      (PAN).)
  - name: Business Data Corporate Setup 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.
  - 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
  - name: Push Authorization Data API
    description: >-
      PushNotification is a generic data channel to send Commercial Data to the
      end user over VDP. This API has capability to send Authorization data
      sets, Enhanced Data , Transaction data and Starter Data sets. Each push
      notification sent through VDP will have ONLY ONE of above data set i.e.
      auth or enhanced or transaction or starter data not a combined data sets.
  - name: Registered User Details Service
    description: Self Registration web services are used to register the new users.
  - name: VCS Enrollment API
    description: >-
      The API is used to onboard and register companies, users and cards in
      Commercial Space
paths:
  /Any_Client_URL:
    post:
      tags:
        - Push Authorization Data API
      summary: Send Auth Data
      description: Authorization Push
      operationId: sendAuthDataUsingPOST
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthTransactionFormat'
      responses:
        '200':
          description: ok
        '201':
          description: Created
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Something went wrong. Please try again later
      x-operationVersions:
        - label: v1 - Latest
          operationPointer: '#/paths/~1Any_Client_URL/post'
          default: false
      x-hideSample: true
      x-hideTryIt: true
  cdsapi/commercial/v1/ob/starterdata:
    post:
      tags:
        - Business Data Corporate Setup API
      summary: Get starter data
      description: ''
      operationId: Get starter data
      requestBody:
        description: Get starter data
        content:
          application/json:
            schema:
              type: object
              properties:
                issuer:
                  type: object
                  properties:
                    bank:
                      type: array
                      description: ''
                      items:
                        type: object
                        properties:
                          bankId:
                            type: integer
                            description: '12345'
                          company:
                            type: array
                            description: ''
                            items:
                              type: object
                              properties:
                                companyId:
                                  type: integer
                                  description: '123456789'
                    metadata:
                      type: object
                      properties:
                        adhoc:
                          type: string
                          description: true/false
                        numberOfRecords:
                          type: integer
                          description: '300'
                      description: ''
                  description: ''
            examples:
              Default:
                summary: Default
                value:
                  issuer:
                    bank:
                      - bankId: '200'
                        company:
                          - companyId: '8888800000'
                    metadata:
                      numberOfRecords: 300
                      adhoc: 'true'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  starterDataResponse:
                    type: object
                    properties:
                      starterData:
                        type: object
                        properties:
                          starterDataBankResponse:
                            type: object
                            properties:
                              responseMetadata:
                                type: object
                                properties:
                                  nextIndex:
                                    type: integer
                                    description: '79411025'
                                  requestId:
                                    type: integer
                                    description: '12345'
                                  startIndex:
                                    type: integer
                                    description: '79411015'
                                  numberOfRecordsFetched:
                                    type: integer
                                    description: '10'
                                  remainingStarterRecCount:
                                    type: integer
                                    description: '866'
                                description: ''
                              starterDataRecords:
                                type: object
                                properties:
                                  company:
                                    type: string
                                    description: ''
                                  cardHolder:
                                    type: string
                                    description: ''
                                  department:
                                    type: string
                                    description: ''
                                  cardAccount:
                                    type: string
                                    description: ''
                                description: ''
                            description: ''
                        description: ''
                    description: OK
              examples:
                Default:
                  summary: Default
                  value:
                    starterData:
                      starterDataRecords:
                        cardHolder: []
                        company:
                          - city: RICHMOND
                            effectiveDt: 1233014400000
                            orgHierManagementInd: 0
                            optFld1: ''
                            optFld2: ''
                            isParticipating: 'Y'
                            spendingLimit: 18250014
                            processorId: 1
                            companyNm: 207-UVA
                            stateProvCd: VA
                            federalInd: 0
                            optFld3: ''
                            optFld4: ''
                            mnrGroupId: null
                            address3: null
                            address2: 101 N 14TH ST 2ND FL
                            address1: DEPARTMENT OF ACCOUNTS
                            isoCtryCd: 840
                            prmyCntcFirstNm: null
                            prmyIndustryClsfnCd: 0
                            cardType: 2
                            postalCd: '232193684'
                            sctrCd: null
                            memberBankId: '6040'
                            dnbNum: 0
                            websiteUrlAddr: null
                            companyId: '3011207'
                            reportingIsoCurrCd: null
                            regionId: 1
                            prmyCntcLastNm: null
                            emailAddr: null
                            companyBid: null
                            secyIndustryClsfnCd: null
                            issuerNm: BANK OF AMERICA
                            logoId: null
                            conversionIsoCurrCd: null
                          - city: HARTSVILLE
                            effectiveDt: 1115856000000
                            orgHierManagementInd: 0
                            optFld1: null
                            optFld2: null
                            isParticipating: 'N'
                            spendingLimit: 37358470
                            processorId: 1
                            companyNm: >-
                              SONOCO PRODUCTS
                              COMPANY                                                         
                            stateProvCd: 'SC  '
                            federalInd: 0
                            optFld3: null
                            optFld4: null
                            mnrGroupId: null
                            address3: null
                            address2: MS J25
                            address1: NORTH 2ND ST
                            isoCtryCd: 840
                            prmyCntcFirstNm: null
                            prmyIndustryClsfnCd: null
                            cardType: 2
                            postalCd: '29550330001'
                            sctrCd: null
                            memberBankId: '6040'
                            dnbNum: null
                            websiteUrlAddr: null
                            companyId: '6603824'
                            reportingIsoCurrCd: null
                            regionId: 1
                            prmyCntcLastNm: null
                            emailAddr: null
                            companyBid: null
                            secyIndustryClsfnCd: null
                            issuerNm: FIA CARD SERVICES, N.A.
                            logoId: null
                            conversionIsoCurrCd: null
                          - city: BRANTFORD
                            effectiveDt: 1225152000000
                            orgHierManagementInd: 0
                            optFld1: null
                            optFld2: null
                            isParticipating: 'N'
                            spendingLimit: 2699964
                            processorId: 1
                            companyNm: >-
                              SONOCO CANADA
                              CORPORATION                                                       
                            stateProvCd: 'ON  '
                            federalInd: 0
                            optFld3: null
                            optFld4: null
                            mnrGroupId: null
                            address3: null
                            address2: null
                            address1: 33 PARK AVE EAST
                            isoCtryCd: 124
                            prmyCntcFirstNm: null
                            prmyIndustryClsfnCd: null
                            cardType: 2
                            postalCd: N3T 5T5
                            sctrCd: null
                            memberBankId: '6040'
                            dnbNum: null
                            websiteUrlAddr: null
                            companyId: '6613474'
                            reportingIsoCurrCd: null
                            regionId: 1
                            prmyCntcLastNm: null
                            emailAddr: null
                            companyBid: null
                            secyIndustryClsfnCd: null
                            issuerNm: FIA CARD SERVICES, N.A.
                            logoId: null
                            conversionIsoCurrCd: null
                          - mgrPhoneNum: null
                            effectiveDt: 253402214400000
                            parentHierNode: '000000000030704581'
                            glSubAcctCd: '                                                                            '
                            partIsoCtryCd: 840
                            description: 'HENDERSON                               '
                            partPostalCd: '29550         '
                            costCtrCd: null
                            optFld1: null
                            partAddr2: null
                            optFld2: null
                            partAddr3: null
                            secondHierNodeRep: '0000200'
                            mgrLastNm: null
                            partAddr1: 1 N. 2ND ST. MS J22
                            processorId: 1
                            partFaxNum: '                '
                            taskOrderNum: null
                            partStateCd: SC
                            mgrTrainingDt: 253402214400000
                            partFirstNm: SHEILA
                            optFld3: null
                            optFld4: null
                            mgrFirstNm: null
                            pHiernodeIsNum: 191002135
                            partPhoneNum: '8433837045      '
                            memberBankId: '6040'
                            partLastNm: MULLIS
                            thirdHierNodeRep: '0000021'
                            treeId: null
                            companyId: '6603824'
                            partCity: HARTSVILLE
                            regionId: 1
                            partEmailAddr: null
                            mgrTitle: null
                            hierNode: '000000000040704567'
                        cardAccount: []
                      responseMetadata:
                        startIndex: 1
                        requestId: 10302
                        numberOfRecordsFetched: 300
                        nextIndex: 288
                        remainingStarterRecCount: 2126752
      x-codegen-request-body-name: Get starter data
      x-operationVersions:
        - label: v1 - Latest
          operationPointer: '#/paths/cdsapi~1commercial~1v1~1ob~1starterdata/post'
          default: false
      x-hideTryIt: true
  /CPRAPI/v1/registeredUserDetails:
    post:
      tags:
        - Registered User Details Service
      summary: RegisteredUserDetails
      description: RegisteredUserDetails
      operationId: RegisteredUserDetails
      requestBody:
        content:
          application/json:
            schema:
              required:
                - clientId
                - messageId
                - pagination
              type: object
              properties:
                endDate:
                  type: string
                  description: End date till which date records need to be retrieved.
                clientId:
                  type: string
                  description: >-
                    Client ID field is a unique identification of the partner
                    Service.
                messageId:
                  type: string
                  description: >-
                    Unique identifier for this request.  Each request sent to
                    client requires its own unique ID. 
                startDate:
                  type: string
                  description: Start date from which date records need to be retrieved.
                pagination:
                  required:
                    - current_page
                  type: object
                  properties:
                    current_page:
                      type: string
                      description: This element contains the current_page number.
                  description: Complex element which contains the pagination details.
            examples:
              Default:
                summary: Default
                value:
                  clientId: '1'
                  pagination:
                    current_page: 1
                  endDate: 2019/01/01
                  messageId: '3734508035777106.5'
                  startDate: 2016/02/18
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  RegisteredUserDetailsResponseBean:
                    type: object
                    properties:
                      pagination:
                        required:
                          - current_page
                          - total_pages
                          - total_records
                        type: object
                        properties:
                          total_pages:
                            type: string
                            description: This element contains the total_page details.
                          current_page:
                            type: string
                            description: This element contains the current_page details.
                          total_records:
                            type: string
                            description: This element contains the total_records details.
                      statusCode:
                        type: string
                        description: The API response status code.
                      statusDesc:
                        type: string
                        description: The API response status description.
                      userDetails:
                        type: array
                        description: >-
                          Complex element which contains a arraylist of
                          userDetails.
                        items:
                          type: object
                          properties:
                            bankID:
                              type: string
                              description: Bank Identifier.
                            phnNum:
                              type: string
                              description: Phone Number.
                            address:
                              type: object
                              properties:
                                city:
                                  type: string
                                  description: City.
                                state:
                                  type: string
                                  description: State.
                                country:
                                  type: string
                                  description: Country.
                                zipcode:
                                  type: string
                                  description: Zipcode.
                                addressLine1:
                                  type: string
                                  description: This element contains the address line 1.
                                addressLine2:
                                  type: string
                                  description: This element contains the address line 2.
                              description: >-
                                Complex element which contains the address of
                                the User.
                            loginId:
                              type: string
                              description: Login ID.
                            bankName:
                              type: string
                              description: Bank Name .
                            lastName:
                              type: string
                              description: Last Name.
                            regionID:
                              type: string
                              description: Region Identifier.
                            companyID:
                              type: string
                              description: Company Identifier.
                            firstName:
                              type: string
                              description: First Name.
                            clientName:
                              type: string
                              description: clientName
                            companyName:
                              type: string
                              description: Company Name.
                            processorID:
                              type: string
                              description: Processor Identifier.
                            customFields:
                              type: object
                              properties:
                                custom_field1:
                                  type: string
                                  description: custom_field1
                                custom_field2:
                                  type: string
                                  description: custom_field2
                                custom_field3:
                                  type: string
                                  description: custom_field3
                              description: custom fields
                    description: Success
              examples:
                Default:
                  summary: Default
                  value:
                    pagination:
                      total_records: '462'
                      total_pages: '10'
                      current_page: '1'
                    statusDesc: SUCCESS
                    userDetails:
                      - lastName: jorege
                        firstName: alex
                        bankID: '1980'
                        companyID: '1336'
                        address:
                          country: '1'
                          zipCode: '94404'
                          city: foster city
                          addressLine1: 800 metro center blv
                          addressLine2: ''
                          state: CA
                        loginId: [email protected]
                        regionID: '1'
                        companyName: visa
                        bankName: PNC Bank-1980
                        phnNum: '1234567891'
        '400':
          description: Error Codes
          content:
            application/json:
              schema:
                type: object
                properties:
                  CP050:
                    type: object
                    description: clientId cannot be empty.
                  CP051:
                    type: object
                    description: clientId is required
                  CP052:
                    type: object
                    description: clientId Field Size should be between 5 and 25.
                  CP053:
                    type: object
                    description: >-
                      Request has incorrect Date Format, the Correct Date format
                      is YYYY/MM/DD.
                  KK001:
                    type: object
                    description: Given ClientId is not associated with any bank yet.
                  KK002:
                    type: object
                    description: >-
                      An Unexpcted System error occurred, Please contact System
                      adminstrator.
                  KK006:
                    type: object
                    description: >-
                      Request has incorrect Date Format, the Correct Date format
                      is YYYY/MM/DD.
                  KK007:
                    type: object
                    description: Given clientId is invalid.
                  KK012:
                    type: object
                    description: Current page can't be more than total page
                  KK013:
                    type: object
                    description: Current page can't be '0' or less
                  KK014:
                    type: object
                    description: Current page can't be an Empty value
                  KK015:
                    type: object
                    description: Current page can't be Null value
                  KK016:
                    type: object
                    description: Invalid characters
                  KK017:
                    type: object
                    description: Pagination values are not valid
      x-codegen-request-body-name: RegisteredUserRequestBean
      x-operationVersions:
        - label: v1 - Latest
          operationPointer: '#/paths/~1CPRAPI~1v1~1registeredUserDetails/post'
          default: false
      x-hideTryIt: true
  /vbs/dapi/v1/transactions/auth:
    post:
      tags:
        - Authorization Data API
      summary: Get Authorization Data
      description: Get Authorization Data
      operationId: getAuthDataUsingPOST
      parameters:
        - name: clientId
          in: header
          description: clientId
          required: true
          explode: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthRequestBody'
            examples:
              Default:
                summary: Default
                value:
                  authEndDateTime: '2022-09-30T01:40:00'
                  issuerId: '4444'
                  companyId: '90001'
                  processorId: '2'
                  regionId: '1'
                  accountList: []
                  pageSize: 25
                  filters:
                    - filterValues:
                        - 99
                      filterBy: authCatgCd
                    - filterValues:
                        - '0100'
                      filterBy: msgType
                  pageNum: '1'
                  authStartDateTime: '2022-09-01T01:40:00'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponseBody'
              examples:
                Default:
                  summary: Default
                  value:
                    metaData:
                      totalMatchedRecords: 2
                      pageNum: 1
                    authTransactions:
                      - tranId: '973839033642644'
                        mrchCatgCd: '9399'
                        stipAdvcCd: '5'
                        msgType: '0100'
                        isoTranAmt: '100.04'
                        vpcPropActnCd: ' '
                        crdhBillAmt: '100.04'
                        authTime: '12:11:22'
                        stipSwtchRsnCd: ' '
                        tokenIndicator: '0'
                        issuer: '4444'
                        trgrSvcDesc: Airline merchants restriction
                        trgrSvcType: AIR
                        uniqSeqId: '5464545355453454'
                        vpcActTknCd: ' '
                        authCatgCd: '99'
                        authCatgDesc: PROCESSING ERROR
                        company: '90001'
                        partialAuthAmt: '100.04'
                        preAuth: 'Yes'
                        mrchNm: Amazon
                        tranProcCd: ' '
                        mrchStatePrvCd: ' '
                        crdTypCd: '4'
                        isoTranCurrCd: '840'
                        authStatusCode: '80'
                        mrchCtryCd: COLUMBIA
                        msgTypeDesc: AUTHORIZATION REQUEST
                        acctNum: '4000000000000003'
                        crdAcptrId: ' '
                        authRsnDesc: NO FINANCIAL IMPACT
                        crdhBillCurrCd: '840'
                        processor: '2'
                        crdhBillAmtUsd: '100.04'
                        authDt: '20220901'
                        mrchZipCd: '29201'
                        authIdResp: ' '
                        tokenNumber: '                '
                        stipSwtchRsnDesc: Not Applicable
                        mrchCity: San Jose
                        region: '1'
                      - tranId: '973492303180772'
                        mrchCatgCd: '9399'
                        stipAdvcCd: '5'
                        msgType: '0100'
                        isoTranAmt: '100.04'
                        vpcPropActnCd: ' '
                        crdhBillAmt: '100.04'
                        authTime: '12:11:22'
                        stipSwtchRsnCd: ' '
                        tokenIndicator: '0'
                        issuer: '4444'
                        trgrSvcDesc: Airline merchants restriction
                        trgrSvcType: AIR
                        uniqSeqId: '43454543534545'
                        vpcActTknCd: ' '
                        authCatgCd: '99'
                        authCatgDesc: PROCESSING ERROR
                        company: '90001'
                        partialAuthAmt: '100.04'
                        preAuth: 'Yes'
                        mrchNm: Amazon
                        tranProcCd: ' '
                        mrchStatePrvCd: ' '
                        crdTypCd: '4'
                        isoTranCurrCd: '840'
                        authStatusCode: '56'
                        mrchCtryCd: COLUMBIA
                        msgTypeDesc: AUTHORIZATION REQUEST
                        acctNum: '4000000000000014'
                        crdAcptrId: ' '
                        authRsnDesc: UNABLE TO LOCATE RECORD
                        crdhBillCurrCd: '840'
                        processor: '2'
                        crdhBillAmtUsd: '100.04'
                        authDt: '20220901'
                        mrchZipCd: '29201'
                        authIdResp: ' '
                        tokenNumber: '                '
                        stipSwtchRsnDesc: Not Applicable
                        mrchCity: San Jose
                        region: '1'
        '201':
          description: Created
        '400':
          description: One or more fields were in incorrect format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrors'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Something went wrong. Please try again later
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrors'
      x-operationVersions:
        - label: v1 - Latest
          operationPointer: '#/paths/~1vbs~1dapi~1v1~1transactions~1auth/post'
          default: false
      x-hideTryIt: true
  /cdsapi/commercial/v1/ob/trxndata:
    

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