---
swagger: "2.0"
info:
  x-ibm-name: rakmoneytransfer-beneficiary-banks-api
  title: RAKMoneyTransfer Beneficiary Banks API
  version: 1.1.0
  description: "This is a utilitarian API .This API includes the below functionalities.\n1.
    To fetch the beneficiary bank search parameters required for a specific country
    by passing the ISO 2 character country code.\n2. To fetch the list of banks for
    a specific search criteria by passing search values entered by the customer for
    the bank search parameters obtained in the /other_banks/params endpoint.\n\n\n\tVersion
    1.1.0\n\t\n  - Added other bank currency in request of both the operations."
  contact:
    name: API Developer
    email: apideveloper@rakbank.ae
  name: ""
schemes:
- https
host: testapi.rakbank.ae
basePath: /v1
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  oauth:
    type: oauth2
    description: ""
    flow: application
    scopes:
      utility_other_banks: To retrieve bank search parameters and list of beneficiary
        banks
    tokenUrl: https://sandboxapi.rakbank.ae/sb/api/v1/partner_auth/token
  clientId:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- oauth:
  - utility_other_banks
  clientId: []
x-ibm-configuration:
  testable: false
  enforced: true
  phase: realized
paths:
  /other_banks/query:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/other_banks_query_response'
        422:
          description: Error Response
          schema:
            $ref: '#/definitions/error_response'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/error_response'
      description: This operation of the API allows to query the list of banks for
        the specific country and currency code by providing the values.
      operationId: GetOtherBanksList
      parameters:
      - name: other_bank_query_request
        required: true
        in: body
        schema:
          $ref: '#/definitions/other_banks_query_request'
        description: Search parameters that will be used to fetch the list of other
          banks
      - name: MsgId
        type: string
        maxLength: 50
        required: true
        in: header
        description: Message Id for this request sent from client. Value should be
          a unique identifier of the request in UUID format
  /other_banks/params:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/other_banks_params_response'
        422:
          description: Error Response
          schema:
            $ref: '#/definitions/error_response'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/error_response'
      parameters:
      - name: other_bank_country
        type: string
        maxLength: 2
        required: true
        in: query
        description: other bank country code
      - name: MsgId
        type: string
        maxLength: 50
        required: true
        in: header
        description: Message Id for this request sent from client. Value should be
          a unique identifier of the request in UUID format
      - name: other_bank_currency
        type: string
        maxLength: 3
        required: false
        in: query
        description: Other bank currency code. Mandatory for Western Union beneficiary
      description: This operation of the API allows to fetch the other bank parameters
        required for a specific country by passing the ISO 2 character country code
        and optionally, the ISO 3 character currency code
      operationId: GetOtherBankParams
tags: []
definitions:
  query_params:
    properties:
      id:
        type: string
        minLength: 1
        maxLength: 50
        description: Unique identifier for the field
        example: other_bank_name
      value:
        type: string
        minLength: 1
        maxLength: 100
        description: This will contain the value that is specific to the unique identifier
        example: ICICI
    additionalProperties: false
    required:
    - id
    - value
    description: This contains the list of parameter to search for other banks
  error_response:
    properties:
      status:
        type: string
        description: HTTP Status
        example: "422"
      response_code:
        type: string
        description: API specific error code
        example: "20045"
      property:
        type: string
      response_message:
        type: string
        description: brief error type
        example: Business Exception
      response_description:
        type: string
        description: detailed error description
        example: other_bank_country not found
    additionalProperties: false
    required:
    - property
    - response_message
    - response_description
    - response_code
    - status
    description: Error Response details
  fields:
    properties:
      id:
        type: string
        description: unique id for the field
        example: other_bank_name
      name:
        type: string
        description: field name that needs to be displayed
        example: Bank Name
    additionalProperties: false
    description: This definition will hold the field details that are to be displayed.
  other_banks:
    properties:
      other_bank_name:
        type: string
        maxLength: 60
        description: Bank Name of the other bank
        example: PEOPLES BANK - COLOMBO
      identifier_code1:
        type: string
        maxLength: 15
        description: Remittance identifier code1  that is used to route payments to
          external systems
        example: "7135"
      identifier_code2:
        type: string
        maxLength: 15
        description: Remittance identifier code2  that is used to route payments to
          external systems
        example: "280"
      other_branch_addr1:
        type: string
        maxLength: 100
        description: Address of the other bank
        example: 15th Main,
      other_branch_name:
        type: string
        maxLength: 75
        description: Branch Name of the other bank
        example: PB-POTHUHERA
      other_branch_addr2:
        type: string
        maxLength: 100
        description: City of the other bank
        example: Colombo
    additionalProperties: false
    description: This will contain the details of the bank and its parameter values
  other_banks_query_response:
    properties:
      other_bank_country:
        type: string
        maxLength: 2
        description: ISO 2 character country code of the other bank
        example: LK
      has_more_records:
        type: boolean
        maxLength: 4
        description: Has the search retrieved more records than the max records mentioned
          in the request. Possible values Y or N
        example: true
      fields:
        description: This array contains the list of fields for the other bank that
          need to be displayed for a specific country.
        type: array
        items:
          $ref: '#/definitions/fields'
      data:
        description: This array contains the list of other banks for a specific country
          and specific parameters provided in the request
        type: array
        items:
          $ref: '#/definitions/other_banks'
    additionalProperties: false
    description: This definition contains  list of other banks retrieved for a specific
      country code
    required:
    - other_bank_country
    - has_more_records
    - fields
    - data
  other_banks_query_request:
    properties:
      max_records:
        type: string
        minLength: 1
        maxLength: 3
        description: Max no of records to  return in the response
        example: "20"
      params:
        type: array
        maxLength: 100
        description: This array contains the search parameters and values that will
          be used to fetch the list of other banks
        items:
          $ref: '#/definitions/query_params'
      other_bank_country:
        type: string
        minLength: 1
        maxLength: 2
        description: ISO 2 character country code of the other bank
        example: IN
      other_bank_currency:
        type: string
        maxLength: 3
        description: ISO 3 character currency code of the other bank. Mandatory for
          Western Union beneficiary
        example: INR
    additionalProperties: true
    required:
    - max_records
    - params
    - other_bank_country
    description: This definition contains the search parameters that will be used
      to fetch the list of other banks
  params:
    description: This definition will contain the minimum required details for the
      parameters
    type: object
    properties:
      id:
        type: string
        maxLength: 50
        example: other_bank_name
        description: Unique identifier for the parameter
      name:
        type: string
        maxLength: 100
        example: Bank Name
        description: Display Name for the parameter
      is_mandatory:
        type: string
        example: N/Y
        description: Indicates whether this field is Mandatory.
      min_characters:
        type: string
        maxLength: 2
        example: "4"
        description: Min  characters required for the parameter
      max_characters:
        type: string
        maxLength: 2
        example: "100"
        description: Max allowed characters for the parameter
    required:
    - id
    - name
    - min_characters
    - max_characters
    - is_mandatory
  other_banks_params_response:
    description: This will contain the list of search parameters for the other banks
      for a specific country code.
    type: object
    properties:
      other_bank_country:
        type: string
        maxLength: 2
        example: IN
        description: ISO 2 character country code of the other bank
      params:
        type: array
        items:
          $ref: '#/definitions/params'
        description: This array contains the list of parameters  for the other bank
x-ibm-endpoints:
- endpointUrl: https://sandboxapi.rakbank.ae/sb/api
  type:
  - production
  - development
...