---
swagger: "2.0"
info:
  description: This API is used to inquire the eligibility source accounts for PT1
    and PT2 payment types for an authenticated Citi Customer. This information can
    be used to prepare a valid source list for a selected destination, or vice versa.
  version: 1.0.0
  x-ibm-name: RetrievePaymentInitiationTransactionBulkSourceAccountAndPayeeEligibility
  title: RetrievePaymentInitiationTransactionBulkSourceAccountAndPayeeEligibility
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/paymentInitiation/bulk/sourceAccountAndPayees/eligibility:
    get:
      summary: Bulk Source Account Payee Eligibility Inquiry
      description: This API is used to inquire the eligibility source accounts for
        PT1 and PT2 payment types for an authenticated Citi Customer. This information
        can be used to prepare a valid source list for a selected destination, or
        vice versa.
      operationId: RetrievePaymentInitiationTransactionBulkSourceAccountAndPayeeEligibility
      tags:
      - Payment
      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: 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: nextStartIndex
        in: query
        description: In some cases there is more data than what can be returned in
          a single response. If there is additional data available a nextStartIndex
          will be returned. Pass the nextStartIndex in your next request to retrieve
          the next set of data.
        type: string
        required: false
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrievePaymentInitiationTransactionBulkSourceAccountAndPayeeEligibilityResponse'
        204:
          description: No content
        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></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></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>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:
  RetrievePaymentInitiationTransactionBulkSourceAccountAndPayeeEligibilityResponse:
    properties:
      sourceAccountAndPayee:
        type: array
        items:
          $ref: '#/definitions/SourceAccountAndPayee'
      nextStartIndex:
        description: In some cases there is more data than what can be returned in
          a single response. If there is additional data available a nextStartIndex
          will be returned. Pass the nextStartIndex in your next request to retrieve
          the next set of data.$$O
        type: string
  SourceAccountAndPayee:
    properties:
      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: 1234
      sourceAccounts:
        type: array
        items:
          $ref: '#/definitions/SourceAccounts'
      payeeSourceAccountCombinations:
        type: array
        items:
          $ref: '#/definitions/PayeeSourceAccountCombinations'
  SourceAccounts:
    properties:
      sourceAccountId:
        description: The primary identifier for ownership of an account.The source
          account identifier in encrypted format.Typically, this is not displayed
          to the customer,use displayAccountNumber instead.
        type: string
        example: 724f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d
      displaySourceAccountNumber:
        description: A masked account number that can be displayed to the customer
        type: string
        example: XXXXXX2364
      sourceAccountCurrencyCode:
        description: The currency code of the source account in ISO 4217 format
        type: string
        example: SGD
      accountGroup:
        description: Account Group associated with the source Account.This is a reference
          data field. Please use /v1/utilities//referenceData/{accountGroup} resource
          to get valid value of this field with description. You can use accountGroup
          as the referenceCode parameter to retrieve the values.
        type: string
        example: SAVINGS_AND_INVESTMENTS
      availableBalance:
        description: The available balance including any pending or in progress deposits
          and withdrawals
        type: number
        format: double
        example: 50000.250000
      nextPaymentAmount:
        description: The next payment amount due.
        type: number
        format: double
        example: 4500.250000
      productName:
        description: The name of the product
        type: string
        example: Personal Checking Account
      accountNickName:
        description: The nick name of the account assigned by the customer
        type: string
        example: James
    required:
    - sourceAccountId
    - displaySourceAccountNumber
    - sourceAccountCurrencyCode
    - accountGroup
  PayeeSourceAccountCombinations:
    properties:
      payeeId:
        description: Unique identifier associated with the payee
        type: string
        example: C$0003019202$AU$XX$01000540000001
      displayPayeeAccountNumber:
        description: The display account number of the destination account
        type: string
        example: XXXXXX4085
      payeeAccountCurrencyCode:
        description: The currency code of the payee account in ISO 4217 format
        type: string
        example: SGD
      payeeNickName:
        description: Payee account nick name
        type: string
        example: James
      sourceAccountIds:
        description: The primary identifier for ownership of an account.The source
          account identifier in encrypted format.Typically, this is not displayed
          to the customer,use displayAccountNumber instead.
        type: string
        example: 724f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d
    required:
    - payeeId
    - payeeAccountCurrencyCode
    - payeeNickName
    - sourceAccountIds
  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:
- API Key: []
- API Key (Query): []
x-ibm-endpoints:
- endpointUrl: https://emea.sit.api.citi.com/gcb
  description: Custom Gateway API Endpoint
  type:
  - production
  - development
...