---
swagger: "2.0"
info:
  x-ibm-name: cashout-sandbox
  title: '[STUB] CASHOUT'
  version: 2.0.0
  description: Requests cashout operation using transfer details inserted by the customer
    and the Merchant.
schemes:
- https
basePath: /sibs/spg/v2/payments
consumes:
- application/json
produces:
- application/json
security: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /cashout:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/CashoutResponse'
      operationId: cashout
      description: Requests cashout operation using transfer details inserted by the
        customer and the Merchant
      parameters:
      - $ref: '#/parameters/signature'
      - $ref: '#/parameters/CashoutRequest'
      - $ref: '#/parameters/authorization'
      tags:
      - cashout
      summary: cashout
definitions:
  Deviceinfo:
    properties:
      browserAcceptHeader:
        type: string
        description: Browser Accept Header
      browserJavaEnabled:
        type: string
        description: Browser Java Enabled
      browserJavascriptEnabled:
        type: string
        description: Browser Javascript Enabled
      browserLanguage:
        type: string
        description: Browser Language
      browserColorDepth:
        type: string
        description: Browser Color Depth
      browserScreenHeight:
        type: string
        description: Browser Screen Height
      browserScreenWidth:
        type: string
        description: Browser Screen Width
      browserTZ:
        type: string
        description: Browser Time Zone
      browserUserAgent:
        type: string
        description: Browser User Agent
      systemFamily:
        type: string
        description: System Family
      systemVersion:
        type: string
        description: System Version
      systemArchitecture:
        type: string
        description: System Architecture
      deviceManufacturer:
        type: string
        description: Device Manufacturer
      deviceModel:
        type: string
        description: Device Model
      deviceID:
        type: string
        description: Device Unique Identification
      applicationName:
        type: string
        description: Application Name
      applicationVersion:
        type: string
        description: Application Version
      geoLocalization:
        type: string
        description: Geolocation
      ipAddress:
        type: string
        description: IP Address
    additionalProperties: false
    description: Object that defines the customer device information.
  ExtendedInfo:
    type: object
    properties:
      key:
        type: string
      value:
        type: string
    description: Key value tuple.
    required:
    - key
    - value
  Info:
    properties:
      deviceInfo:
        $ref: '#/definitions/Deviceinfo'
        description: Object that defines the customer device information.
      customerInfo:
        type: array
        items:
          $ref: '#/definitions/ExtendedInfo'
        description: Key Value tuple array.
    additionalProperties: false
    description: Object that defines the transaction additional information
  Merchant:
    properties:
      terminalId:
        type: string
        description: Merchant terminal id
        maxLength: 10
      merchantTransactionId:
        type: string
        description: Unique id used by the merchant.
        maxLength: 35
      merchantBrandName:
        type: string
        maxLength: 40
      operationDescription:
        type: string
        maxLength: 80
    additionalProperties: false
    description: Object that defines a Merchant.
    required:
    - terminalId
    - merchantTransactionId
    - merchantBrandName
    - operationDescription
  ReturnStatus:
    properties:
      statusCode:
        type: string
        description: Identifier code of the processed transaction status.  "000" for
          success. Values different from "000" refer to errors.
        example: "000"
      statusMsg:
        type: string
        description: Message of the processed transaction status.
        example: Success
      statusDescription:
        type: string
        description: Description of the processed transaction status.
    additionalProperties: false
    description: 'Describes the status of the request. (Attention: it doesn''t describe
      the state of the transaction itself).'
    required:
    - statusCode
    - statusMsg
    - statusDescription
  Execution:
    properties:
      startTime:
        type: string
        description: Time of the acceptance of the request by the API.
        format: date-time
        example: "2020-07-15T12:10:49.131+01:00"
      endTime:
        type: string
        description: Time of the response to the request by the API.
        format: date-time
        example: "2020-07-15T12:10:49.131+01:00"
    additionalProperties: false
    description: Object that encapsulates technical execution information.
    required:
    - startTime
    - endTime
  CashoutRequest:
    properties:
      cardInfo:
        $ref: '#/definitions/CardInfo'
        description: Card Info.
      info:
        $ref: '#/definitions/Info'
        description: Object that defines the transaction additional information.
      merchant:
        description: Merchant info.´
        $ref: '#/definitions/Merchant'
      billingProductType:
        type: string
        maxLength: 10
        description: Billing Product Type. This field is for billing purposes for
          BRM and SIP.
      amount:
        description: Amount of the Transfer
        $ref: '#/definitions/Amount'
      initiationMethod:
        type: integer
        description: 'Indicates if the process was initiated.  Possible Values:  ''1''
          - ''MSISDN Alias''  ''2'' - ''QRCode''  Default - ''1'''
        format: int32
      alias:
        description: Customer Alias
        $ref: '#/definitions/Alias'
      originApplication:
        type: integer
        description: '(''0'' = UP! (not used), ''1'' = Merchant)  Default: ''1'''
        format: int32
    additionalProperties: false
    description: Object that defines the payment operation request fields
    required:
    - cardInfo
    - billingProductType
  CashoutResponse:
    properties:
      returnStatus:
        description: Describes the status of the request.
        $ref: '#/definitions/ReturnStatus'
      transactionID:
        type: string
        description: Unique identify of the transaction.
        example: 42f59038f3f14e618d091da8bf3b717e9999
      paymentType:
        type: string
        description: Payment type used.
        enum:
        - AUTH
        - PURS
        - CAPT
        - CAUT
        - RFND
        - RCON
        - RVSL
        - STIQ
        - PREF
        - CPRF
        - CMBW
        default: AUTH
      paymentStatus:
        type: string
        description: Status of the payment.
        enum:
        - Success
        - Partial
        - Declined
        - InProcessing
        - Pending
        - Timeout
        - Error
        default: Success
      merchant:
        description: Object that defines a Merchant.
        $ref: '#/definitions/MerchantResponse'
      execution:
        $ref: '#/definitions/Execution'
        description: Object that defines an Execution. See the Execution definition.
    additionalProperties: false
    required:
    - returnStatus
  CardInfo:
    type: object
    properties:
      PAN:
        type: string
        maxLength: 28
        description: PAN.
      validationDate:
        type: string
        description: ""
        format: date-time
    additionalProperties: false
    required:
    - validationDate
    - PAN
  Amount:
    properties:
      value:
        type: number
        format: double
      currencyCode:
        type: string
        maxLength: 3
    additionalProperties: false
    required:
    - value
    - currencyCode
  Alias:
    properties:
      aliasName:
        type: string
        description: Customer Alias
        maxLength: 250
    additionalProperties: false
    required:
    - aliasName
  MerchantResponse:
    properties:
      terminalId:
        type: integer
        example: "21451"
        description: Merchant terminal id
        format: int32
      merchantTransactionId:
        type: string
        description: Unique id used by the merchant.
    additionalProperties: false
    description: Object that defines a Merchant.
    required:
    - terminalId
    - merchantTransactionId
tags: []
parameters:
  authorization:
    name: authorization
    type: string
    required: true
    in: header
  signature:
    name: signature
    type: string
    required: false
    in: header
  CashoutRequest:
    name: CashoutRequest
    required: true
    in: body
    schema:
      $ref: '#/definitions/CashoutRequest'
x-ibm-endpoints:
- endpointUrl: https://sandbox.qly.sibspayments.com
  type:
  - production
  - development
- endpointUrl: https://site2.sibsapimarket.com:8445/sibs-qly/apimarket-sb
  type:
  - production
  - development
- endpointUrl: https://site1.sibsapimarket.com:8445/sibs-qly/apimarket-sb
  type:
  - production
  - development
...