fdx-resource-api-openapi.yaml

openapi: 3.0.3
info:
  title: Mastercard Developer Hub for FDX APIs Fdx Resource API
  description: FDX Mock Resource Server API reference for developers
  termsOfService: https://mastercard.com
  contact:
    name: API Support
    url: https://developer.mastercard.com/support
    email: apisupport@mastercard.com
  license:
    name: Mastercard Product
    url: https://mastercard.com
  version: 1.0.0
servers:
  - url: 'http://localhost:9090'
    description: Localhost URL
security:
  - apiKey: []
tags:
  - name: Application Check Controller
    description: health check and check the status application
  - name: Consent
    description: Return consent and save consent for user.
  - name: Data Resource APIs
    description: "Return list of account, account details,transactions,contact details, payments info and statements details of user."
  - name: Upload Data
    description: Upload accounts and transaction for user.
  - name: User APIs
    description: Return user response.
paths:
  /consent/{consentId}:
    get:
      tags:
        - Consent
      summary: Mastercard Developer Hub for FDX APIs Get Consent by consent Id
      description: Return particular consent response by consent id.
      operationId: getConsent
      parameters:
        - name: consentId
          in: path
          required: true
          schema:
            type: string
          example: b39bf7e9-92ae-4649-a1f0-87983285fe1
        - name: Authorization
          in: header
          description: This field indicate the Access Token id
          required: true
          schema:
            type: string
          example: Token Id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountConsent'
              example:
                userId: fdxuser
                allAccountIds:
                  - '10001'
                  - '20001'
                  - '3746272'
                  - '5326884'
                accountIds:
                  - '10001'
                consentShareDurationSeconds: 600
                consentId: eb1a3f4b-9974-4c80-8364-c4ec8c6ff9f7
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
              example:
                code: '401'
                error: We have encountered some internal error in processing your request.
                errorDescription: Request validation failed. Either authorization code is blank or invalid.

    put:
      tags:
        - Consent
      summary: Mastercard Developer Hub for FDX APIs Update Consent by consent Id
      description: Return updated consent response.
      operationId: updateConsent
      parameters:
        - name: consentId
          in: path
          description: This field indicate the Consent ID
          required: true
          schema:
            type: string
          example: eb1a3f4b-9974-4c80-8364-c4ec8c6ff9f7
        - name: Authorization
          in: header
          description: Access Token id
          required: true
          schema:
            type: string
          example: Token Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                accountIds:
                  description: This field indicate account Id which consent given by user
                  type: array
                  items:
                    type: number
                    example: 20001
                  example:
                    - 20001
                consentShareDurationSeconds:
                  description: This field indicate consent Expiry date
                  type: number
                  example: 600
                userId:
                  description: This field indicate user Id
                  type: string
                  example: fdxuser
            examples:
              Update Consent:
                value:
                  accountIds:
                    - 20001
                  consentShareDurationSeconds: 600
                  userId: fdxuser
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountConsentResp'
              example:
                customerId: fdxuser
                consentId: eb1a3f4b-9974-4c80-8364-c4ec8c6ff9f7
                endDate: 1720607740194
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
              example:
                code: '401'
                error: We have encountered some internal error in processing your request.
                errorDescription: Request validation failed. Either authorization code is blank or invalid.
  /user:
    post:
      tags:
        - User APIs
      summary: Mastercard Developer Hub for FDX APIs Save user
      description: Return saved user response.
      operationId: saveUser
      parameters:
        - name: Authorization
          in: header
          description: This field indicate the Access Token id
          required: true
          schema:
            type: string
          example: Token Id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                password:
                  description: This field indicate plain password
                  type: string
                  example: password
                userId:
                  description: This field indicate user id
                  type: string
                  example: fdxuser1
            examples:
              SaveUser:
                value:
                  password: password
                  userId: fdxuser1
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FdxUser'
  /upload/addTransactions:
    post:
      tags:
        - Upload Data
      summary: Mastercard Developer Hub for FDX APIs add transactions details for user Id
      description: Return transactions response.
      operationId: addTransactions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  accountCategory:
                    type: string
                    example: DEPOSIT_ACCOUNT
                  accountId:
                    type: string
                    example: '10002'
                  amount:
                    type: number
                    example: 0.01
                  checkNumber:
                    type: number
                    example: 45400222
                  debitCreditMemo:
                    type: string
                    example: CREDIT
                  description:
                    type: string
                    example: INTEREST PAYMENT
                  payee:
                    type: string
                    example: Test User
                  postedTimestamp:
                    type: string
                    example: '2019-07-31T12:00:00.000Z'
                  status:
                    type: string
                    example: POSTED
                  transactionId:
                    type: string
                    example: '12455'
                  transactionTimestamp:
                    type: string
                    example: '2019-07-31T12:00:00.000Z'
                  transactionType:
                    type: string
                    example: POSCREDIT
              example:
                - accountCategory: DEPOSIT_ACCOUNT
                  accountId: '10002'
                  amount: 0.01
                  description: INTEREST PAYMENT
                  postedTimestamp: '2019-07-31T12:00:00.000Z'
                  status: POSTED
                  transactionId: '12455'
                  transactionTimestamp: '2019-07-31T12:00:00.000Z'
                  transactionType: POSCREDIT
                - accountCategory: DEPOSIT_ACCOUNT
                  accountId: '10002'
                  amount: 0.03
                  description: INTEREST PAYMENT
                  postedTimestamp: '2019-02-28T12:00:00.000Z'
                  status: POSTED
                  transactionId: '45322'
                  transactionTimestamp: '2019-02-28T12:00:00.000Z'
                  transactionType: POSCREDIT
                - accountCategory: DEPOSIT_ACCOUNT
                  accountId: '10002'
                  amount: -300
                  description: 'ALLY BANK TRANSFER WEB ID: 3770527921'
                  postedTimestamp: '2019-02-26T12:00:00.000Z'
                  status: POSTED
                  transactionId: '4322777'
                  transactionTimestamp: '2019-02-26T12:00:00.000Z'
                  transactionType: POSDEBIT
                - accountCategory: DEPOSIT_ACCOUNT
                  accountId: '10002'
                  amount: 101.72
                  checkNumber: 45400222
                  debitCreditMemo: CREDIT
                  description: VENMO CASHOUT
                  payee: Test User
                  postedTimestamp: '2019-02-26T12:00:00.000Z'
                  status: POSTED
                  transactionId: '5705141948'
                  transactionTimestamp: '2019-02-26T12:00:00.000Z'
                  transactionType: POSCREDIT
            examples:
              Add Transactions:
                value:
                  - accountCategory: DEPOSIT_ACCOUNT
                    accountId: '10002'
                    amount: 0.01
                    description: INTEREST PAYMENT
                    postedTimestamp: '2019-07-31T12:00:00.000Z'
                    status: POSTED
                    transactionId: '12455'
                    transactionTimestamp: '2019-07-31T12:00:00.000Z'
                    transactionType: POSCREDIT
                  - accountCategory: DEPOSIT_ACCOUNT
                    accountId: '10002'
                    amount: 0.03
                    description: INTEREST PAYMENT
                    postedTimestamp: '2019-02-28T12:00:00.000Z'
                    status: POSTED
                    transactionId: '45322'
                    transactionTimestamp: '2019-02-28T12:00:00.000Z'
                    transactionType: POSCREDIT
                  - accountCategory: DEPOSIT_ACCOUNT
                    accountId: '10002'
                    amount: -300
                    description: 'ALLY BANK TRANSFER WEB ID: 3770527921'
                    postedTimestamp: '2019-02-26T12:00:00.000Z'
                    status: POSTED
                    transactionId: '4322777'
                    transactionTimestamp: '2019-02-26T12:00:00.000Z'
                    transactionType: POSDEBIT
                  - accountCategory: DEPOSIT_ACCOUNT
                    accountId: '10002'
                    amount: 101.72
                    checkNumber: 45400222
                    debitCreditMemo: CREDIT
                    description: VENMO CASHOUT
                    payee: Test User
                    postedTimestamp: '2019-02-26T12:00:00.000Z'
                    status: POSTED
                    transactionId: '5705141948'
                    transactionTimestamp: '2019-02-26T12:00:00.000Z'
                    transactionType: POSCREDIT
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DataUploadResponsePojo'
  /upload/addAccount:
    post:
      tags:
        - Upload Data
      summary: Mastercard Developer Hub for FDX APIs add account for user Id
      description: Return accounts response.
      operationId: addAccount
      parameters:
        - name: userId
          in: query
          required: true
          schema:
            type: string
          example: fdxUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  accountCategory:
                    type: string
                    example: DEPOSIT_ACCOUNT
                  accountId:
                    type: string
                    example: '10002'
                  accountNumber:
                    type: string
                    example: '7000003223'
                  accountNumberDisplay:
                    type: string
                    example: CHECKING
                  accountType:
                    type: string
                    example: CHECKING
                  annualPercentageYield:
                    type: number
                    example: 0.45
                  availableBalance:
                    type: number
                    example: 4984.46
                  balanceAsOf:
                    type: string
                    example: 2020-12-07T01:06:15.649-0500
                  balanceType:
                    type: string
                    example: ASSET
                  currency:
                    type: object
                    properties:
                      currencyCode:
                        type: string
                        example: USD
                      currencyRate:
                        nullable: true
                        example:
                      originalCurrencyCode:
                        type: string
                        example: USD
                  currentBalance:
                    type: number
                    example: 4984.46
                  description:
                    type: string
                    example: My Checking Acc XXXX3223
                  displayName:
                    type: string
                    example: '******3223'
                  fiAttributes:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          example: interestPaidLastYear
                        value:
                          type: string
                          example: '14.08'
                    example:
                      - name: interestPaidLastYear
                        value: '14.08'
                      - name: interestPayoutFrequency
                        value: Annually (And At Maturity)
                  interestYtd:
                    type: number
                    example: 14.15
                  lastActivityDate:
                    type: string
                    example: 2020-11-09T00:00:00.000-0500
                  lineOfBusiness:
                    type: string
                    example: RETAIL
                  maturityDate:
                    type: string
                    example: 2020-11-09T00:00:00.000-0500
                  nickname:
                    type: string
                    example: My Checking Acc XXXX3223
                  openingDayBalance:
                    type: number
                    example: 500
                  productName:
                    type: string
                    example: Cash Management
                  routingTransitNumber:
                    type: string
                    example: '256074974'
                  status:
                    type: string
                    example: OPEN
                  transactionsIncluded:
                    type: boolean
                    example: false
              example:
                - accountCategory: DEPOSIT_ACCOUNT
                  accountId: '10002'
                  accountNumber: '7000003223'
                  accountNumberDisplay: CHECKING
                  accountType: CHECKING
                  annualPercentageYield: 0.45
                  availableBalance: 4984.46
                  balanceAsOf: 2020-12-07T01:06:15.649-0500
                  balanceType: ASSET
                  currency:
                    currencyCode: USD
                    currencyRate:
                    originalCurrencyCode: USD
                  currentBalance: 4984.46
                  description: My Checking Acc XXXX3223
                  displayName: '******3223'
                  fiAttributes:
                    - name: interestPaidLastYear
                      value: '14.08'
                    - name: interestPayoutFrequency
                      value: Annually (And At Maturity)
                  interestYtd: 14.15
                  lastActivityDate: 2020-11-09T00:00:00.000-0500
                  lineOfBusiness: RETAIL
                  maturityDate: 2020-11-09T00:00:00.000-0500
                  nickname: My Checking Acc XXXX3223
                  openingDayBalance: 500
                  productName: Cash Management
                  routingTransitNumber: '256074974'
                  status: OPEN
                  transactionsIncluded: false
            examples:
              Add accounts:
                value:
                  - accountCategory: DEPOSIT_ACCOUNT
                    accountId: '10002'
                    accountNumber: '7000003223'
                    accountNumberDisplay: CHECKING
                    accountType: CHECKING
                    annualPercentageYield: 0.45
                    availableBalance: 4984.46
                    balanceAsOf: 2020-12-07T01:06:15.649-0500
                    balanceType: ASSET
                    currency:
                      currencyCode: USD
                      currencyRate:
                      originalCurrencyCode: USD
                    currentBalance: 4984.46
                    description: My Checking Acc XXXX3223
                    displayName: '******3223'
                    fiAttributes:
                      - name: interestPaidLastYear
                        value: '14.08'
                      - name: interestPayoutFrequency
                        value: Annually (And At Maturity)
                    interestYtd: 14.15
                    lastActivityDate: 2020-11-09T00:00:00.000-0500
                    lineOfBusiness: RETAIL
                    maturityDate: 2020-11-09T00:00:00.000-0500
                    nickname: My Checking Acc XXXX3223
                    openingDayBalance: 500
                    productName: Cash Management
                    routingTransitNumber: '256074974'
                    status: OPEN
                    transactionsIncluded: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUploadResponsePojo'
  /consent:
    post:
      tags:
        - Consent
      summary: Mastercard Developer Hub for FDX APIs Register Consent
      description: Save user consent into db
      operationId: registerConsent
      parameters:
        - name: Authorization
          in: header
          description: This field indicate the Access Token id
          required: true
          schema:
            type: string
          example: Token Id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                accountIds:
                  description: This field indicate account Id which consent given by user
                  type: array
                  items:
                    type: number
                    example: 1001
                  example:
                    - 10001
                consentShareDurationSeconds:
                  description: This field indicate consent Expiry date
                  type: number
                  example: 600
                userId:
                  description: This field indicate user Id
                  type: string
                  example: fdxuser
            examples:
              Register Consent:
                value:
                  accountIds:
                    - 10001
                  consentShareDurationSeconds: 600
                  userId: fdxuser
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountConsentResp'
              example:
                customerId: fdxuser
                consentId: eb1a3f4b-9974-4c80-8364-c4ec8c6ff9f7
                endDate: 1720607740194

        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
              example:
                code: '401'
                error: We have encountered some internal error in processing your request.
                errorDescription: Request validation failed. Either authorization code is blank or invalid.

  /user/{userId}:
    get:
      tags:
        - User APIs
      summary: Mastercard Developer Hub for FDX APIs Get user by user Id
      description: Return user response.
      operationId: getUser
      parameters:
        - name: Authorization
          in: header
          description: This field indicate the Access Token id
          required: true
          schema:
            type: string
          example: Token Id
        - name: userId
          in: path
          description: This field indicate the user ID
          required: true
          schema:
            type: string
          example: '2456777'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FdxUser'
  /startupStatus:
    get:
      tags:
        - Application Check Controller
      summary: Mastercard Developer Hub for FDX APIs Status check
      description: status check for application
      operationId: getStartupStatus
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /shutdown:
    get:
      tags:
        - Application Check Controller
      summary: Mastercard Developer Hub for FDX APIs shutdown application
      description: Return the status of shutdown.
      operationId: shutdown
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /livenessProbe:
    get:
      tags:
        - Application Check Controller
      summary: Mastercard Developer Hub for FDX APIs liveness check
      description: liveness check for application
      operationId: validateLiveness
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /health:
    get:
      tags:
        - Application Check Controller
      summary: Mastercard Developer Hub for FDX APIs health check
      description: health check for application
      operationId: getHealth
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string

  /fdx/v6/accounts:
    get:
      tags:
        - Data Resource APIs
      summary: Mastercard Developer Hub for FDX APIs Get all accounts of user.
      description: Return list of user accounts.
      operationId: getAccountsList
      parameters:
        - name: Authorization
          in: header
          description: This field indicate the Access Token id
          required: true
          schema:
            type: string
          example: Token Id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Accounts'
              example:
                page:
                  nextOffset: '2'
                  total: 3
                links:
                  next:
                    href: /accounts?offSet=2&limit=10
                accounts:
                  - accountCategory: DEPOSIT_ACCOUNT
                    accountId: '10001'
                    nickname: My Checking Acc XXXX3223
                    status: OPEN
                    balanceAsOf: '2017-11-05T13:15:30.751Z'
                    currentBalance: 13300.35
                    openingDayBalance: 500
                  - accountCategory: DEPOSIT_ACCOUNT
                    accountId: '10002'
                    nickname: My Checking Acc XXXX4443
                    status: OPEN
                    balanceAsOf: '2017-11-05T13:15:30.751Z'
                    currentBalance: 332.22
                    openingDayBalance: 100
                  - accountCategory: LOAN_ACCOUNT
                    accountId: '20001'
                    nickname: My Mortgage Acc XXXX9979
                    description: My Mortgage Acc XXXX9979
                    status: OPEN
                    balanceAsOf: '2017-11-05T13:15:30.751Z'
                    principalBalance: 133000.35
                    loanTerm: 30
                    nextPaymentDate: '2017-12-01'
                    nextPaymentAmount: 2333.32

        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
              example:
                code: '401'
                error: We have encountered some internal error in processing your request.
                errorDescription: Request validation failed. Either authorization code is blank or invalid.

  /fdx/v6/accounts/{accountId}:
    get:
      tags:
        - Data Resource APIs
      summary: Mastercard Developer Hub for FDX APIs Get account details by account id.
      description: Return in-depth account details for particular account.
      operationId: getAccountsDetails
      parameters:
        - name: Authorization
          in: header
          description: This field indicate the Access Token id
          required: true
          schema:
            type: string
          example: Token Id
        - name: accountId
          in: path
          description: This field indicate the account ID
          required: true
          schema:
            type: string
          example: '10001'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountDescriptor'
              example:
                accountId: '10001'
                accountCategory: DEPOSIT_ACCOUNT
                accountType: CHECKING
                displayName: '******3223'
                status: OPEN
                productName: Cash Management
                currency:
                  currencyRate:
                  currencyCode: USD
                  originalCurrencyCode: USD
                interestYtd: 14.15
                maturityDate: 2020-11-09T00:00:00.000-0500
                annualPercentageYield: 0.45
                description: My Checking Acc XXXX3223
                nickname: My Checking Acc XXXX3223
                lineOfBusiness: RETAIL
                accountNumber: '7000003223'
                accountNumberDisplay: '3223'
                routingTransitNumber: '256074974'
                balanceType: ASSET
                lastActivityDate: 2020-11-09T00:00:00.000-0500
                transactionsIncluded: false
                balanceAsOf: 2020-12-07T01:06:15.649-0500
                currentBalance: 4984.46
                availableBalance: 4984.46
                openingDayBalance: 500
                fiAttributes:
                  - name: interestPaidLastYear
                    value: '14.08'
                  - name: interestPayoutFrequency
                    value: Annually (And At Maturity)

        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
              example:
                code: '401'
                error: We have encountered some internal error in processing your request.
                errorDescription: Request validation failed. Either authorization code is blank or invalid.

  /fdx/v6/accounts/{accountId}/transactions:
    get:
      tags:
        - Data Resource APIs
      summary: Mastercard Developer Hub for FDX APIs Get transaction details by account id.
      description: Return list of transaction details for particular account.
      operationId: getTransactions
      parameters:
        - name: Authorization
          in: header
          description: This field indicate the Access Token id
          required: true
          schema:
            type: string
          example: Token Id
        - name: accountId
          in: path
          description: This field indicate the account ID
          required: true
          schema:
            type: string
          example: '10001'
        - name: startTime
          in: header
          description: This field indicate the startTime transaction
          required: false
          schema:
            type: string
          example: 18-04-2024
        - name: endTime
          in: header
          description: This field indicate the endTime of transaction
          required: false
          schema:
            type: string
          example: 30-07-2024
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transactions'
              example:
                page:
                  total: 4
                transactions:
                  - accountId: '10001'
                    accountCategory: DEPOSIT_ACCOUNT
                    transactionId: '12455'
                    postedTimestamp: '2019-07-31T12:00:00.000Z'
                    transactionTimestamp: '2019-07-31T12:00:00.000Z'
                    description: INTEREST PAYMENT
                    status: POSTED
                    amount: 0.01
                    transactionType: POSCREDIT
                  - accountId: '10001'
                    accountCategory: DEPOSIT_ACCOUNT
                    transactionId: '45322'
                    postedTimestamp: '2019-02-28T12:00:00.000Z'
                    transactionTimestamp: '2019-02-28T12:00:00.000Z'
                    description: INTEREST PAYMENT
                    status: POSTED
                    amount: 0.03
                    transactionType: POSCREDIT
                  - accountId: '10001'
                    accountCategory: DEPOSIT_ACCOUNT
                    transactionId: '4322777'
                    postedTimestamp: '2019-02-26T12:00:00.000Z'
                    transactionTimestamp: '2019-02-26T12:00:00.000Z'
                    description: 'ALLY BANK TRANSFER WEB ID: 3770527921'
                    status: POSTED
                    amount: -300
                    transactionType: POSDEBIT
                  - accountId: '10001'
                    accountCategory: DEPOSIT_ACCOUNT
                    transactionId: '5705141948'
                    postedTimestamp: '2019-02-26T12:00:00.000Z'
                    transactionTimestamp: '2019-02-26T12:00:00.000Z'
                    description: VENMO CASHOUT
                    debitCreditMemo: CREDIT
                    status: POSTED
                    amount: 101.72
                    transactionType: POSCREDIT
                    checkNumber: 45400222
                    payee: Test User

        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
              example:
                code: '401'
                error: We have encountered some internal error in processing your request.
                errorDescription: Request validation failed. Either authorization code is blank or invalid.

  /fdx/v6/accounts/{accountId}/statements:
    get:
      tags:
        - Data Resource APIs
      summary: Mastercard Developer Hub for FDX APIs Get statements details by account id.
      description: Return list of statements details for particular account.
      operationId: getStatements
      parameters:
        - name: Authorization
          in: header
          description: This field indicate the Access Token id
          required: true
          schema:
            type: string
          example: Token Id
        - name: accountId
          in: path
          description: This field indicate the account ID
          required: true
          schema:
            type: string
          example: '10001'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Statements'
  /fdx/v6/accounts/{accountId}/statements/{statementId}:
    get:
      tags:
        - Data Resource APIs
      summary: Mastercard Developer Hub for FDX APIs Get statements details by account id and statement Id.
      description: Return statements response for particular account in pdf format.
      operationId: getStatementsByStatementId
      parameters:
        - name: Authorization
          in: header
          description: This field indicate the Access Token id
          required: true
          schema:
            type: string
          example: Token Id
        - name: accountId
          in: path
          description: This field indicate the account ID
          required: true
          schema:
            type: string
          example: '10001'
        - name: statementId
          in: path
          description: This field indicate the Statement ID
          required: true
          schema:
            type: string
          example: '30001'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
  /fdx/v6/accounts/{accountId}/payment-networks:
    get:
      tags:
        - Data Resource APIs
      summary: Mastercard Developer Hub for FDX APIs Get payment networks details by account id.
      description: Return payment networks details for particular account.
      operationId: getPaymentNetworksDetails
      parameters:
        - name: Authorization
          in: header
          description: This field indicate the Access Token id
          required: true
          schema:
            type: string
          example: Token Id
        - name: accountId
          in: path
          description: This field indicate the account ID
          required: true
          schema:
            type: string
          example: '10001'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountPaymentNetworkList'
              example:
                - bankId: '121000358'
                  identifier: '7000003223'
                  accountId: '10001'
                  identifierType: ACCOUNT_NUMBER
                  type: US_ACH
                  transferIn: true
                  transferOut: true
                  transferLimits:
                    out:
                      day:
                        resetsOn: '2023-08-09T00:00:00.000Z'
                        transferMaxAmount: 10000
                        transferRemainingAmount: 8356
                        maxOccurrence: 6
                        remainingOccurrence: 5
                      month:
                        resetsOn: '2023-09-01T00:00:00.000Z'
                        transferMaxAmount: 50000
                        transferRemainingAmount: 35200
                      transaction:
                        transferMaxAmount: 5000
                        transferRemainingAmount: 4990

        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
              example:
                code: '401'
                error: We have encountered some internal error in processing your request.
                errorDescription: Request validation failed. Either authorization code is blank or invalid.

  /fdx/v6/accounts/{accountId}/contact:
    get:
      tags:
        - Data Resource APIs
      summary: Mastercard Developer Hub for FDX APIs Get contact details by account id.
      description: Return in-depth contact details for particular account.
      operationId: getContactsDetails
      parameters:
        - name: Authorization
          in: header
          description: This field indicate the Access Token id
          required: true
          schema:
            type: string
          example: Token Id
        - name: accountId
          in: path
          description: This field indicate the account ID
          required: true
          schema:
            type: string
          example: '10001'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountContact'
              example:
                accountId: '10001'
                holders:
                  - customerId: customer0000001
                    relationship: SECONDARY
                    name:
                      first: Ernest
                      middle: Miller
                      last: Hemingway
                      suffix: IV
                  - customerId: customer0000002
                    relationship: PRIMARY_JOINT
                    name:
                      first: Maya
                      last: Angel
                      middle: Annie
                emails:
                  - ernest.m.hemingway@domain.com
                  - m.angelou@domain.tld
                addresses:
                  - type: HOME
                    line1: 1850 N Clark St
                    line2: no. 103
                    city: Chicago
                    region: IL
                    postalCode: '60614'
                    country: US
                  - type: HOME
                    line1: 2014 N Main St
                    city: San Francisco
                    region: CA
                    postalCode: '94105'
                    country: US
                telephones:
                  - type: HOME
                    country: '1'
                    number: '3127771926'
                  - type: CELL
                    country: '53'
                    number: '45915607'
                  - type: HOME
                    country: '1'
                    number: '4157771926'

        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
              example:
                code: '401'
                error: We have encountered some internal error in processing your request.
                errorDescription: Request validation failed. Either authorization code is blank or invalid.

  /consent/accounts:
    get:
      tags:
        - Consent
      summary: Mastercard Developer Hub for FDX APIs Get Account by user Id
      description: Return user account response.
      operationId: getAccountsByUserId
      parameters:
        - name: userId
          in: query
          description: This field indicate the user id
          required: true
          schema:
            type: string
          example: UUID
        - name: Authorization
          in: header
          description: This field indicate the Access Token id
          required: true
          schema:
            type: string
          example: Token Id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Accounts'
                example:
                  - page:
                      nextOffset:
                      total: 4
                    links:
                    accounts:
                      - accountCategory: DEPOSIT_ACCOUNT
                        accountType: CHECKING
                        nickname: My Checking Acc XXXX3223
                        status: OPEN
                        balanceAsOf: 1607321175649
                        accountNumber: '7000003223'
                        accountNumberDisplay: '3223'
                        productName: Cash Management
                        description: My Checking Acc XXXX3223
                        currentBalance: 4984.46
                        openingDayBalance: 500
                        accountId: '10001'
                      - accountCategory: LOAN_ACCOUNT
                        accountType: LOAN
                        nickname: My Mortgage Acc XXXX9979
                        status: OPEN
                        balanceAsOf: 1509887730751
                        accountNumber: '34259979'
                        accountNumberDisplay: XXXX9979
                        productName: HOME LOAN
                        description: My Mortgage Acc XXXX9979
                        principalBalance: 133000.35
                        accountId: '20001'
                      - accountCategory: INVESTMENT_ACCOUNT
                        accountType: BROKERAGE
                        nickname: My Investment Acc XXXXX4403
                        status: OPEN
                        balanceAsOf: 1590969600000
                        accountNumber: '4623054403'
                        accountNumberDisplay: '...4403'
                        productName: Invest Trade
                        description: My Investment Acc XXXXX4403
                        availableCashBalance: 381.31
                        accountId: '3746272'
                      - accountCategory: LOC_ACCOUNT
                        accountType: HOMELINEOFCREDIT
                        nickname: My Business Credit Card Acc XXXX6884
                        status: OPEN
                        balanceAsOf: 1559829311754
                        accountNumber: '00008000461791'
                        accountNumberDisplay: '...6884'
                        productName: Credit Card
                        description: My Business Credit Card Acc XXXX68844
                        currentBalance: 102911.98
                        accountId: '5326884'

        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
              example:
                code: '401'
                error: We have encountered some internal error in processing your request.
                errorDescription: Request validation failed. Either authorization code is blank or invalid.

