openapi: 3.2.0
info:
  title: Card Transactions API
  description: Operations for Card Transactions
  version: '1'
servers:
- url: https://sandbox-api.integrated.finance/v1/{instanceId}
  description: Sandbox
  variables: {}
- url: https://api.integrated.finance/v1/{instanceId}
  description: Production
  variables: {}
tags:
- name: Card Transactions
paths:
  /card-transactions:
    get:
      tags:
      - Card Transactions
      summary: List Card Transactions
      operationId: card-transactions.list
      parameters:
      - name: metadata.page.number
        in: query
        description: 0-indexed page number
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: metadata.page.size
        in: query
        description: page size
        schema:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
          default: 20
      - name: metadata.sort
        in: query
        description: default direction is ascending
        schema:
          type: string
        example: data.alias,desc
      - name: data.cardTransaction.cardId
        in: query
        schema:
          type: string
      - name: data.cardTransaction.clientId
        in: query
        schema:
          type: string
      - name: data.cardTransaction.accountId
        in: query
        schema:
          type: string
      - name: data.cardTransaction.type
        in: query
        schema:
          type: string
          enum:
          - payment
          - refund
          - chargeback
          - atm-withdrawal
          - money-transfer
      - name: data.cardTransaction.status
        in: query
        schema:
          type: string
          enum:
          - authorised
          - declined
          - settled
          - reversed
      - name: data.cardTransaction.transactionNumber
        in: query
        schema:
          type: string
      - name: data.cardTransaction.transactionCurrency
        in: query
        schema:
          type: string
      - name: data.cardTransaction.serviceProvider
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Card transaction list returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardTransactionListResponse'
  /card-transactions/{id}:
    get:
      tags:
      - Card Transactions
      summary: Get a Card Transaction
      operationId: card-transactions.get
      parameters:
      - name: id
        in: path
        description: ID of the card transaction in UUID format
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Card transaction resource returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardTransactionGetResponse'
components:
  schemas:
    CardTransactionListDataContainer:
      type: object
      properties:
        cardTransaction:
          $ref: '#/components/schemas/CardTransactionResourceQueryInput'
        cardTransactions:
          type: array
          items:
            $ref: '#/components/schemas/CardTransaction'
    CardTransactionType:
      type: string
      description: type of the card transaction
      readOnly: true
      enum:
      - payment
      - refund
      - chargeback
      - atm-withdrawal
      - incoming-transfer
    CardTransactionGetResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/CardTransactionGetWorkflowContainer'
        data:
          $ref: '#/components/schemas/CardTransactionGetDataContainer'
        connect:
          $ref: '#/components/schemas/CardTransactionGetConnectContainer'
        metadata:
          $ref: '#/components/schemas/CardTransactionGetMetadataContainer'
    CardTransactionGetMetadataContainer:
      type: object
    Pos:
      type: object
      properties:
        cardholderPresent:
          $ref: '#/components/schemas/CardholderPresentType'
        cardPresent:
          $ref: '#/components/schemas/CardPresentType'
        cardDataInputMethod:
          $ref: '#/components/schemas/CardDataInputMethod'
        authentication:
          $ref: '#/components/schemas/CardholderAuthentication'
        chipFallback:
          $ref: '#/components/schemas/ChipFallbackIndicator'
        fraud:
          $ref: '#/components/schemas/PosFraudIndicator'
        securityProtocol:
          $ref: '#/components/schemas/SecurityProtocolType'
        cardAuthentication3DSecureMethod:
          $ref: '#/components/schemas/CardAuthentication3DSecureMethod'
      description: pos data
      readOnly: true
    Merchant:
      type: object
      properties:
        name:
          type: string
        id:
          type: string
        networkId:
          type: string
        taxId:
          type: string
        address:
          $ref: '#/components/schemas/Address'
        phone:
          type: string
        website:
          type: string
        category:
          $ref: '#/components/schemas/MerchantCategory'
      description: merchant
      readOnly: true
    CardTransactionGetDataContainer:
      type: object
      properties:
        cardTransaction:
          $ref: '#/components/schemas/CardTransaction'
    CardholderAuthenticationMethod:
      type: string
      enum:
      - not-authenticated
      - pin
      - electronic-signature-analysis
      - biometric
      - biographic
      - manual-signature-verification
      - other-manual-verification
      - other
      - unknown
      - smartphone-passcode
      - smartphone-pattern
      - hardware-device
      - hardware-device-user-verification
      - software-application
      - software-application-user-verification
      - 3d-secure
    CardTransactionListMetadataContainer:
      required:
      - page
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageMetadata'
    CardTransactionListWorkflowContainer:
      type: object
    CardholderAuthenticationEntityType:
      type: string
      enum:
      - not-authenticated
      - card-chip
      - electronic-signature-analysis
      - authorising-agent
      - merchant
      - other
      - unknown
      - cardholder-device
      - token-requestor
    CardPresentType:
      type: string
      enum:
      - present
      - not-present
      - unknown
    CardTransactionListConnectContainer:
      type: object
    CardTransactionGetWorkflowContainer:
      type: object
    CardTransactionResourceQueryInput:
      type: object
      properties:
        geCardId:
          type: string
          format: uuid
        clientId:
          type: array
          items:
            type: string
            format: uuid
        accountId:
          type: string
          format: uuid
        transactionCurrency:
          type: array
          items:
            type: string
        transactionNumber:
          type: string
        type:
          type: array
          items:
            $ref: '#/components/schemas/CardTransactionType'
        status:
          type: array
          items:
            $ref: '#/components/schemas/CardTransactionStatus'
        clientTitle:
          type: string
        clientNumber:
          type: array
          items:
            type: string
        username:
          type: string
        cardAlias:
          type: string
        lastFourDigits:
          type: string
        firstSixDigits:
          type: string
        accountAlias:
          type: string
        iban:
          type: array
          items:
            type: string
        accountNumber:
          type: array
          items:
            type: string
        maxAmount:
          type: number
        minAmount:
          type: number
        currency:
          type: array
          items:
            type: string
        serviceProvider:
          type: array
          items:
            type: string
        serviceProviderId:
          type: string
        serviceProviderReference:
          type: string
        creationDateFrom:
          type: string
          format: date
        creationDateTo:
          type: string
          format: date
        merchantName:
          type: string
        description:
          type: string
        reason:
          type: string
    Address:
      required:
      - city
      - country
      - street
      type: object
      properties:
        country:
          maxLength: 2
          minLength: 2
          pattern: ^[A-Z]{2}$
          type: string
        region:
          type: string
        postalCode:
          type: string
        city:
          type: string
        street:
          type: string
        houseNumber:
          type: string
        refinement:
          type: string
    TransactionDirection:
      type: string
      description: Direction
      readOnly: true
      enum:
      - credit
      - debit
    CardTransactionEnrichmentMap:
      type: object
      description: Card transaction enrichment data
      readOnly: true
    CardTransactionListResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/CardTransactionListWorkflowContainer'
        data:
          $ref: '#/components/schemas/CardTransactionListDataContainer'
        connect:
          $ref: '#/components/schemas/CardTransactionListConnectContainer'
        metadata:
          $ref: '#/components/schemas/CardTransactionListMetadataContainer'
    MerchantCategory:
      type: object
      properties:
        code:
          type: string
        description:
          type: string
    ChipFallbackIndicator:
      type: string
      enum:
      - not-available
      - previous-not-fallback
      - previous-fallback
    CardTransactionStatus:
      type: string
      description: status of the card transaction
      readOnly: true
      enum:
      - authorised
      - declined
      - settled
      - reversed
    PageMetadata:
      required:
      - number
      - size
      - totalElements
      - totalPages
      type: object
      properties:
        size:
          minimum: 0
          type: integer
          description: number of elements in this page
          format: int32
        number:
          minimum: 0
          type: integer
          description: index of page starting from 0
          format: int32
        totalElements:
          minimum: 0
          type: integer
          description: total number of elements in all of the pages
          format: int64
          readOnly: true
        totalPages:
          minimum: 0
          type: integer
          description: number of total pages
          format: int32
          readOnly: true
    CardholderPresentType:
      type: string
      enum:
      - present
      - not-present-unknown
      - not-present-mail-order
      - not-present-telephone-order
      - not-present-standing-auth
      - not-present-e-commerce
      - not-present-installment
      - unknown
    CardTransaction:
      type: object
      properties:
        id:
          type: string
          description: ID of the card transaction
          format: uuid
          readOnly: true
        cardId:
          type: string
          description: ID of the card
          format: uuid
          readOnly: true
        clientId:
          type: string
          description: ID of the client
          format: uuid
          readOnly: true
        matchingTransactionId:
          type: string
          description: ID of matching card transaction
          format: uuid
          readOnly: true
        accountId:
          type: string
          description: ID of the account
          format: uuid
          readOnly: true
        accountCurrency:
          type: string
          description: account currency
          readOnly: true
        transactionNumber:
          type: string
          description: transaction number
          readOnly: true
        type:
          $ref: '#/components/schemas/CardTransactionType'
        status:
          $ref: '#/components/schemas/CardTransactionStatus'
        transactionAmount:
          type: number
          description: transaction amount
          format: double
          readOnly: true
        transactionCurrency:
          type: string
          description: transaction currency
          readOnly: true
        feeAmount:
          type: number
          description: fee amount
          format: double
          readOnly: true
        feeCurrency:
          type: string
          description: fee currency
          readOnly: true
        billingAmount:
          type: number
          description: billing amount
          format: double
          readOnly: true
        billingCurrency:
          type: string
          description: billing currency
          readOnly: true
        settlementAmount:
          type: number
          description: settlement amount
          format: double
          readOnly: true
        settlementCurrency:
          type: string
          description: settlement currency
          readOnly: true
        effectiveTransactionAmount:
          type: number
          description: effective transaction amount
          format: double
          readOnly: true
        effectiveFeeAmount:
          type: number
          description: effective fee amount
          format: double
          readOnly: true
        transactionExchangeRate:
          type: number
          description: transaction exchange rate
          format: double
          readOnly: true
        feeExchangeRate:
          type: number
          description: fee exchange rate
          format: double
          readOnly: true
        merchant:
          $ref: '#/components/schemas/Merchant'
        pos:
          $ref: '#/components/schemas/Pos'
        serviceProvider:
          type: string
          description: service provider of the card transaction
          readOnly: true
        serviceProviderEntityId:
          type: string
          description: service provider ID of the card transaction
          readOnly: true
        serviceProviderEntityReference:
          type: string
          description: service provider reference of the card transaction
          readOnly: true
        description:
          type: string
          description: card transaction description
          readOnly: true
        reason:
          type: string
          description: reason
          readOnly: true
        direction:
          $ref: '#/components/schemas/TransactionDirection'
        totalAmount:
          type: number
          description: total amount
          format: double
          readOnly: true
        creationDateTime:
          type: string
          description: creation time of the card transaction
          format: date-time
          readOnly: true
        enrichment:
          $ref: '#/components/schemas/CardTransactionEnrichmentMap'
      description: Card Transaction Resource Object
    SecurityProtocolType:
      type: string
      enum:
      - none
      - channel-encryption
      - not-applicable
    CardDataInputMethod:
      type: string
      enum:
      - not-provided
      - manual
      - magnetic-stripe
      - barcode
      - optical-character-recognition
      - emv-contact
      - key-entered
      - emv-contactless
      - e-commerce
      - e-commerce-emv-cryptogram
      - magnetic-stripe-contactless
      - account-data-on-file
      - key-entered-by-acquirer
      - micr-reader
      - qr-code
    CardholderAuthentication:
      type: object
      properties:
        method:
          $ref: '#/components/schemas/CardholderAuthenticationMethod'
        entity:
          $ref: '#/components/schemas/CardholderAuthenticationEntityType'
    PosFraudIndicator:
      type: string
      enum:
      - no-problem
      - merchant-suspicious
      - merchant-verified-cardholder-id
    CardAuthentication3DSecureMethod:
      type: string
      enum:
      - unknown
      - unrecognized
      - no-authentication
      - password
      - secret-key
      - pki
      - otp-sms
      - otp-card-reader
      - otp-app
      - otp-other
      - other
      - kba
      - oob-biometric
      - oob-app
      - oob-other
      - push-confirmation
      - frictionless-rba
      - frictionless
      - server-responding
      - delegated
      - challenge-unknown
      - idcx
      - aav-refresh
    CardTransactionGetConnectContainer:
      type: object
x-provenance:
  method: searched
  source: https://developer.integrated.finance/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.integrated.finance/reference/card-transaction-authenticationsget.md
  - https://developer.integrated.finance/reference/card-transaction-authenticationslist.md
  - https://developer.integrated.finance/reference/card-transaction-authenticationsupdate.md
  - https://developer.integrated.finance/reference/card-transactionsget.md
  - https://developer.integrated.finance/reference/card-transactionslist.md
  merge:
    pages: 5
    deduped: 42
    conflicts_kept_first: 0