payment-service.swagger.yml

swagger: '2.0'
info:
  description: A Payment Service API
  version: 0.0.1
  title: DPS Payment service API
host: 'localhost:8080'
basePath: /paymentservice
tags:
  - name: calculate-single-payment-controller
    description: Calculate Single Payment Controller
  - name: crc-controller
    description: Crc Controller
paths:
  /getBeanstreamEndpoints:
    get:
      tags:
        - PaymentServices
      summary: Generates application callback endpoints for Payment Service
      operationId: getBeanstreamEndpointsUsingGET
      consumes:
        - application/json
      produces:
        - application/xml
      responses:
        '200':
          description: Successful operation
          schema:
            $ref: '#/definitions/BeanstreamEndpointResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /getSinglePaymentURL:
    get:
      tags:
        - PaymentServices
      summary: Generate a Payment endpoint URL
      operationId: singlepaymenturlUsingGET
      consumes:
        - application/json
      produces:
        - application/xml
      parameters:
        - name: transType
          in: query
          description: transType
          required: true
          type: string
        - name: invoiceNumber
          in: query
          description: invoiceNumber
          required: true
          type: string
        - name: approvedPage
          in: query
          description: approvedPage
          required: true
          type: string
        - name: declinedPage
          in: query
          description: declinedPage
          required: true
          type: string
        - in: query
          name: errorPage
          description: errorPage
          required: true
          type: string
        - in: query
          name: totalItemsAmount
          description: totalItemsAmount
          required: true
          type: string
        - name: ref1
          in: query
          description: ref1
          required: false
          type: string
        - name: ref2
          in: query
          description: ref2
          required: false
          type: string
        - name: ref3
          in: query
          description: ref3
          required: false
          type: string
        - name: minutesToExpire
          in: query
          description: minutesToExpire
          required: true
          type: string
      responses:
        '200':
          description: Successful operation
          schema:
            $ref: '#/definitions/SinglePaymentResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
definitions:
  SinglePaymentResponse:
    type: object
    properties:
      respCode:
        type: integer
        format: int32
      respMsg:
        type: string
      respValue:
        type: string
  BeanstreamEndpointResponse:
    type: object
    properties:
      approved:
        type: string
      declined:
        type: string
      error:
        type: string
      respCode:
        type: integer
        format: int32
      respMsg:
        type: string