---
swagger: "2.0"
info:
  x-ibm-name: account-transactions-api
  title: Account Transactions API
  version: 1.0.2
  contact:
    name: API developer
    email: apideveloper@rakbank.ae
  description: "This API is to get account transactions history of an account with
    input criteria as Date range (start_date,end_date). If date range is not sent
    then the last  'n' transactions (where 'n' is the page_size)
    is returned. Further filtering can be done by transaction_type to return only
    Debit or Credit transactions.\n\n\n\tVersion 1.0.1 :\n\n\t\n  - Updated the path
    to <i>accounts/{account_id}/transactions</i> instead of <i>account-transactions/{account_id}</i>\n
    \ - <i>id</i> changed to <i>transaction_id</i> inside
    transactions\n  \n\t\n\tVersion 1.0.2 :\n\n  - Response returns coll_transactions
    which a collection of transactions along with some metadata information\n  - Use
    the href_next to fetch the next page in the collection\n\n\n<h3>OAuth Metadata
    details</h3>\nOAuth metadata parameter to be passed at the time of generating
    access token using <a href="/partner-authentication">Partner Authentication
    API</a> for client credential grant type is mentioned below. For information
    on OAuth Metadata, see <a href="/security/#oauth-metadata-partnerauth">About
    the OAuth Metadata</a>\n<p class="oauth_metadata">oauth_metadata.account_id
    : {account_id}</p>"
  name: ""
schemes:
- https
host: sandboxapi.rakbank.ae
basePath: /v1
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  OAuth1:
    type: oauth2
    description: ""
    flow: application
    scopes:
      account_transactions: Fetch  account transactions
    tokenUrl: https://sandboxapi.rakbank.ae/rb/api/v1/partner_auth/token
  OAuth:
    type: oauth2
    description: ""
    flow: accessCode
    scopes:
      account_transactions: Fetch  account transactions
    tokenUrl: https://sandboxapi.rakbank.ae/rb/api/v1/customer_signin/oauth2/token
    authorizationUrl: https://sandboxapi.rakbank.ae/rb/api/v1/customer_signin/oauth2/authorize
  Client-Id:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
- Client-Id: []
  OAuth:
  - account_transactions
  OAuth1:
  - account_transactions
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /accounts/{account_id}/transactions:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/coll_transactions'
        422:
          description: Error
          schema:
            $ref: '#/definitions/error_response'
        500:
          description: Internal Sever Error
          schema:
            $ref: '#/definitions/error_response'
      operationId: GetAccountTransactions
      description: Get Transaction details by passing the account id with Start Date,
        To Date range or Last N number of Transactions .
      parameters:
      - name: start_date
        type: string
        format: date
        required: false
        in: query
        description: Start date of the filter
      - name: end_date
        type: string
        format: date
        required: false
        in: query
        description: End date of the filter
      - name: page_size
        type: integer
        maximum: 100
        required: true
        in: query
        description: number of transactions in a page
      - name: page_index
        type: integer
        maximum: 1000
        required: false
        in: query
        description: page index
      - name: transaction_type
        type: string
        enum:
        - D
        - C
        - B
        required: false
        in: query
        description: 'transaction type indicator. Allowed values: C/D/B'
    parameters:
    - name: account_id
      type: string
      maxLength: 13
      required: true
      in: path
      description: Account id of the customer on which transactions are returned.
        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>
    - name: MsgId
      type: string
      maxLength: 50
      required: true
      in: header
      description: Unique Id sent by client. Value should be a unique identifier of
        the request in UUID format.
definitions:
  transactions:
    properties:
      transaction_id:
        type: string
        maxLength: 32
        description: Holds transaction id of the transaction.
        example: M216
      transaction_date:
        type: string
        description: Holds transaction date
        format: date
        example: "2019-02-01"
      posting_date:
        type: string
        description: Holds transaction posted date
        format: date
        example: "2019-02-01"
      value_date:
        type: string
        description: Holds value date of the transaction
        format: date
        example: "2019-02-01"
      transaction_desc:
        type: string
        maxLength: 210
        description: Holds transaction narrations
        example: 'GOLD UNITS BOUGHT||FROM 0037100178001|Buy Rate: AED 160.866971 /
          g||'
      transaction_amount:
        description: Holds transaction amount
        $ref: '#/definitions/value'
        example: "50"
      original_amount:
        description: Holds Reference amount of the transaction.
        $ref: '#/definitions/value'
        example: "752"
      transaction_type:
        type: string
        maxLength: 2
        description: Holds transaction type  Debit or Credit.
        example: D
      running_balance:
        description: Holds Running balance at the instance the transaction was posted.
        $ref: '#/definitions/value'
        example: "50"
      transaction_cheque_num:
        type: string
        maxLength: 16
        description: Holds instrument ID for the transaction. In case of Cheque, it
          will have cheque number.
        example: "12334"
    additionalProperties: false
    required:
    - transaction_id
    - transaction_date
    - transaction_amount
    - transaction_desc
    - transaction_type
    description: Transaction details
  value:
    properties:
      amount:
        type: string
        description: amount
        example: "200"
      currency:
        type: string
        description: currency
        example: AED
    additionalProperties: false
    description: Transaction amount details
    required:
    - amount
  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
  coll_transactions:
    properties:
      page_size:
        type: integer
        maximum: 100
        description: Holds the page size of the currect page
        example: 25
      total_count:
        type: integer
        description: Holds the total no. of transactions for the search criteria
        example: 2500
      href:
        type: string
        description: href value to fetch this page
        example: https://sandboxapi.rakbank.ae/v1/accounts/1234567890123/transactions?start_date=2018-11-29&end_date=2018-11-29&page_size=25&page_index=1
      href_next:
        type: string
        description: href value to fetch the next page if there are more pages in
          the collection
        example: https://sandboxapi.rakbank.ae/v1/accounts/1234567890123/transactions?start_date=2018-11-29&end_date=2018-11-29&page_size=25&page_index=2
      transactions:
        type: array
        items:
          $ref: '#/definitions/transactions'
        description: array of transactions
    additionalProperties: false
    description: Returns the collection of transactions along with some meta data
    required:
    - href
tags: []
x-ibm-endpoints:
- endpointUrl: https://sandboxapi.rakbank.ae/sb/api
  type:
  - production
  - development
...