---
swagger: "2.0"
info:
  description: This API will accept multiple transfers and process them in async mode
  version: 1.0.0
  x-ibm-name: ExecutePaymentInitiationTransactionMultipleTransfersAsync
  title: ExecutePaymentInitiationTransactionMultipleTransfersAsync
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/paymentInitiation/multipleTransfers/async:
    post:
      summary: Execute Multiple Transfers
      description: This API will accept multiple transfers and process them in async
        mode
      operationId: ExecutePaymentInitiationTransactionMultipleTransfersAsync
      tags:
      - Payments
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: ExecutePaymentInitiationTransactionMultipleTransfersAsyncRequest
        in: body
        description: ExecutePaymentInitiationTransactionMultipleTransfersAsyncRequest
        required: true
        schema:
          $ref: '#/definitions/ExecutePaymentInitiationTransactionMultipleTransfersAsyncRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/ExecutePaymentInitiationTransactionMultipleTransfersAsyncResponse'
        201:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><tr><td></td><td></td><td>Created</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        400:
          description: <table><tr><td>error</td><td>InvalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>error</td><td>InvalidRequest</td><td>Invalid
            source account</td></tr><tr><td>error</td><td>InvalidRequest</td><td>Invalid
            payee id</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>fatal </td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr><tr><td>fatal </td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  ExecutePaymentInitiationTransactionMultipleTransfersAsyncRequest:
    properties:
      bundleId:
        description: This is bundle id or unique identifier for bulk transfers
        type: string
        example: 89789789
      totalTransferAmount:
        description: This is total transfer amount
        type: number
        format: double
        example: 100
      transferType:
        description: This is type of transfers
        type: string
        example: INTERNAL
      internalDomesticPayments:
        type: array
        items:
          $ref: '#/definitions/InternalDomesticPayments'
      externalDomesticPayments:
        type: array
        items:
          $ref: '#/definitions/ExternalDomesticPayments'
  InternalDomesticPayments:
    properties:
      sourceAccountId:
        description: The source account identifier in encrypted format.Typically,
          this is not displayed to the customer.
        type: string
        example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d
      transactionAmount:
        description: Refers to the total amount of the transaction.This includes all
          the fee and charges.
        type: number
        format: double
        example: 4500.250000
      transferCurrencyIndicator:
        description: Indicator to specify whether the transfer is in source or destination
          account currency.The acceptable forms of remittance for a given payments
          and transfer transaction.This is a reference data field. Please use /v1/apac/utilities/referenceData/{transferCurrencyIndicator}
          resource to get valid value of this field with description. You can use
          transferCurrencyIndicator as the referenceCode parameter to retrieve the
          values
        type: string
        example: SOURCE_ACCOUNT_CURRENCY
      payeeId:
        description: The payee identifier in encrypted format.Typically, this is not
          displayed to the customer.
        type: string
        example: C$0003019202$AU$XX$01000540000001
      chargeBearer:
        description: Field to identify charge bearer.The acceptable forms of remittance
          for a given payments and transfer transaction.This is a reference data field.
          Please use /v1/apac/utilities/referenceData/{chargeBearer} resource to get
          valid value of this field with description. You can use chargeBearer as
          the referenceCode parameter to retrieve the values
        type: string
        example: BENEFICIARY
      foreignExchangeReferenceNumber:
        description: Fx deal reference number
        type: string
        example: 12345678
      remarks:
        description: Payment notes. Free text from screen$$O
        type: string
      transferPurpose:
        description: Purpose of transfer. Applicable if paymentMethod is GIRO, FAST.
          This is a reference data field.This is a reference data field. Please use
          /v1/apac/utilities/referenceData/{transferPurpose} resource to get valid
          value of this field with description. You can use transferPurpose as the
          referenceCode parameter to retrieve the values.
        type: string
        example: CASH_DISBURSEMENT
      futureDatedTransaction:
        $ref: '#/definitions/FutureDatedTransaction'
      standingInstruction:
        $ref: '#/definitions/StandingInstruction'
      paymentScheduleType:
        description: From various Option Support - CVT table. - Immediate -  FutureDated
          ( Date Selection ) - Future Dated Recurring ( Date Selection and Frequency
          - Last Date ) for Poland only Immediate and One Time Future Dated
        type: string
        example: IMMEDIATE
      anticipatoryPaymentFlag:
        description: This indicator will be sent by channel and help differentiate
          if payment is normal or anticipatory
        type: boolean
        example: True, False
    required:
    - sourceAccountId
    - transferCurrencyIndicator
    - payeeId
  FutureDatedTransaction:
    properties:
      scheduleDate:
        description: Date on which the future transaction is scheduled in ISO 8601
          format YYYY-MM-DD.$$M
        type: string
        format: date
    required:
    - scheduleDate
  StandingInstruction:
    properties:
      standingInstructionStartDate:
        description: Date on which Future transaction will be executed / Initiated
        type: string
        format: date
        example: 43084
      paymentFrequency:
        type: string
        format: date
        example: 43084
      perpetualFlag:
        description: standingInstruction  This will be mandatory when Payment Schedule
          Type is Future Dated Recurring.$$O
        type: boolean
      standingInstructionEndDate:
        description: Standing instruction start date in ISO 8601 format YYYY-MM-DD.
        type: string
        format: date
        example: 43084
      standingInstructionCount:
        description: This is no of payments instructed  to be made by customer from
          start Date
        type: number
        format: double
        example: 8
    required:
    - standingInstructionEndDate
  ExternalDomesticPayments:
    properties:
      sourceAccountId:
        description: The source account identifier in encrypted format.Typically,
          this is not displayed to the customer.
        type: string
        example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d
      transactionAmount:
        description: Transaction Amount
        type: number
        format: double
        example: 10
      transferCurrencyIndicator:
        description: Indicator to specify whether the transfer is in source or destination
          account currency.The acceptable forms of remittance for a given payments
          and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator}
          resource to get valid value of this field with description.",
        type: string
        example: F
      payeeId:
        description: The payee identifier in encrypted format.Typically, this is not
          displayed to the customer.
        type: string
      chargeBearer:
        description: Field to identify charge bearer.The acceptable forms of remittance
          for a given payments and transfer transaction.This is a reference data field.
          Please use /v1/utilities/referenceData/{chargeBearer} resource to get valid
          value of this field with description.",
        type: string
        example: BENEFICIARY
      paymentMethod:
        description: The acceptable forms of remittance for a given payments and transfer
          transaction.This is a reference data field. Please use /v1/utilities/referenceData/{paymentMethod}
          resource to get valid value of this field with description.",
        type: string
        example: GIRO
      foreignExchangeReferenceNumber:
        description: Fx deal reference number
        type: string
        example: 123456
      remarks:
        description: Payment notes. Free text from screen"
        type: string
      transferPurpose:
        description: Purpose of transfer. Applicable if paymentMethod is GIRO, FAST.
          This is a reference data field.This is a reference data field. Please use
          /v1/utilities/referenceData/{transferPurpose} resource to get valid value
          of this field with description.
        type: string
      transferSubPurpose:
        description: Sub Purpose Of Transfer
        type: string
        example: REFERENCE
      paymentScheduleType:
        description: From various Option Support - CVT table. - Immediate -  FutureDated
          ( Date Selection ) - Future Dated Recurring ( Date Selection and Frequency
          - Last Date ) for Poland only Immediate and One Time Future Dated
        type: string
      futureDatedTransaction:
        $ref: '#/definitions/FutureDatedTransaction'
      standingInstruction:
        $ref: '#/definitions/StandingInstruction'
      anticipatoryPaymentFlag:
        description: anticipatory paymentFlag
        type: boolean
      paymentId:
        description: this is free text unique value. This is end to end identification
          ID
        type: string
    required:
    - sourceAccountId
    - transactionAmount
    - transferCurrencyIndicator
    - payeeId
    - chargeBearer
    - paymentMethod
  ExecutePaymentInitiationTransactionMultipleTransfersAsyncResponse:
    properties:
      transactionStatus:
        description: This is transaction status
        type: string
      tppBundleId:
        description: This is bundle/ bulk id of the transactions from TPP
        type: string
      citiBundleId:
        description: This is bundle/ bulk id of the transactions from Citi
        type: string
      totalTransactionCount:
        description: This is total number of transactions
        type: string
  ErrorResponse:
    properties:
      type:
        description: Invalid - Request did not confirm to the specification and was
          unprocessed and rejected. Please fix the value and try again
        enum:
        - error
        - warn
        - invalid
        - fatal
        type: string
      code:
        description: Error code which qualifies the error
        type: string
      details:
        description: Human readable explanation specific to the occurrence of the
          problem
        type: string
      location:
        description: The name of the field that resulted in the error
        type: string
      moreInfo:
        description: URI to human readable documentation of the error
        type: object
    required:
    - type
    - code
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
security:
- API Key: []
- API Key (Query): []
securityDefinitions:
  API Key (Query):
    type: apiKey
    description: ""
    in: query
    name: client_id
  API Key:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
x-ibm-endpoints:
- endpointUrl: https://emea.sit.api.citi.com/gcb
  description: Custom Gateway API Endpoint
  type:
  - production
  - development
...