---
swagger: "2.0"
info:
  x-ibm-name: sibs-mbway-mandate-sandbox-api
  title: MB WAY Mandate
  version: 2.0.0
  description: The Create MB WAY Mandate, allows the Merchant to request MB WAY Mandate
    creation, associated with the mobile phone number sent within the request and
    the mandate type. The response indicates the MB WAY Mandate Identification.
schemes:
- https
basePath: /sibs/spg/v2
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  clientid:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- clientid: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /mbway-mandates/creation:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/CreateMBWAYMandateResponse'
      operationId: createMbwayMandate
      parameters:
      - name: input
        required: true
        in: body
        schema:
          $ref: '#/definitions/CreateMBWAYMandateRequest'
      - name: authorization
        type: string
        required: true
        in: header
      - name: Signature
        type: string
        description: For now, the type of HMAC used will be SHA2 (SHA512). base64
        required: false
        maxLength: 128
        in: header
      description: Performs a Merchant request to obtain a list of MB WAY Mandates.
      tags:
      - MB WAY Mandate Merchant List
      summary: MB WAY Mandate Merchant List
  /mbway-mandates/{id}/creation:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/CreateMBWAYMandateResponse'
      operationId: createMbwayMandateById
      parameters:
      - name: input
        required: true
        in: body
        schema:
          $ref: '#/definitions/CreateMBWAYMandateRequest'
      - name: authorization
        type: string
        required: true
        in: header
      - name: id
        type: string
        required: true
        in: path
        description: Transaction Id. Applicable when a previous checkout is performed.
      - name: Signature
        type: string
        description: For now, the type of HMAC used will be SHA2 (SHA512). base64
        required: false
        maxLength: 128
        in: header
      description: Performs a Merchant request to obtain a list of MB WAY Mandates.
      tags:
      - MB WAY Mandate Merchant List
      summary: MB WAY Mandate Merchant List
      security:
      - clientid: []
  /mbway-mandates/{original-tx-id}/cancel:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/CancelMBWAYMandateResponse'
      operationId: cancelMbwayMandate
      parameters:
      - name: input
        required: true
        in: body
        schema:
          $ref: '#/definitions/CancelMBWAYMandateRequest'
      - name: authorization
        type: string
        required: true
        in: header
      - name: original-tx-id
        type: string
        required: true
        in: path
        description: Original Transaction Id
      - name: Mbway-ID
        type: string
        required: false
        in: header
        description: Used to query a MB WAY Mandate by Alias MB WAY (phone number).
      - name: Signature
        type: string
        description: For now, the type of HMAC used will be SHA2 (SHA512). base64
        required: false
        maxLength: 128
        in: header
      description: Performs a Merchant request to cancel a specific MB WAY Mandate
        data.
      tags:
      - Cancel MB WAY Mandate
      summary: Cancel MB WAY Mandate
