---
swagger: "2.0"
info:
  x-ibm-name: partner-h2h-transactions-posting-api
  title: Partner H2H Transactions Posting API
  version: 1.0.0
  description: API for H2H partners to post a new transaction
  contact:
    name: API developer
    email: apideveloper@rakbank.ae
  name: ""
schemes:
- https
host: sandboxapi.rakbank.ae
basePath: /v1/h2h
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  oauth:
    type: oauth2
    description: ""
    flow: application
    scopes:
      transaction:write: transaction:write
    tokenUrl: https://testapi.rakbank.ae/rb/api/oauth2/token
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
- clientIdHeader: []
  oauth:
  - transaction:write
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /transactions:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/transaction_posting_response'
        422:
          description: Error Response
          schema:
            $ref: '#/definitions/error_response'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/error_response'
      summary: Post new transaction
      description: This endpoint will used used by H2H partners to post a new transaction
      operationId: createTransaction
      parameters:
      - name: transaction_posting_request
        required: true
        in: body
        schema:
          $ref: '#/definitions/transaction_posting_request'
        description: request body
    parameters:
    - 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:
  transaction_posting_request:
    properties:
      txn_type_identifier:
        type: string
        minLength: 1
        maxLength: 3
        example: WBP
        description: The field to specify the type of transaction.
      debit_account_number:
        type: string
        minLength: 1
        maxLength: 13
        example: "0024116715123"
        description: Account from where the transaction amount will be deducted
      beneficiary_nick_name:
        type: string
        minLength: 1
        maxLength: 64
        example: EZ Corp
        description: Personalized name for a beneficiary
      credit_account_number:
        type: string
        minLength: 1
        maxLength: 34
        example: "0024116715100"
        description: Account where the transaction amount will be credited
      remitting_currency:
        type: string
        minLength: 0
        maxLength: 3
        example: AED
        description: Currency in which the receiver will receive the amount. Mandatory
          field in case of Within UAE, Outside UAE Transaction.
      txn_currency:
        type: string
        minLength: 1
        maxLength: 3
        example: AED
        description: Transaction currency
      txn_amount:
        type: string
        minLength: 1
        maxLength: 15
        example: "121.23"
        description: Amount to be transferred
      charge_indicator:
        type: string
        minLength: 0
        maxLength: 1
        example: Shared
        description: The field specifies whether the transaction fees will be borne
          by the sender, the recipient, or shared between both parties. Mandatory
          field in case of Within UAE, Outside UAE Transaction.
      beneficiary_resident_country:
        type: string
        minLength: 0
        maxLength: 2
        example: India
        description: Resident country of Beneficiary. Mandatory field in case of Within
          UAE, Outside UAE Transaction.
      reason:
        type: string
        minLength: 0
        maxLength: 3
        example: Own account transfer
        description: Code explaining the reason for the transaction. Mandatory field
          in case of Within UAE, Outside UAE Transaction.
      details_of_payment_1:
        type: string
        minLength: 0
        maxLength: 33
        description: Additional remarks about the payment.
      details_of_payment_2:
        type: string
        minLength: 0
        maxLength: 33
        description: Unique reference number to identify the transaction related traces
          in all the system.
      details_of_payment_3:
        type: string
        minLength: 0
        maxLength: 33
        description: This field holds the signing mandate roles.
      beneficiary_name:
        type: string
        minLength: 1
        maxLength: 64
        example: Jane Doe
        description: The name of the beneficiary.
      beneficiary_bank_country:
        type: string
        minLength: 0
        maxLength: 2
        example: India
        description: The country code of the beneficiary’s bank. Mandatory field in
          case of Within UAE, Outside UAE Transaction.
      beneficiary_bank_name:
        type: string
        minLength: 0
        maxLength: 35
        example: HDFC
        description: The name of the beneficiary’s bank. Mandatory field in case of
          Within UAE, Outside UAE Transaction.
      beneficiary_bank_branch:
        type: string
        minLength: 0
        maxLength: 32
        example: Silver Park
        description: The branch of the beneficiary’s bank. Mandatory field in case
          of Within UAE, Outside UAE Transaction.
      beneficiary_bank_city:
        type: string
        minLength: 0
        maxLength: 32
        example: Mumbai
        description: The city where the beneficiary’s bank is located. Mandatory field
          in case of Within UAE, Outside UAE Transaction.
      beneficiary_bank_swift:
        type: string
        minLength: 0
        maxLength: 15
        description: The SWIFT code of the beneficiary’s bank. In international required
          to route transaction to correct bank.
      intermediary_bank_name:
        type: string
        minLength: 0
        maxLength: 35
        example: ICICI
        description: The name of the intermediary bank. bank that acts a middleman
          to process international payments between the sender's and beneficiary's
          banks. needed when there is no direct relationship between the sender's
          and beneficiary's banks. Not needed for domestic.
      intermediary_bank_swift:
        type: string
        minLength: 0
        maxLength: 15
        description: The SWIFT code of the intermediary bank, identify the intermediary
          bank in the payment chain.
      unique_txn_ref_no:
        type: string
        minLength: 1
        maxLength: 21
        example: UNIQ12345
        description: A unique reference number
      c_cif:
        type: string
        minLength: 0
        maxLength: 64
        example: "123456"
        description: Corporate CIF
      r_cif:
        type: string
        minLength: 0
        maxLength: 64
        example: "1234567"
        description: Retail CIF
      org_id:
        type: string
        minLength: 0
        maxLength: 32
        example: org12345
        description: Organization id
      free_field_1:
        type: string
        minLength: 0
        maxLength: 150
        example: Free field 1
        description: Free Field 1
      free_field_2:
        type: string
        minLength: 0
        maxLength: 150
        example: Free field 2
        description: Free Field 2
      free_field_3:
        type: string
        minLength: 0
        maxLength: 150
        example: Free field 3
        description: Free Field 3
      free_field_4:
        type: string
        minLength: 0
        maxLength: 150
        example: Free field 4
        description: Free Field 4
      free_field_5:
        type: string
        minLength: 0
        maxLength: 150
        example: Free field 5
        description: Free Field 5
    additionalProperties: false
    required:
    - txn_type_identifier
    - debit_account_number
    - beneficiary_nick_name
    - credit_account_number
    - txn_currency
    - txn_amount
    - beneficiary_name
    - unique_txn_ref_no
    - org_id
    - c_cif
    - r_cif
  transaction_posting_response:
    properties:
      db_reference_id:
        type: string
        maxLength: 10
        example: "123456789"
        description: Reference id of the transaction.
      status:
        type: string
        example: COMPLETED
        description: Current status of transaction.
    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
...