---
swagger: "2.0"
info:
  x-ibm-name: mb-service-reference-sandbox
  title: MB Service Reference
  version: 1.0.0
  description: The MB Service Reference API requests the generation of a MULTIBANCO
    Reference to a payment registered by the previous checkout, allowing your customer
    to pay on the channels available.
schemes:
- https
basePath: /sibs/spg/v1/payments
consumes:
- application/json
- text/plain
produces:
- application/json
- text/plain
security: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /{id}/service-reference/generate:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/ResponseGenerate'
      operationId: generate
      parameters:
      - name: authorization
        type: string
        required: true
        in: header
      - name: id
        type: string
        required: true
        in: path
      - name: input
        required: false
        in: body
        schema:
          $ref: '#/definitions/RequestGenerate'
definitions:
  ActionProcessed:
    properties:
      id:
        type: string
      type:
        type: string
        example: THREEDS_METHOD
        enum:
        - THREEDS_METHOD
        - THREEDS_CHALLENGE
      executed:
        type: boolean
    additionalProperties: false
  ActionReponse:
    properties:
      id:
        type: string
      type:
        type: string
      data:
        $ref: '#/definitions/Data'
    additionalProperties: false
  Amount:
    properties:
      value:
        type: number
        description: Amount of the transaction.
        example: 23.450000
        format: double
      currency:
        type: string
        description: Currency used in the transaction.
        example: EUR
    additionalProperties: false
    description: Object that defines an amount.
  Data:
    properties:
      url:
        type: string
      params:
        type: array
        items:
          $ref: '#/definitions/Parameter'
    additionalProperties: false
  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
    additionalProperties: false
    description: Object that defines the customer device information.
  ExtendedInfo:
    type: object
    properties:
      key:
        type: string
      value:
        type: string
    description: Key value tuple.
  PaymentReference:
    properties:
      reference:
        type: string
      entity:
        type: string
      paymentEntity:
        type: string
      amount:
        $ref: '#/definitions/Amount'
    additionalProperties: false
  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:
    properties:
      terminalId:
        type: integer
        example: "21451"
        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.
  Parameter:
    type: object
    properties:
      name:
        type: string
      data:
        type: string
    additionalProperties: false
  RequestGenerate:
    properties:
      info:
        description: Object that defines the aditional info provided by the merchant.
          Check the Info definition.
        $ref: '#/definitions/Info'
      actionProcessed:
        description: Action to be processed
        $ref: '#/definitions/ActionProcessed'
    additionalProperties: false
    description: Object that defines the payment operation request fields
  ResponseGenerate:
    properties:
      returnStatus:
        description: Object that defines the Status of the transaction. Check the
          ReturnStatus definition.
        $ref: '#/definitions/ReturnStatus'
      transactionID:
        type: string
        description: Backend unique identify of the transaction.
        example: 42f59038f3f14e618d091da8bf3b717e9999
      merchant:
        description: Object that defines the Merchant. Check the Merchant definition.
        $ref: '#/definitions/Merchant'
      paymentType:
        type: string
        description: Generate type used
      paymentReference:
        $ref: '#/definitions/PaymentReference'
        description: Object that defines the Generated Reference. Check the PaymentReference
          definition.
      actionResponse:
        description: Action to perform
        $ref: '#/definitions/ActionReponse'
      execution:
        description: Object that defines an Execution. See the Execution definition.
        example: ""
        $ref: '#/definitions/Execution'
      paymentStatus:
        type: string
        description: Status of the payment.
    additionalProperties: false
  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://sandbox.sibspayments.com
  type:
  - production
  - development
...