definitions:
  Deviceinfo:
    properties:
      browserAcceptHeader:
        type: string
        description: Browser Accept Header
      browserJavaEnabled:
        type: string
        description: Browser Java 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
      systemManufacturer:
        type: string
        description: System Manufacturer
      deviceModel:
        type: string
        description: Device Model
      deviceID:
        type: string
        description: Device Unique Identification
      deviceFingerprint:
        type: string
        description: Fingerprint of the device used in the request
      applicationName:
        type: string
        description: Application Name
      applicationVersion:
        type: string
        description: Application Name
      geoLocation:
        type: string
        description: Geolocation
        pattern: ^GEO:[-?+?(\d){1,3}.(\d){6}]{8,11};[-?+?(\d){1,3}.(\d){6}]{8,11}$
        default: GEO:1.111111;-1.111111
      ipAddress:
        type: string
        description: Browser Accept Header
      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.
    required:
    - key
    - value
  Info:
    properties:
      deviceInfo:
        $ref: '#/definitions/Deviceinfo'
        description: Object that defines the customers device predefined information.
          Check the DeviceInfo definition.
    additionalProperties: false
    description: Object that defines the transaction additional information
  MandateInput:
    required:
    - mandateType
    - customerName
    - aliasMBWAY
    properties:
      mandateType:
        type: string
        description: Mandate Type. \n Possible values are ("ONECLIK", "SUBSCRIPTION").
        enum:
        - ONECLICK
        - SUBSCRIPTION
        default: ONECLICK
      customerName:
        type: string
        maxLength: 45
        description: Customer name related to MB WAY Mandate.
      aliasMBWAY:
        type: string
        maxLength: 256
        description: Customer Alias MB WAY (customer phone number).
    additionalProperties: false
    description: Object that defines a MB WAY Mandate.
  Merchant:
    required:
    - terminalId
    - merchantTransactionId
    properties:
      terminalId:
        type: integer
        example: "47215"
        description: Merchant Terminal Identification.
        format: int32
        maxLength: 10
      channel:
        type: string
        description: Merchant channel.
        example: web
      merchantTransactionId:
        type: string
        description: Unique Id used by the Merchant.
        example: 863b730df285443f9a60ca404e0085fd1234
        maxLength: 35
      transactionDescription:
        type: string
        description: Merchant Transaction Short Description.
    additionalProperties: false
  CreateMBWAYMandateRequest:
    required:
    - merchant
    - mandate
    properties:
      info:
        allOf:
        - $ref: '#/definitions/Info'
        - type: object
          properties:
            customerInfo:
              type: array
              items:
                $ref: '#/definitions/ExtendedInfo'
              description: Key Value tuple array.
        description: Object that defines the transaction additional information.
      merchant:
        description: Object that defines a Merchant.
        $ref: '#/definitions/Merchant'
      mandate:
        description: Object that defines a MB WAY Mandate.
        $ref: '#/definitions/MandateInput'
    additionalProperties: false
    description: Create MB WAY Mandates
  CreateMBWAYMandateResponse:
    required:
    - returnStatus
    - execution
    properties:
      returnStatus:
        description: Object that defines the Status of the transaction. Check the
          ReturnStatus definition.
        $ref: '#/definitions/ReturnStatus'
      transactionId:
        type: string
        description: Unique identify of the transaction.
        example: 42f59038f3f14e618d091da8bf3b717e9999
      transactionSignature:
        type: string
        example: 42f59038f3f14e618d091da8bf3b717e9999
      mandate:
        description: Object that defines a MB WAY Mandate. Present when MB WAY Mandate
          is found.
        type: object
        required:
        - mandateId
        properties:
          mandateId:
            type: string
            description: MB WAY Mandate Identification.
            pattern: ^[a-zA-Z0-9]+
            default: "9999999999999999999999999999999999999999999999999999999999999999"
            maxLength: 64
      execution:
        description: Object that encapsulates technical execution information.
        $ref: '#/definitions/Execution'
    additionalProperties: false
    description: Object that defines a MB WAY Mandate
  CancelMBWAYMandateRequest:
    required:
    - merchant
    properties:
      info:
        allOf:
        - $ref: '#/definitions/Info'
        - type: object
          properties:
            customerInfo:
              type: array
              items:
                $ref: '#/definitions/ExtendedInfo'
              description: Key Value tuple array.
        description: Object that defines the transaction additional information.
      merchant:
        description: Object that defines a Merchant.
        $ref: '#/definitions/Merchant'
    additionalProperties: false
    description: Object that defines a Cancel MB WAY Mandate
  CancelMBWAYMandateResponse:
    required:
    - returnStatus
    - execution
    properties:
      returnStatus:
        description: Object that defines the Status of the transaction. Check the
          ReturnStatus definition.
        $ref: '#/definitions/ReturnStatus'
      transactionId:
        type: string
        description: Unique identify of the transaction.
        example: 42f59038f3f14e618d091da8bf3b717e9999
      transactionSignature:
        type: string
        example: 42f59038f3f14e618d091da8bf3b717e9999
      hmac:
        type: string
        maxLength: 128
        description: For now, the type of HMAC used will be SHA2 (SHA512).
      execution:
        description: Object that defines an Execution. See the Execution definition.
        $ref: '#/definitions/Execution'
    additionalProperties: false
    description: Object that defines a Cancel MB WAY Mandate
  ReturnStatus:
    required:
    - statusCode
    - statusMsg
    - statusDescription
    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: 'Describes the status of the request. (Attention: it doesn''t describe
      the state of the transaction itself)'
  Execution:
    required:
    - startTime
    - endTime
    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
...