---
swagger: "2.0"
info:
  x-ibm-name: payment-checkout-sb
  title: Payment Checkout (Sandbox)
  version: 1.0.0
  description: ""
schemes:
- https
basePath: /spgbusiness/v1
securityDefinitions:
  api-key:
    type: apiKey
    description: Unique key generated for each client app.
    in: header
    name: X-IBM-Client-Id
security:
- api-key: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /checkout:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/Out'
      parameters:
      - name: input
        required: true
        in: body
        schema:
          $ref: '#/definitions/In'
      operationId: checkout
      summary: Checkout Operation
  /inquiry:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/OutInquiry'
      operationId: inquiry
      parameters:
      - name: input
        required: false
        in: body
        schema:
          $ref: '#/definitions/InInquiry'
      summary: Inquiry Operation
definitions:
  Amount:
    properties:
      value:
        type: number
        format: double
        example: 20.450000
        description: Amount value.
      currency:
        type: string
        description: Currency used in the transaction.
        example: EUR
    additionalProperties: false
    description: Object that defines an amount.
  Customer:
    properties:
      customerInfo:
        description: Object that defines the customer predefined information (name,
          age, etc). Check the CustomerInfo definition.
        example: ""
        $ref: '#/definitions/CustomerInfo'
      extendedInfo:
        type: array
        items:
          $ref: '#/definitions/ExtendedInfo'
        description: Key Value tuple array.
    additionalProperties: false
    description: Object that defines a customer.
  CustomerInfo:
    properties:
      customerName:
        type: string
        description: Name of the customer.
        example: John
      customerCountry:
        type: string
        description: Country of the customer.
        example: Portugal
    additionalProperties: false
    description: Object that defines the predefined customer information.
  Deviceinfo:
    properties:
      serialNo:
        type: string
        example: "99999999999999"
      clientIp:
        type: string
        example: 192.168.148.1
      deviceName:
        type: string
        example: John PC
      deviceBrand:
        type: string
        example: Dell
      deviceModel:
        type: string
        example: xps
      imei:
        type: string
        example: "9900000862471854"
      osName:
        type: string
        example: Windows
      osVersion:
        type: string
        example: "1083"
      wirelessNetwork:
        type: string
        example: adapter
      flightMode:
        type: string
        example: "false"
      fingerPrintEnabled:
        type: string
        example: "true"
      deviceBootTime:
        type: string
        example: "10"
      screenResolution:
        type: string
        example: 1920x1080
      isJailbreaked:
        type: string
        example: "false"
      macAddress:
        type: string
        example: 255.255.255.0
      systemLanguage:
        type: string
        example: English
      timeZone:
        type: string
        example: GMT
    additionalProperties: false
    description: Object that defines the customer device information.
  ExtendedInfo:
    type: object
    properties:
      key:
        type: string
        example: CustomerAddress
      value:
        type: string
        example: Random Street
    description: Key value tuple.
  In:
    properties:
      requestCheckout:
        $ref: '#/definitions/RequestCheckout'
        description: Object that defines the checkout request parameters. Check the
          RequestCheckout definition.
    additionalProperties: false
    required:
    - requestCheckout
  Info:
    properties:
      deviceInfo:
        $ref: '#/definitions/Deviceinfo'
        description: Object that defines the customers device predefined information.
          Check the DeviceInfo definition.
      extendedInfo:
        type: array
        items:
          $ref: '#/definitions/ExtendedInfo'
        description: Key Value tuple array.
    additionalProperties: false
    description: Object that defines the transaction additional information
  InInquiry:
    properties:
      requestInquiry:
        description: Object that defines the QR Code inquiry request parameters. Check
          the RequestInquiry definition.
        $ref: '#/definitions/RequestInquiry'
    additionalProperties: false
  Merchant:
    properties:
      terminalId:
        type: integer
        example: "34937"
        description: Number of the merchant pos Id.
        format: int32
      channel:
        type: string
        description: Type of channel used by the merchant.
        example: web
      merchantTransactionId:
        type: string
        description: Unique id used by the merchant.
        example: 863b730df285443f9a60ca404e0085fd1234
    additionalProperties: false
    description: Object that defines a Merchant.
  Out:
    properties:
      returnCheckout:
        $ref: '#/definitions/ReturnCheckout'
        description: Object that defines the checkout response parameters. Check the
          ReturnCheckout definition.
    additionalProperties: false
  OutInquiry:
    properties:
      responseInquiry:
        description: Object that defines the QR Code inquiry response parameters.
          Check the ResponseInquiry definition.
        $ref: '#/definitions/ResponseInquiry'
    additionalProperties: false
  RequestCheckout:
    properties:
      merchant:
        description: Object that defines a Merchant. Check the Merchant definition.
        $ref: '#/definitions/Merchant'
      customer:
        description: Object that defines a Customer. Check the Customer definition.
        $ref: '#/definitions/Customer'
      transaction:
        description: Object that defines a Transaction. Check the Transaction definition.
        $ref: '#/definitions/Transaction'
      info:
        $ref: '#/definitions/Info'
        description: Object that defines the aditional info provided by the merchant.
          Check the Info definition.
    additionalProperties: false
    description: Object that defines the checkout operation request fields
  RequestInquiry:
    properties:
      transactionToken:
        type: string
        description: Unique id identify of the transaction.
        example: 42f59038f3f14e618d091da8bf3b717e9999
    additionalProperties: false
    description: Object that defines the inquiry operation request fields
  ResponseInquiry:
    properties:
      returnStatus:
        description: Object that defines the Status of the transaction. Check the
          ReturnStatus definition.
        $ref: '#/definitions/ReturnStatus'
      paymentStatus:
        type: string
        description: Original transaction status.
        example: Success
      paymentAction:
        type: string
        description: Original transaction action.
        example: 3DSEC
      transactionID:
        type: string
        example: 1d5586885d00ddf5001a24a0
        description: Unique Id generated by SIBS to identify this transaction.
      merchant:
        $ref: '#/definitions/Merchant'
        description: Object that defines a Merchant. Check the Merchant definition.
      paymentType:
        type: string
        example: MBWAY
        description: Payment type used in the original transaction.
    additionalProperties: false
    description: Object that defines the inquiry operation return fields
  ReturnCheckout:
    properties:
      returnStatus:
        description: Object that defines the Status of the transaction. Check the
          ReturnStatus definition.
        example: ""
        $ref: '#/definitions/ReturnStatus'
      transactionToken:
        type: string
        description: Unique id identify of the transaction.
        example: 42f59038f3f14e618d091da8bf3b717e9999
      transactionID:
        type: string
        description: Unique identify of the transaction.
        example: 42f59038f3f14e618d091da8bf3b717e9999
      amount:
        description: Object that defines the amount. Check the Amount definition
        $ref: '#/definitions/Amount'
      merchant:
        description: Object that defines a Merchant. Check the Merchant definition.
        $ref: '#/definitions/Merchant'
      paymentMethodList:
        type: array
        description: Methods of payment accepted by the merchant.
        items:
          type: string
        example: ""
    additionalProperties: false
    description: Object that defines the checkout operation return fields
  ReturnStatus:
    properties:
      statusCode:
        type: string
        description: Identifier code of the processed transaction status.
        example: "000"
      statusMsg:
        type: string
        description: Message of the processed transaction status.
        example: Success
      statusDescription:
        type: string
        description: Description of the processed transaction status.
        example: Transaction processed with success.
    additionalProperties: false
    description: Object that defines the status of the processed transaction.
  Transaction:
    properties:
      transactionTimestamp:
        type: string
        format: date-time
        description: Timestamp of the transaction.
        example: "2019-04-07T18:13:18.572+01:00"
      description:
        type: string
        description: Description of the transaction.
        example: Purchase using MB Way for the amount of 20.45€.
      paymentType:
        type: string
        example: MBWAY
        description: Type of payment used by the client.
      amount:
        example: ""
        description: Object that defines the amount. Check the Amount definition
        $ref: '#/definitions/Amount'
    additionalProperties: false
    description: Object that defines a transaction.
tags: []
produces:
- application/json
- text/plain
consumes:
- application/json
- text/plain
x-ibm-endpoints:
- endpointUrl: https://site1.sibsapimarket.com:8445/sibs-qly/apimarket-sb
  type:
  - production
  - development
- endpointUrl: https://site2.sibsapimarket.com:8445/sibs-qly/apimarket-sb
  type:
  - production
  - development
...