---
swagger: "2.0"
info:
  x-ibm-name: partner-account-liens-api
  title: Partner Account Liens API
  version: 1.1.1
  contact:
    name: API developer
    email: apideveloper@rakbank.ae
  description: "This API is available to Partner Institutions to create a lien on
    their customer's RAKBANK account, when the customer uses the corresponding
    debit card, issued by the partner, in a POS transaction.\nThe lien will be lifted
    and the account would be debited as part of Master & Visa settlement process.
    \n  \n\n\tVersion 1.1.0\n\t\n  - For CreateAccountLienById, PUT method changed
    to POST since operation is not idempotent. If duplicate lien_id with same hold_indicator
    is passed in the request, transaction will be rejected with a Response code 20405
    indicating "Duplicate Transaction". In case a previously created lien
    needs to be negated, pass the same lien_id and hold_indicator as "N"."
  name: ""
schemes:
- https
host: sandboxapi.rakbank.ae
basePath: /v1
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  oauth:
    type: oauth2
    description: ""
    flow: application
    scopes:
      account_liens: Place Lien on Account
    tokenUrl: https://sandboxapi.rakbank.ae/rb/api/oauth2/token
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
- clientIdHeader: []
  oauth:
  - account_liens
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /accounts/{account_id}/liens:
    post:
      responses:
        200:
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/account_liens_response'
        401:
          description: UnAuthorized
          schema:
            $ref: '#/definitions/error_response'
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/error_response'
        422:
          description: Error
          schema:
            $ref: '#/definitions/error_response'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/error_response'
      operationId: CreateAccountLienById
      description: Place a lien on account by passing the lien id
      parameters:
      - name: liens
        required: true
        in: body
        schema:
          $ref: '#/definitions/liens'
        description: Lien to be placed
    parameters:
    - name: MsgId
      type: string
      required: true
      in: header
      maxLength: 50
      description: Unique Id sent by client. Value should be a unique identifier of
        the request in UUID format.
    - name: account_id
      type: string
      required: true
      maxLength: 13
      in: path
      description: Account id of the customer on which lien to be placed. Masked value
        should be passed in the UAT and Production environments. For information on
        the masking logic to be followed, see <a href="/security/#masking-logic">Masking
        Logic</a>
definitions:
  liens:
    properties:
      lien_id:
        type: string
        maxLength: 25
        description: Lien Id of the lien to be placed.
        example: 12323
      lien_amount:
        description: Holds the lien amount.
        $ref: '#/definitions/value'
      hold_indicator:
        type: string
        enum:
        - P
        - "N"
        description: 'Allowed values: ''P'' - for positive lien, ''N'' - for negative
          lien'
        example: "N"
      value_date:
        type: string
        description: Holds value date of the transaction in ISO 8601 format YYYY-MM-DD.
        format: date
        example: "2019-02-01"
      lien_reason_code:
        type: string
        maxLength: 5
        description: Reason code for placing the lien.
        example: AUT
      remarks:
        type: string
        maxLength: 50
        description: Remarks for the lien transaction.
        example: "12334"
      expiry_date:
        type: string
        description: Expiry date of the lien in ISO 8601 format YYYY-MM-DD.
        format: date
        example: "2019-02-01"
    additionalProperties: false
    required:
    - lien_id
    - lien_amount
    - hold_indicator
    - value_date
    - lien_reason_code
  account_liens_response:
    description: Response object.
    properties:
      lien_id:
        type: string
        maxLength: 25
        description: Lien Id of the lien placed.
        example: 12323
      value_date:
        type: string
        description: Holds value date of the transaction in ISO 8601 format YYYY-MM-DD.
        format: date
        example: "2019-02-01"
    additionalProperties: false
    required:
    - lien_id
    - value_date
  value:
    properties:
      amount:
        type: string
        description: amount
        maxLength: 20
        example: "200.00"
      currency:
        type: string
        description: currency
        maxLength: 3
        example: AED
    additionalProperties: false
    description: Amount details
    required:
    - amount
    - currency
  error_response:
    properties:
      status:
        type: string
        description: HTTP Status
      response_code:
        type: string
        description: API specific error code
      property:
        type: string
      response_message:
        type: string
        description: brief type of the error
      description:
        type: string
        description: detailed description of the error
    additionalProperties: false
    description: Response in case of error
    required:
    - status
    - response_code
    - response_message
tags: []
x-ibm-endpoints:
- endpointUrl: https://sandboxapi.rakbank.ae/sb/api
  type:
  - production
  - development
...