---
swagger: "2.0"
info:
  x-ibm-name: partner-h2h-transaction-status-api
  title: Partner H2H Transaction Status API
  version: 1.0.0
  description: API for H2H partners to fetch transaction status
  name: ""
schemes:
- https
host: sandboxapi.rakbank.ae
basePath: /v1/h2h
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  oauth2:
    type: oauth2
    description: ""
    flow: application
    scopes:
      enquiry:read: enquiry:read
    tokenUrl: https://sandboxapi.rakbank.ae/sb/api/v1/h2h_auth/token
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
- clientIdHeader: []
  oauth2:
  - enquiry:read
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /transactions/{trans_ref_id}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/transaction_status_resp'
        422:
          description: Error Response
          schema:
            $ref: '#/definitions/error_response'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/error_response'
      operationId: getTransactionStatus
    parameters:
    - name: trans_ref_id
      type: string
      maxLength: 10
      required: true
      in: path
      description: The reference ID of transaction.
    - name: MsgId
      type: string
      maxLength: 50
      required: true
      in: header
      description: Unique Id sent from client. Value should be a unique identifier
        of the request in UUID format.
definitions:
  transaction_status_resp:
    properties:
      unique_tran_ref_number:
        type: string
        minLength: 0
        maxLength: 21
        description: The unique transaction reference number
        example: "123456789"
      transaction_date:
        type: string
        minLength: 0
        maxLength: 10
        description: The date of the transaction
      status_message:
        type: string
        minLength: 0
        maxLength: 50
        description: The status message of transaction
        example: Successful
      xf_req_id:
        type: string
        minLength: 0
        maxLength: 10
        description: The internet banking reference number
        example: "862677"
      host_txn_id:
        type: string
        minLength: 0
        maxLength: 30
        description: The host transaction reference number
        example: 000000000986
      status:
        type: string
        minLength: 0
        maxLength: 3
        description: The status of the transaction. S - Success, F-  Failure, P -
          Processing
        example: S
      ccn_status:
        type: string
        minLength: 0
        maxLength: 1
        description: The outward payment status. Valid value will be “S” if credit
          is successful and “F” if the credit is failure.
        example: F
      ccn_fail_reason:
        type: string
        minLength: 0
        maxLength: 100
        description: Description of the CCN failure. Applicable only if ccn_status
          is “F”
        example: Insufficient balance
      failure_reason:
        type: string
        minLength: 0
        maxLength: 64
        description: The reason for the failure
        example: Insufficient balance
    additionalProperties: false
  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
        example: ""
      description:
        type: string
        description: detailed description of the error
    additionalProperties: false
    required:
    - response_code
    - status
    - response_message
    description: Response in case of error
tags: []
x-ibm-endpoints:
- endpointUrl: https://sandboxapi.rakbank.ae/sb/api
  type:
  - production
  - development
...