---
swagger: "2.0"
info:
  x-ibm-name: sibs-pbl-payment-stb-api
  title: PBL Payment (Sandbox)
  version: 1.0.0
  description: ""
schemes:
- https
basePath: /sibs/spg/v1
consumes:
- application/json
produces:
- application/json
security: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /payments/{id}/pbl/payment-link:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/ResponsePayment'
        400:
          description: Bad Request.
          schema:
            $ref: '#/definitions/ResponsePayment'
        401:
          description: Unauthorized.
          schema:
            $ref: '#/definitions/ResponsePayment'
        403:
          description: Forbidden.
          schema:
            $ref: '#/definitions/ResponsePayment'
        404:
          description: Not Found.
          schema:
            $ref: '#/definitions/ResponsePayment'
        405:
          description: Method Not Allowed.
          schema:
            $ref: '#/definitions/ResponsePayment'
        406:
          description: Not Acceptable.
          schema:
            $ref: '#/definitions/ResponsePayment'
        408:
          description: Request Timeout.
          schema:
            $ref: '#/definitions/ResponsePayment'
        415:
          description: Unsupported Media Type.
          schema:
            $ref: '#/definitions/ResponsePayment'
        429:
          description: Too Many Requests.
          schema:
            $ref: '#/definitions/ResponsePayment'
        500:
          description: Internal Server Error.
          schema:
            $ref: '#/definitions/ResponsePayment'
        503:
          description: Service Unavailable.
          schema:
            $ref: '#/definitions/ResponsePayment'
        504:
          description: Gatewaty Timeout.
          schema:
            $ref: '#/definitions/ResponsePayment'
      operationId: paymentLink
      description: Perform the transaction and redirect user to Payment Host.
      parameters:
      - name: input
        required: true
        in: body
        schema:
          $ref: '#/definitions/RequestPayment'
      - name: id
        type: string
        required: true
        in: path
      - name: authorization
        type: string
        required: true
        in: header
definitions:
  DeviceInfo:
    properties:
      browserAcceptHeader:
        type: string
      browserJavaEnabled:
        type: string
      browserLanguage:
        type: string
      browserColorDepth:
        type: string
      browserScreenHeight:
        type: string
      browserScreenWidth:
        type: string
      browserTZ:
        type: string
      browserUserAgent:
        type: string
      systemFamily:
        type: string
      systemVersion:
        type: string
      systemArchitecture:
        type: string
      deviceManufacturer:
        type: string
      deviceModel:
        type: string
      deviceID:
        type: string
      applicationName:
        type: string
      applicationVersion:
        type: string
      geoLocalization:
        type: string
      ipAddress:
        type: string
      browserJavascriptEnabled:
        type: string
    additionalProperties: false
    description: Object that defines the customer device information.
  ExtendedInfo:
    type: object
    properties:
      key:
        type: string
      value:
        type: string
    description: Key value tuple.
  Info:
    properties:
      deviceInfo:
        $ref: '#/definitions/DeviceInfo'
        description: Object that defines the customers device predefined information.
          Check the DeviceInfo definition.
      customerInfo:
        type: array
        items:
          $ref: '#/definitions/ExtendedInfo'
        description: Key Value tuple array.
    additionalProperties: false
    description: Object that defines the transaction additional information
  Merchant:
    type: object
    properties:
      merchantURL:
        type: string
        description: Merchant Shop URL for redirect.
    description: Merchant
  RequestPayment:
    properties:
      userAcceptanceIndicator:
        type: boolean
        example: ""
        description: Indicates if the user has accepted the Terms and Conditions,
          in order to continue with the payment.
      gatewayId:
        type: string
        example: ""
        description: Payment Channel identifier for the channel the Customer is going
          to use for their payment.
      info:
        $ref: '#/definitions/Info'
      merchant:
        $ref: '#/definitions/Merchant'
    additionalProperties: false
    description: Object that defines the payment operation request fields
  ResponsePayment:
    properties:
      transactionID:
        type: string
        description: Backend unique identify of the transaction.
        example: 42f59038f3f14e618d091da8bf3b717e9999
      execution:
        description: Object that defines an Execution. See the Execution definition.
        example: ""
        $ref: '#/definitions/Execution'
      redirectURL:
        type: string
        description: An address to continue the transaction started by the pre-transaction
          message.
      paymentStatus:
        type: string
        description: Status of the payment.
      returnStatus:
        description: Object that defines the Status of the transaction. Check the
          ReturnStatus definition.
        $ref: '#/definitions/ReturnStatus'
  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.
    additionalProperties: false
    description: Object that defines the status of the processed transaction.
  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.
tags: []
x-ibm-endpoints:
- endpointUrl: https://site3.sibsapimarket.com/sibs-qly/sibslabs
  type:
  - production
  - development
- endpointUrl: https://api.qly.sibspayments.com:11501/sibs-qly/sibslabs
  type:
  - production
  - development
- endpointUrl: https://site4.sibsapimarket.com/sibs-qly/sibslabs
  type:
  - production
  - development
...