---
swagger: "2.0"
info:
  title: crds-cau-d-debit-cardless-transaction
  description: This microservice will operate with the information for transactions
    of the debit cardless
  version: 1.0.0
  x-ibm-name: crds-cau-d-debit-cardless-transaction
host: 127.0.0.1
basePath: /api
schemes:
- https
produces:
- application/json
paths:
  /v1/cards/debit-cards/cardless-transactions/retrieve:
    post:
      tags:
      - retrieve-debit-card-cardless-transaction
      operationId: retrieve-debit-card-cardless-transaction
      summary: 'LOB: Credit&Risk; Feature: Debit card cardless transactions; Functionality:
        Retrieve'
      description: This API retrieve the information of debit cardless transactions
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: countryCode
        in: header
        required: true
        type: string
        description: Country code in 2 character ISO 3166 format
      - name: businessCode
        in: header
        required: true
        type: string
        description: Business code identified during application registration
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - in: body
        name: debitCardlessTransactionRequest
        schema:
          $ref: '#/definitions/DebitCardlessTransactionRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/DebitCardlessTransactionResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  DebitCardlessTransactionRequest:
    type: object
    properties:
      cardNumber:
        maxLength: 19
        type: string
        example: 0005188999002786594
        description: 'Number Embossed/Printed on the Card. For Debit Card: A card
          issued by a bank allowing the holder to transfer money electronically from
          one account to another account or another bank account, for cash withdrawal,
          for making a purchase etc.'
      transactionId:
        maxLength: 14
        type: string
        example: "9121921"
        description: Unique Identifier of the transaction
    required:
    - cardNumber
    - transactionId
  DebitCardlessTransactionResponse:
    properties:
      sessionId:
        maxLength: 40
        type: string
        example: 5b5316c1-s384-4965-i74d-18a08s39t001
        description: Unique Id for user Session. Users are assigned a unique session
          Id for each login attempt that Identifies the user's login/login attempt
          to the application
      currentLoginDate:
        maxLength: 32
        type: string
        format: date-time
        example: "2022-10-22T17:40:58Z"
        description: This field contains the  date and hour when the customer make
          current login
      cardNumber:
        maxLength: 19
        type: string
        example: 0005188999002786594
        description: 'Number Embossed/Printed on the Card. For Debit Card: A card
          issued by a bank allowing the holder to transfer money electronically from
          one account to another account or another bank account, for cash withdrawal,
          for making a purchase etc.'
      transaction:
        $ref: '#/definitions/Transaction'
  Transaction:
    type: object
    properties:
      transactionCreatedDate:
        maxLength: 32
        type: string
        format: date-time
        example: "2022-10-22T17:40:58Z"
        description: This field contains the date, hour, minute, and second that created
          record in the table of the mobile app
      escCreatedDate:
        maxLength: 32
        type: string
        format: date-time
        example: "2022-10-22T17:40:58Z"
        description: This field contains the date, hour, minute, and second that creates
          the folio Debit Cardless in Enhanced Card System(ECS)
      accountNumber:
        maxLength: 16
        type: string
        example: "9559724287"
        description: Customer's Account Number with the Bank. An account number is
          the primary identifier for ownership of an account, whether a checking account
          or savings account.
      customerId:
        maxLength: 14
        type: string
        example: "3636614"
        description: Unique identifier of the customer
      transactionId:
        maxLength: 14
        type: string
        example: "9121921"
        description: This is the Unique Identifier of the transaction
      totalWithdrawalAmount:
        type: number
        format: double
        example: 200
        description: Refers to the Total amount withdrawal out of the account
      transactionAuthorization:
        $ref: '#/definitions/TransactionAuthorization'
  TransactionAuthorization:
    type: object
    properties:
      authenticationTypeCode:
        maxLength: 1
        type: string
        example: "2"
        description: 'This field contain the authentication type code handled by the
          customer. 1: Userid and Password, 2: Softtoken, 3: HardToken. This values
          is second authentication factor(2FA)'
      authenticationDate:
        maxLength: 32
        type: string
        format: date-time
        example: "2022-10-22T17:40:58Z"
        description: This field contains the date and time when the customer in the
          request of authenticated with second factor(2FA) when the debit cardless
          is request
      ipAddress:
        maxLength: 20
        type: string
        example: 100.200.102.500
        description: Ip address of the device.
  ErrorResponse:
    properties:
      type:
        type: string
        description: Invalid - Request did not confirm to the specification and was
          unprocessed and rejected. Please fix the value and try again
        enum:
        - error
        - warn
        - invalid
        - fatal
      code:
        description: Error code which qualifies the error
        type: string
      details:
        description: Human readable explanation specific to the occurrence of the
          problem
        type: string
      location:
        description: The name of the field that resulted in the error
        type: string
      moreInfo:
        description: URI to human readable documentation of the error
        type: string
      uuid:
        description: 128 bit UUID that you generate for every request
        type: string
      timestamp:
        description: timestamp of the error
        type: string
    required:
    - type
    - code
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
  Client ID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
  - /api/v1
  Client ID: []
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...