---
swagger: "2.0"
info:
  description: This API shows the pre process page for customer to update Standing
    instructions for a specific transfer type/ payee type
  version: 1.0.0
  x-ibm-name: UpdatePaymentInitiationTransactionRepeatingPaymentsPreprocess
  title: UpdatePaymentInitiationTransactionRepeatingPaymentsPreprocess
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/paymentInitiation/repeatingPayments/preprocess:
    post:
      summary: This API shows the pre process page for customer to update Standing
        instructions for a specific transfer type/ payee type
      description: This API shows the pre process page for customer to update Standing
        instructions for a specific transfer type/ payee type
      operationId: UpdatePaymentInitiationTransactionRepeatingPaymentsPreprocess
      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: UpdatePaymentInitiationTransactionRepeatingPaymentsPreprocessRequest
        in: body
        description: UpdatePaymentInitiationTransactionRepeatingPaymentsPreprocessRequest
        required: true
        schema:
          $ref: '#/definitions/UpdatePaymentInitiationTransactionRepeatingPaymentsPreprocessRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/UpdatePaymentInitiationTransactionRepeatingPaymentsPreprocessResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid parameters</td></tr><td>invalid</td><td>invalidTransactionAmount</td><td>Transaction
            amount is invalid</td></tr><tr><td>invalid</td><td>invalidSourceAccount</td><td>Source
            account is invalid</td></tr><tr><td>invalid</td><td>invalidAccountTransactionReferenceCombination</td><td>Invalid
            Account and reference id combination</td></tr><tr><td>invalid</td><td>invalidDateRange</td><td>Date
            range is invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><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>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td><tr><td>error</td><td>mfaRequired</td><td>
            MFA is required</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><td>error</td><td>buzinessValidationFailed</td><td>Buziness
            Validation Failed</td><tr><td>error</td><td>transactionPendingReview</td><td>Transaction
            pending under review</td></tr><tr><td>error</td><td>transactionDenied</td><td>Transaction
            is denied</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</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:
  UpdatePaymentInitiationTransactionRepeatingPaymentsPreprocessRequest:
    properties:
      accountId:
        description: The account identifier in encrypted format.Typically, this is
          not displayed to the customer.
        type: string
        example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d
      paymentMethod:
        description: "The acceptable forms of remittance for a given payments and
          transfer transaction.This is a reference data field. Please use \t  /v1/utilities/referenceData/{paymentMethod}
          resource to get valid value of this field with description"
        type: string
        example: FasterPayments
      bankSortCode:
        description: This is specific to UK
        type: string
        example: 30-00-81
      transactionReferenceId:
        description: The unique SI reference Id used to identify the payee type/ transfer
          from all the other transfers
        type: string
        example: BIMI51807310002051
      transactionAmount:
        description: Transaction amount in local currency.
        type: number
        format: double
        example: "4500.25"
      futureDatedTransaction:
        $ref: '#/definitions/FutureDatedTransaction'
      standingInstruction:
        $ref: '#/definitions/StandingInstruction'
      remarks:
        description: Bill payment notes. Free text from screen.
        type: string
        example: Free text
    required:
    - accountId
    - paymentMethod
    - transactionReferenceId
  FutureDatedTransaction:
    properties:
      scheduleDate:
        description: Date on which the set amount will be transferred . Date in ISO
          8601 date format YYYY-MM-DD.
        type: string
        format: date
        example: "2020-12-22"
    required:
    - scheduleDate
  StandingInstruction:
    properties:
      standingInstructionStartDate:
        description: Standing instruction start date in ISO 8601 format YYYY-MM-DD.
        type: string
        format: date
        example: "2020-12-22"
      paymentFrequency:
        description: The frequency of payment. This is a reference data.Please use
          /v1/utilities/referenceData/{paymentFrequency} resource to get valid value
          of this field.
        type: string
        example: MONTHLY
      perpetualFlag:
        description: Flag to indicate if the standing instruction will be continued
          until cancellation.
        type: boolean
        example: "True"
      standingInstructionEndDate:
        description: Standing instruction end date in ISO 8601 date format YYYY-MM-DD.
        type: string
        format: date
        example: "2020-12-22"
  UpdatePaymentInitiationTransactionRepeatingPaymentsPreprocessResponse:
    properties:
      controlFlowId:
        description: This is control Flow id for next API
        type: string
      debitDetails:
        type: array
        items:
          $ref: '#/definitions/DebitDetails'
      creditDetails:
        type: array
        items:
          $ref: '#/definitions/CreditDetails'
      foreignExchangeRate:
        description: Exchange rate
        type: number
        format: double
        example: "1.1021"
      transactionFee:
        description: Transaction fee
        type: number
        format: double
        example: "500.25"
      feeCurrencyCode:
        description: This is fee currency code in ISO 4217 format.
        type: string
        example: USD
    required:
    - controlFlowId
  DebitDetails:
    properties:
      transactionDebitAmount:
        description: The transaction debit amount.
        type: number
        format: double
        example: "4500.25"
      currencyCode:
        description: The currency code for the debit amount in ISO 4217
        type: string
        example: EUR
  CreditDetails:
    properties:
      transactionCreditAmount:
        description: The transaction credit amount
        type: number
        format: double
        example: "19178.72"
      currencyCode:
        description: The currency code for the credit amount in ISO 4217
        type: string
        example: PLN
  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
securityDefinitions:
  API Key (Query):
    type: apiKey
    description: ""
    in: query
    name: client_id
  API Key:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security: []
x-ibm-endpoints:
- endpointUrl: https://emea.sit.api.citi.com/gcb
  description: Custom Gateway API Endpoint
  type:
  - production
  - development
...