---
swagger: "2.0"
info:
  x-ibm-name: partner-fetch-beneficiary-fields-api
  title: Partner Fetch Beneficiary Fields API
  version: 1.2.0
  description: "This is a utilitarian API .This API includes the below functionalities.\n1.
    To fetch the beneficiary field list for a specific country by passing the ISO
    2 character country code, ISO 3 character Currency Code and Payment Type.\n2.
    To fetch the list of values for the particular field by passing FieldId that is
    obtained in the /fetch/field_lists endpoint.\n\n\tVersion 1.1.0\n\n  - Added two
    new fields display_value and value in the response for operation FetchFieldLists.\n\n\n\tVersion
    1.2.0\n\n  - Added a new field beneficiary_id in the request for operation FetchFieldValues."
  name: ""
schemes:
- https
host: sandboxapi.rakbank.ae
basePath: /v1
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  oauth:
    type: oauth2
    description: ""
    flow: application
    scopes:
      fetch_fields: To retrieve beneficiary fields and list
    tokenUrl: https://sandboxapi.rakbank.ae/rb/api/v1/partner_auth/token
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
- clientIdHeader: []
  oauth:
  - fetch_fields
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /fetch/field_values:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/fetch_field_values_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: FetchFieldValues
      description: Returns the list of values for the particular field if the FieldType
        is Combo.
      parameters:
      - name: MsgId
        type: string
        required: true
        in: header
        description: Unique Id sent by the client. Value should be a unique identifier
          of the transaction in UUID format
      - name: beneficiary_fields_request
        required: true
        in: body
        schema:
          $ref: '#/definitions/beneficiary_fields_request'
  /fetch/field_lists:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/fetch_field_list_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: FetchFieldLists
      description: Returns the field information to display while adding or updating
        the beneficiary
      parameters:
      - name: MsgId
        type: string
        required: true
        in: header
        description: Unique Id sent by the client. Value should be a unique identifier
          of the transaction in UUID format
      - name: beneficiary_fields_request
        required: false
        in: body
        schema:
          $ref: '#/definitions/beneficiary_fields_request'
definitions:
  error_response:
    properties:
      status:
        type: string
        description: HTTP Status
      response_code:
        type: string
        description: API specific error code
      property:
        type: string
        description: ""
      response_message:
        type: string
        description: breif details of the error
      description:
        type: string
        description: detailed description of the error
    additionalProperties: false
    required:
    - response_message
    - response_code
    - status
    description: Response in case of error
  beneficiary_fields_request:
    properties:
      country_code:
        type: string
        description: ISO 2 letter country code
        example: IN
        maxLength: 2
      currency_code:
        type: string
        description: ISO 3 letter currency code
        example: INR
        maxLength: 3
      payment_type:
        type: string
        enum:
        - C
        - A
        - W
        maxLength: 1
        description: |
          Payment Types. Values can include :
          - "C" - Cash,
          - "A" - Account Transfer,
          - "W" - Wallet
        example: C
      field_id:
        type: string
        maxLength: 50
        description: Unique Identifier to identify the field. Required in the FetchFieldValues
          operation.
        example: BeneCity
      reference_value:
        type: string
        maxLength: 50
        description: Value selected by the user in the ReferenceFor field. Required
          in the FetchFieldValues operation.
      beneficiary_id:
        type: string
        description: Mandatory for field_id “PURPOSE”. For getting list of purposes
          during RAKMoneyTransfer. Used only for FetchFieldValues operation.
    additionalProperties: false
    required:
    - country_code
    - currency_code
    - payment_type
  fetch_field_list_response:
    type: array
    items:
      $ref: '#/definitions/field_list'
  fetch_field_values_response:
    type: array
    items:
      $ref: '#/definitions/display_details'
  display_details:
    properties:
      display_value:
        type: string
        maxLength: 100
        description: Value to display for the user.
        example: Arizona
      value:
        type: string
        maxLength: 50
        description: Value for the selection which should pass for the field.
        example: Ari
    additionalProperties: false
    required:
    - display_value
    - value
  field_list:
    properties:
      field_id:
        type: string
        maxLength: 50
        example: BenfFirstName
        description: Unique identifier to identify the field. Refer annexures
      field_name:
        type: string
        maxLength: 100
        example: BeneficiaryName
        description: Display Name for the field
      field_max_length:
        type: string
        maxLength: 3
        description: Max length filed can hold.
        example: "75"
      field_mandatory:
        type: string
        maxLength: 1
        description: 'Mandatory Condtions: Possible values Y or N'
        example: "Y"
      field_type:
        type: string
        maxLength: 15
        description: DataType for the field. Possible values are String/Decimal/Combo  If
          the field is combo GET_FIELD_VALUE_BENE API should be called to get the
          value list.
        example: String
      reference_for:
        type: string
        maxLength: 50
        description: 'Whether this particular field is the reference for corresponding
          field value retrieval. Ex: state list?city list'
      priority:
        type: string
        maxLength: 2
        description: Order for the field placement
        example: "1"
      display_value:
        type: string
        maxLength: 100
        description: Value to display for the user.
        example: Arizona
      value:
        type: string
        maxLength: 50
        description: Value for the selection which should pass for the field.
        example: Ari
    additionalProperties: false
    required:
    - field_id
    - field_name
    - field_max_length
    - field_mandatory
    - field_type
    - priority
tags: []
x-ibm-endpoints:
- endpointUrl: https://sandboxapi.rakbank.ae/sb/api
  type:
  - production
  - development
...