components:
  schemas:
    AccountConsent:
      type: object
      properties:
        errorCode:
          type: integer
          description: This field indicate the error code of application
          format: int32
          readOnly: true
          example: 401
        error Message:
          type: string
          description: This field indicate the error message
          readOnly: true
          example: UNAUTHORIZED
        userId:
          type: string
          description: This field indicate user Id
          example: fdxuser
        allAccountIds:
          type: array
          description: This field indicate all account Id
          example: "['10001','20001','3746272','5326884']"
          items:
            type: string
            description: This field indicate all account Id
            example: "['10001','20001','3746272','5326884']"
        accountIds:
          type: array
          description: This field indicate account Id which consent given by user
          example: "['10001']"
          items:
            type: string
            description: This field indicate account Id which consent given by user
            example: "['10001']"
        consentShareDurationSeconds:
          type: integer
          description: This field indicate consent Expiry date
          format: int64
          example: 600
        consentId:
          type: string
          description: This field indicate consent Id
          example: eb1a3f4b-9974-4c80-8364-c4ec8c6ff9f7
      description: This field indicate the Account Consent POJO
    AccountConsentResp:
      type: object
      properties:
        customerId:
          type: string
          description: This field indicate customer Id
          example: "12345"
        consentId:
          type: string
          description: This field indicate consent Id
          example: eb1a3f4b-9974-4c80-8364-c4ec8c6ff9f7
        endDate:
          type: string
          description: 'This field indicate endDate '
          format: date-time
          example: 2024-07-31T12:00:00Z
    FdxUser:
      type: object
      properties:
        errorCode:
          type: integer
          description: This field indicate the error code of application
          format: int32
          readOnly: true
          example: 401
        errorMessage:
          type: string
          description: This field indicate the error message
          readOnly: true
          example: UNAUTHORIZED
        userId:
          type: string
          description: This field indicate user id
          example: fdxuser
        passwordHash:
          type: string
          description: This field indicate hash password
          readOnly: true
          example: 243tfsdgdfg2253443
        password:
          type: string
          description: This field indicate plain password
          example: test
    PaymentDetails:
      type: object
      properties:
        principalAmount:
          type: number
          description: This field indicate principalAmount
          format: double
          example: 4000.0
        interestAmount:
          type: number
          description: This field indicate interestAmount
          format: double
          example: 200.0
        insuranceAmount:
          type: number
          description: This field indicate insuranceAmount
          format: double
          example: 3000000
        escrowAmount:
          type: number
          description: This field indicate escrowAmount
          format: double
          example: 10003
        pmiAmount:
          type: number
          description: This field indicate pmiAmount
          format: double
          example: 2000
        feesAmount:
          type: number
          description: This field indicate feesAmount
          format: double
          example: 200.0
    TransactionsDetails:
      type: object
      properties:
        accountCategory:
          type: string
          description: This field indicate timestamp of transaction
          format: date-time
          example: 2019-07-31T12:00:00Z
        accountId:
          type: string
          description: This field indicate account Id
          example: "10001"
        transactionId:
          type: string
          description: This field indicate transaction Id
          example: "12455"
        transactionType:
          type: string
          description: This field indicate transaction type
          example: POSCREDIT
        referenceTransactionId:
          type: string
          description: This field indicate reference transaction id
          example: "34555"
        postedTimestamp:
          type: string
          description: This field indicate posted timestamp
          format: date-time
          example: 2019-07-31T12:00:00Z
        transactionTimestamp:
          type: string
          format: date-time
          description: This field indicate transaction timestamp
          example: 2019-07-31T12:00:00Z
        description:
          type: string
          description: This field indicate description
          example: INTEREST PAYMENT
        memo:
          type: string
          description: This field indicate memo
          example: DEBIT
        debitCreditMemo:
          type: string
          description: This field indicate debit credit memo
          example: DEBIT
        category:
          type: string
          description: This field indicate account Category
          example: DEPOSIT_ACCOUNT
        subCategory:
          type: string
          description: This field indicate Category
          example: CHECKING
        reference:
          type: string
          description: This field indicate account sub Category
          example: DEPOSIT_ACCOUNT
        status:
          type: string
          description: This field indicate transaction status
          example: POSTED
        amount:
          type: number
          description: This field indicate transaction amount
          format: double
          example: 4000
        foreignAmount:
          type: number
          description: This field indicate foreign amount
          format: double
          example: 2000
        foreignCurrency:
          type: string
          description: This field indicate foreign currency
          example: USD
        imageIds:
          type: array
          description: This field indicate imageId
          example: DEPOSIT_ACCOUNT
          items:
            type: string
            description: This field indicate imageId
            example: DEPOSIT_ACCOUNT
        payee:
          type: string
          description: This field indicate payee name
          example: Test User
        checkNumber:
          type: integer
          description: This field indicate checknumber
          format: int32
          example: 45400222
        paymentDetails:
          $ref: '#/components/schemas/PaymentDetails'
    DataUploadResponsePojo:
      type: object
      properties:
        errorCode:
          type: integer
          description: This field indicate the error code of application
          format: int32
          readOnly: true
          example: 401
        error Message:
          type: string
          description: This field indicate the error message
          readOnly: true
          example: UNAUTHORIZED
        code:
          type: string
          description: This field indicate response code
          example: '200'
        message:
          type: string
          description: This field indicate response message
          example: SUCCESS
    AccountListResponsePojo:
      type: object
      properties:
        errorCode:
          type: integer
          description: This field indicate the error code of application
          format: int32
          readOnly: true
          example: 401
        errorMessage:
          type: string
          description: This field indicate the error message
          readOnly: true
          example: UNAUTHORIZED
        accountCategory:
          type: string
          description: This field indicate account Category
          example: DEPOSIT_ACCOUNT
        accountType:
          type: string
          description: This field indicate type of account
          example: CHECKING
        nickname:
          type: string
          description: This field indicate nickname of customer
          example: My Checking Acc XXXX3223
        status:
          type: string
          description: This field indicate status of account
          example: OPEN
        balanceAsOf:
          type: string
          description: This field indicate balance date
          format: date-time
          example: 2019-07-31T12:00:00Z
        accountNumber:
          type: string
          description: This field indicate accountNumber
          example: "7000003223"
        accountNumberDisplay:
          type: string
          description: This field indicate last four digit of accountNumber
          example: "3223"
        productName:
          type: string
          description: This field indicate productName
          example: Cash Management
        description:
          type: string
          description: This field indicate description of account
          example: My Checking Acc XXXX3223
        accountOpenDate:
          type: string
          description: This field indicate account open date
          format: date-time
          example: 2019-07-31T12:00:00Z
        accountCloseDate:
          type: string
          description: This field indicate account close date
          format: date-time
          example: 2019-07-31T12:00:00Z
        currentBalance:
          type: number
          description: This field indicate current balance of account
          format: double
          example: 4984.46
        openingDayBalance:
          type: number
          description: This field indicate opening day balance
          format: double
          example: 500
        principalBalance:
          type: number
          description: This field indicate principal balance
          format: double
          example: 100
        availableCashBalance:
          type: number
          description: This field indicate available cash balance
          format: double
          example: 100
        accountId:
          type: string
          description: This field indicate institution account Id
          example: "10001"
      description: This field indicate list of accounts object
      example: list of accounts object
    Accounts:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/Page'
        links:
          $ref: '#/components/schemas/Links'
        accounts:
          type: array
          description: This field indicate list of accounts object
          example: list of accounts object
          items:
            $ref: '#/components/schemas/AccountListResponsePojo'
    Links:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/Next'
      description: This field indicate links object
      example: links object
    Next:
      type: object
      properties:
        href:
          type: string
          description: This field indicate href
          example: href link
    Page:
      type: object
      properties:
        nextOffset:
          type: string
          description: This field indicate next offset
          example: "10"
        total:
          type: integer
          description: This field indicate total
          format: int32
          example: 50
      description: This field indicate page object
      example: page object
    AccountDescriptor:
      type: object
      properties:
        errorCode:
          type: integer
          description: This field indicate the error code of application
          format: int32
          readOnly: true
          example: 401
        errorMessage:
          type: string
          description: This field indicate the error message
          readOnly: true
          example: UNAUTHORIZED
        accountCategory:
          type: string
          description: This field indicate account Category
          example: DEPOSIT_ACCOUNT
        accountType:
          type: string
          description: This field indicate type of account
          example: CHECKING
        nickname:
          type: string
          description: This field indicate nickname of customer
          example: My Checking Acc XXXX3223
        status:
          type: string
          description: This field indicate status of account
          example: OPEN
        balanceAsOf:
          type: string
          description: This field indicate balance date
          format: date-time
          example: 2024-07-31T12:00:00Z
        accountNumber:
          type: string
          description: This field indicate accountNumber
          example: "7000003223"
        accountNumberDisplay:
          type: string
          description: This field indicate last four digit of accountNumber
          example: "3223"
        productName:
          type: string
          description: This field indicate productName
          example: Cash Management
        description:
          type: string
          description: This field indicate description of account
          example: My Checking Acc XXXX3223
        accountOpenDate:
          type: string
          description: This field indicate account open date
          format: date-time
          example: 2019-07-31T12:00:00Z
        accountCloseDate:
          type: string
          description: This field indicate account close date
          format: date-time
          example: 2024-07-31T12:00:00Z
        parentAccountId:
          type: string
          description: This field indicate parent account id
          example: "465723578"
        lineOfBusiness:
          type: string
          description: This field indicate lineOfBusiness
          example: lineOfBusiness
        routingTransitNumber:
          type: string
          description: This field indicate routing Transit Number
          example: "234677"
        balanceType:
          type: string
          description: This field indicate type of balance. Possible values are ASSET,LIABILITY,PERCENTAGE,AMOUNT
          example: ASSET
        interestRate:
          type: number
          description: This field indicate interest rate
          format: double
          example: 8.0
        interestRateType:
          type: string
          description: This field indicate type of interest rate
          example: HOME_LOAN
        interestRateAsOf:
          type: string
          description: This field indicate current interest rate
          format: date-time
          example: 2024-07-31T12:00:00Z
        transferIn:
          type: boolean
          description: This field indicate transfer in
          example: false
        transferOut:
          type: boolean
          description: This field indicate transfer out
          example: false
        billPayStatus:
          type: string
          description: This field indicate status of bill
          example: PAID
        micrNumber:
          type: string
          description: This field indicate account number
          example: "46773234677"
        lastActivityDate:
          type: string
          description: This field indicate last activity
          format: date-time
          example: 2024-07-31T12:00:00Z
        rewardProgramId:
          type: string
          description: This field indicate reward program Id
          example: "333"
        transactionsIncluded:
          type: boolean
          description: This field indicate transaction included
          example: true
        currentBalance:
          type: number
          description: This field indicate current balance of account
          format: double
          example: 4984.46
        openingDayBalance:
          type: number
          description: This field indicate opening day balance
          format: double
          example: 500.0
        principalBalance:
          type: number
          description: This field indicate principal balance
          format: double
          example: 100.0
        availableCashBalance:
          type: number
          description: This field indicate available cash balance
          format: double
          example: 100.0
        accountId:
          type: string
          description: This field indicate institution account Id
          example: "10001"
    Transactions:
      type: object
      properties:
        errorCode:
          type: integer
          description: This field indicate the error code of application
          format: int32
          readOnly: true
          example: 401
        errorMessage:
          type: string
          description: This field indicate the error message
          readOnly: true
          example: UNAUTHORIZED
        page:
          $ref: '#/components/schemas/Page'
        links:
          $ref: '#/components/schemas/Links'
        transactions:
          type: array
          description: This field indicate list of transactions object
          example: list of transactions object
          items:
            $ref: '#/components/schemas/TransactionsDetails'
    Statement:
      type: object
      properties:
        accountId:
          type: string
          description: This field indicate account Id
          example: "10001"
        statementId:
          type: string
          description: This field indicate statement Id
          example: "30001"
        statementDate:
          type: string
          description: This field indicate statementDate
          format: date-time
          example: 2024-07-31T12:00:00Z
        description:
          type: string
          description: This field indicate description
          example: MONTHLY_STATMENT
        status:
          type: string
          description: This field indicate status
          example: AVAILABLE
      description: This field indicate list of statements object
      example: list of statements object
    Statements:
      type: object
      properties:
        errorCode:
          type: integer
          description: This field indicate the error code of application
          format: int32
          readOnly: true
          example: 401
        errorMessage:
          type: string
          description: This field indicate the error message
          readOnly: true
          example: UNAUTHORIZED
        page:
          $ref: '#/components/schemas/Page'
        links:
          $ref: '#/components/schemas/Links'
        statements:
          type: array
          description: This field indicate list of statements object
          example: list of statements object
          items:
            $ref: '#/components/schemas/Statement'
    AccountPaymentNetwork:
      type: object
      properties:
        accountId:
          type: string
          description: This field indicate account Id
          example: "10001"
        bankId:
          type: string
          description: This field indicate bank Id
          example: "34567"
        identifier:
          type: string
          description: This field indicate identifier Id
          example: "56660"
        identifierType:
          type: string
          description: This field indicate identifierType
          example: TEST
        type:
          type: string
          description: This field indicate type
          example: Payment
        transferIn:
          type: boolean
          description: 'This field indicate transferIn '
          example: false
        transferOut:
          type: boolean
          description: 'This field indicate transferOut '
          example: false
        supportsRequestForPayment:
          type: boolean
          description: This field indicate supportsRequestForPayment Id
          example: false
        transferLimits:
          $ref: '#/components/schemas/TransferLimits'
      description: This field indicate list of paymentNetworks object
      example: list of paymentNetworks object
    AccountPaymentNetworkList:
      type: object
      properties:
        errorCode:
          type: integer
          description: This field indicate the error code of application
          format: int32
          readOnly: true
          example: 401
        errorMessage:
          type: string
          description: This field indicate the error message
          readOnly: true
          example: UNAUTHORIZED
        page:
          $ref: '#/components/schemas/Page'
        paymentNetworks:
          type: array
          description: This field indicate list of paymentNetworks object
          example: list of paymentNetworks object
          items:
            $ref: '#/components/schemas/AccountPaymentNetwork'
    TransferDetails:
      type: object
      properties:
        resetsOn:
          type: string
          description: This field indicate resetsOn
          example: "TRUE"
        transferMaxAmount:
          type: number
          description: This field indicate transfer max amount
          format: double
          example: 20000
        transferRemainingAmount:
          type: number
          description: This field indicate transfer remaining amount
          format: double
          example: 4000
        maxOccurrence:
          type: integer
          description: This field indicate maxOccurrence
          format: int32
          example: 1
        remainingOccurrence:
          type: integer
          description: This field indicate remainingOccurrence
          format: int32
          example: 0
    TransferLimits:
      type: object
      properties:
        out:
          $ref: '#/components/schemas/TransferDataOut'
    TransferDataOut:
      type: object
      properties:
        day:
          $ref: '#/components/schemas/TransferDetails'
        week:
          $ref: '#/components/schemas/TransferDetails'
        month:
          $ref: '#/components/schemas/TransferDetails'
        year:
          $ref: '#/components/schemas/TransferDetails'
        transaction:
          $ref: '#/components/schemas/TransferDetails'
    AccountContact:
      type: object
      properties:
        errorCode:
          type: integer
          description: This field indicate the error code of application
          format: int32
          readOnly: true
          example: 401
        errorMessage:
          type: string
          description: This field indicate the error message
          readOnly: true
          example: UNAUTHORIZED
        accountId:
          type: string
          description: This field indicate account Id
          example: "10001"
        holders:
          type: array
          description: This field indicate list of holders
          example: list of holders
          items:
            $ref: '#/components/schemas/AccountHolders'
        emails:
          type: array
          description: This field indicate list of emails id
          example: "['ernest.m.hemingway@domain.tld']"
          items:
            type: string
            description: This field indicate list of emails id
            example: "['ernest.m.hemingway@domain.tld']"
        addresses:
          type: array
          description: This field indicate list of addresses
          example: "['list of address']"
          items:
            $ref: '#/components/schemas/DeliveryAddress'
        telephones:
          type: array
          description: This field indicate list of telephones
          example: "['list of telephones']"
          items:
            $ref: '#/components/schemas/TelephoneNumber'
    AccountHolderName:
      type: object
      properties:
        first:
          type: string
          description: 'This field indicate first name of holder '
          example: Ernest
        middle:
          type: string
          description: 'This field indicate middle name of holder '
          example: Miller
        last:
          type: string
          description: This field indicate last name holder
          example: Hemingway
        company:
          type: string
          description: 'This field indicate company name '
          example: ABC
        prefix:
          type: string
          description: 'This field indicate prefix '
          example: MR
        suffix:
          type: string
          description: 'This field indicate suffix '
          example: IV
      description: This field indicate name pojo
      example: name pojo
    AccountHolders:
      type: object
      properties:
        relationship:
          type: string
          description: This field indicate relationship
          example: PRIMARY
        customerId:
          type: string
          description: This field indicate customer Id
          example: customer0000001
        type:
          type: string
          description: This field indicate type
          example: type
        name:
          $ref: '#/components/schemas/AccountHolderName'
        dateOfBirth:
          type: string
          description: 'This field indicate dateOfBirth '
          example: 09/03/1991
        taxId:
          type: string
          description: 'This field indicate taxId '
          example: "3456"
        taxIdCountry:
          type: string
          description: This field indicate taxIdCountry
          example: IND
        governmentId:
          type: string
          description: This field indicate governmentId
          example: "91"
        customerStartDate:
          type: string
          description: This field indicate customerStartDate
          format: date-time
          example: 2019-07-31T12:00:00Z
        lastActivityDate:
          type: string
          description: This field indicate lastActivityDate
          example: 2019-07-31T12:00:00Z
      description: This field indicate list of holders
      example: list of holders
    DeliveryAddress:
      type: object
      properties:
        line1:
          type: string
          description: This field indicate line1 of delivery address
          example: 1850 N Clark St
        line2:
          type: string
          description: This field indicate line2 of delivery address
          example: no. 103
        line3:
          type: string
          description: This field indicate line3 of delivery address
          example: st.134
        city:
          type: string
          description: This field indicate city of delivery address
          example: Chicago
        state:
          type: string
          description: This field indicate state of delivery address
          example: IL
        zip:
          type: string
          description: This field indicate zip of delivery address
          example: "60614"
        country:
          type: string
          description: This field indicate country of delivery address
          example: US
        postalCode:
          type: string
          description: This field indicate postalCode of delivery address
          example: "60614"
        type:
          type: string
          description: This field indicate type of delivery address. Possible values are MAILING,MAIN,STATEMENT,PREVIOUS,BUSINESS,HOME
          example: HOME
      description: This field indicate list of addresses
      example: "['list of address']"
    TelephoneNumber:
      type: object
      properties:
        type:
          type: string
          description: This field indicate country of telephone number
          example: US
        number:
          type: string
          description: This field indicate telephone number
          example: +1-34567-2456
      description: This field indicate list of telephones
      example: "['list of telephones']"
  securitySchemes:
    apiKey:
      type: apiKey
      description: Authorization Token to access Secured API!
      name: Authorization
      in: header