---
swagger: "2.0"
info:
  x-ibm-name: rakbank-digital-banking-beneficiaries-api
  title: RAKBANK Digital Banking Beneficiaries API
  version: 1.0.0
  description: This API can be used to fetch the list of all beneficiaries of a RAKBANK
    Digital Banking SME customer by passing his customer_id as well as fetch details
    of a beneficiary by passing the beneficiary_id. The beneficiary_id of the beneficiary
    can be used in the RAKBANK Digital Banking Transfers API to make payments to the
    beneficiary, without having to pass all details of the beneficiary again.
  contact:
    email: apideveloper@rakbank.ae
    name: API developer
  name: ""
schemes:
- https
host: sandboxapi.rakbank.ae
basePath: /v1/tpa
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  oauth:
    type: oauth2
    description: ""
    flow: accessCode
    scopes:
      beneficiaries.read: To fetch beneficiaries of the customer
    tokenUrl: https://sandboxapi.rakbank.ae/sb/api/v1/customer_signin/oauth2/token
    authorizationUrl: https://sandboxapi.rakbank.ae/sb/api/v1/customer_signin/oauth2/authorize
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
- clientIdHeader: []
  oauth:
  - beneficiaries.read
x-ibm-configuration:
  testable: true
  enforced: true
  phase: specified
paths:
  /customers/{customer_id_type}:{customer_id}/beneficiaries:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/coll_beneficiaries'
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/error_response'
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/error_response'
        422:
          description: Invalid Request
          schema:
            $ref: '#/definitions/error_response'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/error_response'
      summary: Get Beneficiaries of a customer
      operationId: GetBeneficiaries
      description: This API will return the list of beneficiaries associated with
        a customer_id.
    parameters:
    - name: MsgId
      maxLength: 50
      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: customer_id
      type: string
      enum:
      - mine
      maxLength: 20
      required: true
      in: path
      description: Customer Id of the customer who's beneficiaries are to be fetched.
        Allowed values - 'mine' - indicating logged-in customer
    - name: customer_id_type
      type: string
      enum:
      - Org_ID
      required: true
      in: path
      description: Customer Id Type. Allowed values - Org_ID
  /customers/{customer_id_type}:{customer_id}/beneficiaries/{beneficiary_id}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/beneficiaries'
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/error_response'
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/error_response'
        422:
          description: Invalid Request/Unprocessable Entity
          schema:
            $ref: '#/definitions/error_response'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/error_response'
      operationId: GetBeneficiaryById
      tags: []
      description: Retrieves a specific beneficiary's details
    parameters:
    - name: customer_id
      type: string
      enum:
      - mine
      maxLength: 20
      required: true
      in: path
      description: Customer Id of the customer who's beneficiaries are to be fetched.
        Allowed values - 'mine' - indiating logged-in customer
    - name: customer_id_type
      type: string
      enum:
      - Org_ID
      required: true
      in: path
      description: Type of the Customer Id of the customer who's beneficiaries are
        to be fetched. Allowed values - Org_ID
    - name: beneficiary_id
      type: string
      maxLength: 15
      required: true
      in: path
      description: Beneficiary id of the beneficiary
    - name: MsgId
      type: string
      maxLength: 50
      required: true
      in: header
      description: Unique Id sent by the client. Value should be a unique identifier
        of the transaction in UUID format
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: brief 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
  beneficiaries:
    description: Beneficiary object
    type: object
    properties:
      href:
        type: string
        description: href value to fetch the resource with the specific beneficiary_id.
        example: https://testapi.rakbank.ae/rb/api/v1/tpa/customers/Org_ID:mine/beneficiaries/23542346
      beneficiary_id:
        type: string
        minLength: 0
        maxLength: 10
        description: Id of the beneficiary
        example: "23542346"
      name:
        type: string
        minLength: 1
        maxLength: 80
        description: Name of the beneficiary
        example: James Gordan
      nick_name:
        type: string
        minLength: 1
        maxLength: 80
        description: Nick Name of the beneficiary
        example: James
      transfer_type:
        type: string
        enum:
        - WithinRAKBANK
        - WithinUAE
        - OutsideUAE
        description: Type of the beneficiary.
        example: OutsideUAE
      other_account_id:
        type: string
        minLength: 1
        maxLength: 34
        description: Account id or IBAN of the beneficiary.
        example: "963521478"
      other_account_currency:
        type: string
        minLength: 1
        maxLength: 3
        description: Currency of the beneficiary account.
        example: AED
      other_bank_name:
        type: string
        minLength: 1
        maxLength: 254
        description: Bank Name  of the beneficiary bank
        example: ICICI
      other_branch_name:
        type: string
        minLength: 1
        maxLength: 254
        description: Branch name of the beneficiary bank
        example: VADODARA - KARELIBAUG
      other_branch_addr1:
        type: string
        minLength: 1
        maxLength: 254
        description: Address of the other bank.
        example: 15th Main,
      other_branch_addr2:
        type: string
        minLength: 1
        maxLength: 254
        description: City of the other bank.
        example: Colombo
      other_bank_country:
        type: string
        minLength: 1
        maxLength: 2
        description: ISO 2 Character country code of the beneficiary bank
        example: AE
      other_bank_SWIFT_code:
        type: string
        minLength: 1
        maxLength: 254
        description: Beneficiary Bank SWIFT code
        example: ICICINBBNRI
      intermediary_bank_SWIFT_code:
        type: string
        minLength: 1
        maxLength: 254
        description: Intermediary bank SWIFT code
        example: ABCUIPOPL
      address:
        $ref: '#/definitions/address'
        description: Beneficiary Residence Address
    example: ""
    additionalProperties: false
    required:
    - name
    - beneficiary_id
    - nick_name
    - transfer_type
    - other_bank_name
    - other_account_id
    - other_bank_country
  address:
    description: Beneficiary Residence Address
    properties:
      line_1:
        type: string
        minLength: 1
        maxLength: 100
        description: Address line 1 of the beneficiary
      line_2:
        type: string
        minLength: 1
        maxLength: 100
        description: Address line 2 of the beneficiary
      line_3:
        type: string
        minLength: 1
        maxLength: 100
        description: Address line 3 of the beneficiary
      city:
        type: string
        minLength: 1
        maxLength: 100
        description: City of the beneficiary
      state:
        type: string
        minLength: 1
        maxLength: 100
        description: State of the beneficiary
      district:
        type: string
        minLength: 1
        maxLength: 100
        description: District of the beneficiary
      country:
        type: string
        minLength: 1
        maxLength: 2
        description: Country of the beneficiary. ISO 2 Character Country Codes.
        example: IN
    additionalProperties: false
    required:
    - country
  coll_beneficiaries:
    properties:
      total_count:
        type: integer
        description: Holds the total no. of beneficiaries returned
        example: 10
      href:
        type: string
        description: href value to fetch this resource
        example: https://testapi.rakbank.ae/rb/api/v1/tpa/customers/Org_ID:mine/beneficiaries
      beneficiaries:
        type: array
        items:
          $ref: '#/definitions/beneficiaries'
        description: array of beneficiaries
    additionalProperties: false
    description: Returns the collection of beneficiaries along with some meta data
    required:
    - href
    - beneficiaries
tags: []
x-ibm-endpoints:
- endpointUrl: https://sandboxapi.rakbank.ae/sb/api
  type:
  - production
  - development
...