Silverflow Retrieve Charges API

openapi: 3.2.0
info:
  title: Silverflow Retrieve Charges API
  version: 1.417.0
  contact:
    name: API Support
    email: support@silverflow.com
  license:
    name: Commercial
  description: 'Operations tagged Retrieve Charges across 2 of this provider''s published API definitions: silverflow-openapi.yml, silverflow-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://eu-west-1.api.silverflow.com/v1
  description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
- url: https://us-east-2.api.silverflow.com/v1
  description: Production URL for North America
- url: https://eu-west-1.api-sbx.silverflow.com/v1
  description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
security:
- ApiKey: []
- BearerToken: []
tags:
- name: Retrieve Charges
  description: Retrieve a single or multiple charges.
paths:
  /charges/{chargeKey}:
    get:
      operationId: getCharge
      summary: Get Charge
      description: 'Returns the charge identified by the charge key.


        Requires `charges:Get` permission.

        '
      tags:
      - Retrieve Charges
      parameters:
      - $ref: '#/components/parameters/chargeKey'
      responses:
        '200':
          description: The charge
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Charge'
        '400':
          $ref: '#/components/responses/responses-InvalidInputError'
        '401':
          $ref: '#/components/responses/openapi_components-responses-UnauthorizedError'
        '403':
          $ref: '#/components/responses/components-responses-ForbiddenError'
        '404':
          $ref: '#/components/responses/EntityNotFoundError'
        '429':
          $ref: '#/components/responses/components-responses-TooManyRequestsError'
        '500':
          $ref: '#/components/responses/responses-InternalServerError'
    servers:
    - url: https://eu-west-1.api.silverflow.com/v1
      description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
    - url: https://us-east-2.api.silverflow.com/v1
      description: Production URL for North America
    - url: https://eu-west-1.api-sbx.silverflow.com/v1
      description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
  /charges:
    get:
      operationId: getCharges
      summary: List Charges
      description: 'This operation supports 2 distinct use cases:


        1. Get a paged list of all charges, optionally filtered by `date` or period (`from`, `to`).

        2. Get a paged list of the charges with the specified `transactionReference`.


        Requires `charges:List` permission.

        '
      tags:
      - Retrieve Charges
      parameters:
      - $ref: '#/components/parameters/components-parameters-offsetToken'
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/parameters-from'
      - $ref: '#/components/parameters/parameters-to'
      - $ref: '#/components/parameters/date'
      - $ref: '#/components/parameters/transactionReferenceQs'
      responses:
        '200':
          description: A (paged) list of charges
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargesPage'
        '400':
          $ref: '#/components/responses/InvalidToOrFromDateError'
        '401':
          $ref: '#/components/responses/openapi_components-responses-UnauthorizedError'
        '403':
          $ref: '#/components/responses/components-responses-ForbiddenError'
        '429':
          $ref: '#/components/responses/components-responses-TooManyRequestsError'
        '500':
          $ref: '#/components/responses/responses-InternalServerError'
    servers:
    - url: https://eu-west-1.api.silverflow.com/v1
      description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
    - url: https://us-east-2.api.silverflow.com/v1
      description: Production URL for North America
    - url: https://eu-west-1.api-sbx.silverflow.com/v1
      description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
components:
  schemas:
    GenericCharge:
      type: object
      additionalProperties: false
      required:
      - key
      - created
      - status
      - type
      - localTransactionDateTime
      - merchantAcceptorRef
      - card
      - amount
      - fraudLiability
      - authorizationIsoFields
      - authentication
      - version
      description: 'A charge

        '
      properties:
        key:
          $ref: '#/components/schemas/chargeKey'
        refundedChargeKey:
          $ref: '#/components/schemas/refundedChargeKey'
        merchantAcceptorRef:
          $ref: '#/components/schemas/components-schemas-AcceptorRef'
        card:
          $ref: '#/components/schemas/OutputCard'
        tokenDetails:
          $ref: '#/components/schemas/StoredTokenDetails'
        amount:
          $ref: '#/components/schemas/components-schemas-Amount'
        cardholderBillingAmount:
          $ref: '#/components/schemas/CardholderBillingAmount'
        type:
          $ref: '#/components/schemas/GetResponseChargeType'
        clearingMode:
          $ref: '#/components/schemas/clearingMode'
        status:
          $ref: '#/components/schemas/ChargeStatus'
        authentication:
          $ref: '#/components/schemas/ChargeAuthentication'
        localTransactionDateTime:
          $ref: '#/components/schemas/localTransactionDateTime'
        transactionType:
          $ref: '#/components/schemas/TransactionType'
        transactionReference:
          $ref: '#/components/schemas/transactionReference'
        fraudLiability:
          $ref: '#/components/schemas/fraudLiability'
        authorizationIsoFields:
          $ref: '#/components/schemas/authorizationIsoFields'
        billingAddress:
          description: The billing address of the Agent
          $ref: '#/components/schemas/BillingAddress'
        shippingAddress:
          $ref: '#/components/schemas/components-schemas-Address'
        clearAfter:
          $ref: '#/components/schemas/clearAfter'
        dynamicDescriptor:
          $ref: '#/components/schemas/schemas-DynamicDescriptor'
        foreignRetailer:
          $ref: '#/components/schemas/schemas-foreignRetailer'
        riskCheckResult:
          $ref: '#/components/schemas/RiskCheckResult'
        created:
          $ref: '#/components/schemas/openapi_components-schemas-created'
        lastModified:
          $ref: '#/components/schemas/components-schemas-lastModified'
        version:
          $ref: '#/components/schemas/schemas-version'
          example: 1
    BaseTerminal:
      type: object
      required:
      - id
      - attended
      properties:
        id:
          type: string
          description: Terminal's ID
          pattern: ^[a-zA-Z0-9]+$
          minLength: 1
          maxLength: 8
          example: AAFF
        attended:
          type: boolean
          description: Whether the terminal is attended or not.
    mitFundingSca:
      oneOf:
      - $ref: '#/components/schemas/MitFundingThreeDsAuthentication'
      - $ref: '#/components/schemas/ScaBEP'
      - $ref: '#/components/schemas/AuthenticationOutOfScope'
      - $ref: '#/components/schemas/AuthenticationExempt'
      - $ref: '#/components/schemas/ScaMit'
    authorizationIsoFields:
      description: Object containing the raw values from the ISO8583 response message received from the network.
      oneOf:
      - $ref: '#/components/schemas/authorizationIsoFieldsAmericanExpress'
      - $ref: '#/components/schemas/authorizationIsoFieldsBancontact'
      - $ref: '#/components/schemas/authorizationIsoFieldsDiners'
      - $ref: '#/components/schemas/authorizationIsoFieldsDiscover'
      - $ref: '#/components/schemas/authorizationIsoFieldsMastercard'
      - $ref: '#/components/schemas/authorizationIsoFieldsVisa'
    POS:
      allOf:
      - type: object
        required:
        - type
        properties:
          type:
            type: string
            enum:
            - pos
      - $ref: '#/components/schemas/BaseTerminal'
      - type: object
        required:
        - capabilities
        properties:
          capabilities:
            type: array
            description: 'The capabilities of the terminal. This can be one or multiple, and if more than one is specified it means that it is capable of all of those things.


              #### Restrictions


              If `capabilities` include `keyEntry` or `signature` then `attended` must be set to `true`.

              '
            items:
              $ref: '#/components/schemas/TerminalCapability'
            example:
            - contactChip
            - contactlessChip
            - contactMagStripe
            - oneTap
    SoftPOS:
      allOf:
      - type: object
        required:
        - type
        properties:
          type:
            type: string
            enum:
            - softpos
      - $ref: '#/components/schemas/BaseTerminal'
      - type: object
        required:
        - attended
        - capabilities
        properties:
          attended:
            type: boolean
            enum:
            - true
          capabilities:
            type: array
            description: 'The capabilities of the terminal. This can be one or multiple, and if more than one is specified it means that it is capable of all of those things.

              '
            items:
              $ref: '#/components/schemas/softPosTerminalCapability'
            example:
            - onlinePin
            - contactlessChip
            - noCvm
            - oneTap
    ForeignRetailerDisabled:
      type: object
      description: Transaction does not involve a foreign retailer
      required:
      - indicator
      additionalProperties: false
      properties:
        indicator:
          type: boolean
          enum:
          - false
          description: Specifies if end seller in the transaction is a foreign retailer
    StatusPos:
      type: object
      required:
      - authentication
      - authorization
      - clearing
      description: 'The status property provides a high-level representation of the lifecycle of a charge. For a complete history, the actions should be used.

        '
      properties:
        authentication:
          type: string
          description: Strong Customer Authentication (SCA) status of the charge
          enum:
          - none
        authorization:
          type: string
          description: 'Authorization status of the charge.


            Value ''approved-purchase-amount-only'' is only returned for Mastercard charges using ''amount.breakdown.cashback''.

            In this case, only the ''amount.breakdown.baseAmount'' was approved, but not the cashback.

            '
          enum:
          - none
          - approved
          - approved-partial
          - declined
          - reversed
          - approved-purchase-amount-only
          example: approved
        clearing:
          $ref: '#/components/schemas/ClearingStatus'
    terminalEntryMode:
      description: "This field indicates the method used for PAN entry on \nthe terminal to initiate the transaction.\n"
      type: string
      enum:
      - contactless
      - manual-entry
      - chip
      - magstripe
      - magstripe-fallback
    AuthorizationStatus:
      type: string
      description: Authorization status of the charge.
      enum:
      - none
      - approved
      - approved-partial
      - declined
      - reversed
      example: approved
    ChargeStatus:
      type: object
      required:
      - authentication
      - authorization
      - clearing
      description: 'The status property provides a high-level representation of the lifecycle of a charge.

        For a complete history, the actions should be used.

        '
      properties:
        authentication:
          $ref: '#/components/schemas/AuthenticationStatus'
        authorization:
          $ref: '#/components/schemas/ChargeAuthorizationStatus'
        clearing:
          $ref: '#/components/schemas/ChargeClearingStatus'
    complianceReasonBEP:
      description: 'Indicates the reason for the SCA compliance.

        '
      type: string
      enum:
      - mandated
    TransactionType:
      type: string
      enum:
      - cryptocurrency
      - high-risk-securities
      - central-bank-digital-currency
      - stablecoin
      - blockchain-native-coin
      - non-fungible-token
      description: 'In case of a special transaction type, this allows you to specify which one.


        `type.intent` needs to be `purchase`.


        - `cryptocurrency`: A transaction involving the purchasing of cryptocurrencies. Use this for Visa only if specific type of digital asset cannot be determined.

        - `high-risk-securities`: A transaction involving the purchasing of high-risk securities. Only supported for Mastercard.

        - `central-bank-digital-currency`: A transaction involving purchase of a Central Bank Digital Currency (CBDC). Only supported for Visa.

        - `stablecoin`: A transaction involving purchase of stablecoins.

        - `blockchain-native-coin`: A transaction involving purchase of a non fiat backed blockchain coin. Only supported for Visa.

        - `non-fungible-token`: A transaction involving purchase of a Non Fungible Token (NFT). Only supported for Visa.


        Not supported for Diners.

        '
    openapi_components-schemas-stateOrProvince:
      type: string
      pattern: ^[\w -,\.\-\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF]+$
      minLength: 1
      maxLength: 120
      description: 'The state (US) or province (non-US) of the address.

        '
      example: NH
    isoFieldResponseCodeDescription:
      type: string
      description: The description of the `responseCode`
      example: Approved
    schemas-foreignRetailer:
      description: 'Used for transactions fulfilled partly or fully by end seller that is in a different country than the Marketplace or Ramp Provider. <span class="tag network-tag visa-tag">VISA</span> <a class="experimental-tag-link" href="https://docs.silverflow.com/guides/api-lifecycle#tag/EXPERIMENTAL-Tag"><span class="tag experimental-tag">EXPERIMENTAL</span></a>

        '
      oneOf:
      - $ref: '#/components/schemas/ForeignRetailerDisabled'
      - $ref: '#/components/schemas/ForeignRetailerEnabled'
    components-schemas-offsetToken:
      type: string
      pattern: ^[a-zA-Z0-9%]+$
      minLength: 1
      maxLength: 2048
      example: LUtyr0s918rNZ5WuWDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9YccUOtDSoyLtc4kAiOLkmjSW5zLa8OCnOXXBRja2rDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9Yc
    FundingPayoutThreeDsAuthentication:
      type: object
      required:
      - compliance
      - complianceReason
      - method
      - result
      description: 'Object container for strong customer authentication.

        '
      properties:
        method:
          $ref: '#/components/schemas/method'
        compliance:
          type: string
          enum:
          - mandated
          - mit
          - exemption
        complianceReason:
          $ref: '#/components/schemas/threeDsComplianceReason'
        result:
          $ref: '#/components/schemas/FundingPayoutThreeDsAuthenticationResultResponse'
    clearingMode:
      type: string
      enum:
      - auto
      - manual
      description: 'The clearing method for the charge.

        - `auto`: The charge is cleared automatically as soon as possible. To delay clearing, provide a `clearAfter` timestamp.

        - `manual`: The charge must be manually cleared later.

        '
      default: auto
    softPosTerminalCapability:
      type: string
      enum:
      - contactlessChip
      - onlinePin
      - signature
      - noCvm
      - oneTap
    PayoutCharge:
      type: object
      description: 'A payout charge

        '
      required:
      - key
      - created
      - status
      - type
      - amount
      - merchantAcceptorRef
      - authorizationIsoFields
      - authentication
      - sender
      - card
      - version
      - localTransactionDateTime
      properties:
        key:
          $ref: '#/components/schemas/chargeKey'
        merchantAcceptorRef:
          $ref: '#/components/schemas/components-schemas-AcceptorRef'
        card:
          $ref: '#/components/schemas/OutputCard'
        amount:
          $ref: '#/components/schemas/components-schemas-Amount'
        type:
          $ref: '#/components/schemas/PayoutChargeType'
        clearingMode:
          $ref: '#/components/schemas/clearingMode'
        status:
          $ref: '#/components/schemas/StatusWithoutPartialApproval'
        authentication:
          $ref: '#/components/schemas/FundingPayoutChargeAuthentication'
        localTransactionDateTime:
          $ref: '#/components/schemas/localTransactionDateTime'
        transactionReference:
          $ref: '#/components/schemas/transactionReference'
        fraudLiability:
          description: 'Which party is liable in case of fraud.

            '
          deprecated: true
          type: string
          enum:
          - acquirer
          - issuer
        authorizationIsoFields:
          $ref: '#/components/schemas/authorizationIsoFields'
        sender:
          $ref: '#/components/schemas/PayoutSender'
        receiver:
          $ref: '#/components/schemas/PayoutReceiver'
        riskCheckResult:
          $ref: '#/components/schemas/RiskCheckResult'
        purposeOfPayment:
          $ref: '#/components/schemas/purposeOfPayment'
        created:
          $ref: '#/components/schemas/openapi_components-schemas-created'
        lastModified:
          $ref: '#/components/schemas/components-schemas-lastModified'
        version:
          $ref: '#/components/schemas/schemas-version'
    purposeOfPayment:
      type: string
      minLength: 1
      maxLength: 12
      description: 'A code that describes the purpose of payment to classify and report the nature and purpose of the transaction. Refer to Visa documentation for country specific requirements for this field.

        '
    PosCharge:
      type: object
      required:
      - key
      - created
      - terminal
      - status
      - type
      - merchantAcceptorRef
      - authorizationIsoFields
      - amount
      - version
      - card
      - localTransactionDateTime
      description: 'A POS charge

        '
      properties:
        key:
          $ref: '#/components/schemas/chargeKey'
        merchantAcceptorRef:
          $ref: '#/components/schemas/components-schemas-AcceptorRef'
        card:
          $ref: '#/components/schemas/OutputCard'
        amount:
          allOf:
          - description: 'The amount encoded as an object with a `value` in minor units and a `currency` code. In case of a (partially) approved charge, this is the authorized amount.


              An optional `breakdown` can be provided to indicate specific sub-amounts.

              '
          - $ref: '#/components/schemas/ResponsePosAmount'
        type:
          $ref: '#/components/schemas/ChargePosType'
        status:
          $ref: '#/components/schemas/StatusPos'
        localTransactionDateTime:
          $ref: '#/components/schemas/localTransactionDateTime'
        transactionReference:
          $ref: '#/components/schemas/transactionReference'
        authorizationIsoFields:
          $ref: '#/components/schemas/PosAuthorizationIsoFields'
        clearingMode:
          $ref: '#/components/schemas/clearingMode'
        clearAfter:
          $ref: '#/components/schemas/clearAfter'
        terminal:
          $ref: '#/components/schemas/Terminal'
        created:
          $ref: '#/components/schemas/openapi_components-schemas-created'
        lastModified:
          $ref: '#/components/schemas/components-schemas-lastModified'
        version:
          $ref: '#/components/schemas/schemas-version'
    openapi_components-schemas-city:
      type: string
      pattern: ^[\w -,\.\-\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF]+$
      minLength: 1
      maxLength: 120
      description: 'The city of the address.

        '
      example: Amsterdam
    cvcResultBEP:
      enum:
      - none
      description: The result of cvc verification
    GetResponseChargeType:
      description: 'Describes the kind of charge the merchant wants to submit.

        '
      type: object
      required:
      - intent
      - cardEntry
      - order
      properties:
        intent:
          description: 'The intention of the cardholder.

            '
          type: string
          enum:
          - purchase
          - reservation
          - account-status
          - refund
        cardEntry:
          $ref: '#/components/schemas/responseCardEntry'
        order:
          description: 'The method used to place the order.

            '
          type: string
          enum:
          - checkout
          - unspecified
          - mail
          - phone
          - one-click
          - recurring
          - ucof
          - installment
          - standing-order
          - counter
        sequence:
          oneOf:
          - $ref: '#/components/schemas/sequence'
          - type: string
            title: Legacy Sequence
            description: 'For older charges created on the [`POST /charges`](#operation/createCharge) endpoint, this field can have a value of `subsequent`.

              '
            enum:
            - subsequent
    components-schemas-CountryCodeAlpha3:
      type: object
      required:
      - alpha3
      additionalProperties: false
      properties:
        alpha3:
          $ref: '#/components/schemas/schemas-countryCodeAlpha3'
    StatusWithoutPartialApproval:
      type: object
      required:
      - authentication
      - authorization
      - clearing
      description: 'The status property provides a high-level representation of the lifecycle of a charge.

        For a complete history, the actions should be used.

        '
      properties:
        authentication:
          $ref: '#/components/schemas/AuthenticationStatus'
        authorization:
          $ref: '#/components/schemas/AuthorizationStatusWithoutPartialApproval'
        clearing:
          $ref: '#/components/schemas/ClearingStatus'
    complianceBEP:
      description: 'Indicates SCA compliance of the charges

        '
      type: string
      enum:
      - mandated
    AuthenticationOutOfScope:
      type: object
      required:
      - compliance
      - complianceReason
      - method
      properties:
        method:
          type: string
          enum:
          - none
        compliance:
          type: string
          enum:
          - out-of-scope
        complianceReason:
          type: string
          enum:
          - none
          - moto
          - one-leg
          - anonymous-prepaid
          - recurring
    openapi_components-schemas-created:
      type: string
      description: The date and time this object was created
      format: iso-8601-date-time
      readOnly: true
    schemas-countryCodeAlpha2:
      type: string
      pattern: ^[A-Z]+$
      minLength: 2
      maxLength: 2
      externalDocs:
        description: Find more info here.
        url: https://www.iso.org/iso-3166-country-codes.html
      example: NL
    isoFieldResponseCode:
      type: string
      description: Contents of field 39
      example: '00'
    avsResult:
      description: The result of the AVS verification
      type: string
      enum:
      - none
      - match
      - partial-match
      - no-match
      - not-processed
    fundingPayoutSca:
      oneOf:
      - $ref: '#/components/schemas/FundingPayoutThreeDsAuthentication'
      - $ref: '#/components/schemas/ScaBEP'
      - $ref: '#/components/schemas/AuthenticationOutOfScope'
      - $ref: '#/components/schemas/AuthenticationExempt'
      - $ref: '#/components/schemas/ScaMit'
    AuthenticationExempt:
      type: object
      required:
      - compliance
      - complianceReason
      - method
      properties:
        method:
          type: string
          enum:
          - none
        compliance:
          type: string
          enum:
          - exemption
        complianceReason:
          type: string
          enum:
          - whitelist
          - auto
          - mit
          - tra
          - recurring
          - low-value
          - delegation
          - scp
          - wip
    FundingIntent:
      description: 'The intention of the cardholder

        '
      type: string
      enum:
      - funding
    sca:
      oneOf:
      - $ref: '#/components/schemas/ThreeDsAuthentication'
      - $ref: '#/components/schemas/ScaBEP'
      - $ref: '#/components/schemas/AuthenticationOutOfScope'
      - $ref: '#/components/schemas/AuthenticationExempt'
      - $ref: '#/components/schemas/ScaMit'
    components-schemas-Address:
      type: object
      required:
      - countryCode
      - city
      - line1
      - postalCode
      additionalProperties: false
      description: 'A physical postal address

        '
      properties:
        countryCode:
          $ref: '#/components/schemas/schemas-CountryCode'
        stateOrProvince:
          $ref: '#/components/schemas/openapi_components-schemas-stateOrProvince'
        city:
          $ref: '#/components/schemas/openapi_components-schemas-city'
        line1:
          $ref: '#/components/schemas/openapi_components-schemas-line1'
        line2:
          $ref: '#/components/schemas/openapi_components-schemas-line2'
        postalCode:
          $ref: '#/components/schemas/openapi_components-schemas-postalCode'
    ValidationError:
      type: object
      required:
      - path
      - message
      properties:
        path:
          type: string
          description: A relative path to the error location within the request body.
        errorCode:
          type: string
          description: A code that identifies the error.
        message:
          type: string
          description: A brief description of the validation error.
    atmTerminalEntryMode:
      description: 'This field indicates the method used for PAN entry on the ATM terminal to initiate the transaction.

        '
      type: string
      enum:
      - chip
      - contactless
      - contactless-magstripe
      - magstripe
      - magstripe-fallback
    Identification:
      description: Identification used to verify sender or receiver.
      type: object
      required:
      - value
      - type
      properties:
        type:
          description: "Type of identification:\n  - `date-of-birth` - Date of birth according to [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) \n  - `national-identification` - National identification\n  - `passport-number` - Passport number\n  - `driver-license` - Driver license\n  - `tax-identification` - Tax identification\n  - `company-registration-number` - Company registration number\n  - `social-security-number` - Social security number\n  - `other` - Customer identification (unspecified)\n"
          type: string
          enum:
          - date-of-birth
          - national-identification
          - passport-number
          - driver-license
          - tax-identification
          - company-registration-number
          - social-security-number
          - other
        value:
          description: 'The value used for identification of the sender or receiver.

            For BTHD (date of birth) the format should be [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)

            '
          type: string
          minLength: 1
          maxLength: 35
        issuingCountry:
          description: Issuing country of the identification, according to [ISO 3166-3](https://en.wikipedia.org/wiki/ISO_3166-3)
          type: string
          minLength: 3
          maxLength: 3
    authorizationIsoFieldsVisa:
      allOf:
      - $ref: '#/components/schemas/commonIsoFields'
      - type: object
        required:
        - networkCode
        - systemTraceAuditNumber
        - retrievalReferenceNumber
        - eci
        - networkSpecificFields
        properties:
          authorizationCode:
            $ref: '#/components/schemas/isoFieldAuthorizationCode'
          networkCode:
            $ref: '#/components/schemas/isoFieldNetworkCode'
          systemTraceAuditNumber:
            $ref: '#/components/schemas/isoFieldSystemTraceAuditNumber'
          retrievalReferenceNumber:
            $ref: '#/components/schemas/isoFieldRetrievalReferenceNumber'
          eci:
            $ref: '#/components/schemas/isoFieldEciVisa'
          networkSpecificFields:
            $ref: '#/components/schemas/visaSpecificFields'
    ChargePosType:
      description: Describes the kind of POS charge the merchant wants to submit.
      type: object
      required:
      - intent
      - cardEntry
      - order
      - terminalEntryMode
      properties:
        intent:
          $ref: '#/components/schemas/intentPos'
        cardEntry:
          $ref: '#/components/schemas/cardEntryPos'
        order:
          $ref: '#/components/schemas/orderPos'
        terminalEntryMode:
          $ref: '#/components/schemas/terminalEntryMode'
        sequence:
          $ref: '#/components/schemas/sequencePos'
    schemas-countryCodeNumeric:
      type: string
      pattern: ^[0-9]+$
      minLength: 3
      maxLength: 3
      externalDocs:
        description: Find more info here.
        url: https://www.iso.org/iso-3166-country-codes.html
      example: '528'
    StoredTokenDetailsNetwork:
      type: object
      required:
      - type
      properties:
        type:
          type: string
          description: Details about a token from one of the card networks
          enum:
          - network
        eci:
          $ref: '#/components/schemas/schemas-eci'
    openapi_components-schemas-postalCode:
      type: string
      pattern: ^[A-Z0-9]+( [A-Z0-9]*)?$
      minLength: 1
      maxLength: 10
      description: 'The postal code of the address, allowing a single separating space.

        '
      example: 1234BC
    MitChargeFromInitialCharge:
      allOf:
      - $ref: '#/components/schemas/GenericCharge'
      - $ref: '#/components/schemas/MitAdditionalProperties'
    BaseAmountBreakdown:
      type: object
      required:
      - baseAmount
      description: "A breakdown of the transaction `value`. \n\nAll provided amounts must exactly add up to `value`.\nProviding a breakdown is only required if any other amounts besides the `baseAmount` are included.\n"
      properties:
        baseAmount:
          allOf:
          - description: 'The base transaction value in minor units. For example `$12.34` should be encoded as `1234`.

              '
          - $ref: '#/components/schemas/posAmountValue'
    components-schemas-amountValue:
      type: integer
      format: int64
      minimum: 0
      maximum: 999999999999
      description: 'The amount in minor units. For example `$12.34` should be encoded as `1234`. Note that not all

        currencies have 2 minor units. Some have three or zero.

        '
      example: 2599
    MitFundingThreeDsAuthenticationResultResponse:
      type: object
      readOnly: true
      description: Object containing the information of a 3DS transaction.
      properties:
        directoryServerTransId:
          type: string
          description: Transaction ID retrieved from the Directory Server
          example: 5340af8a-5505-4bf6-abcd-123412341234
    Charge:
      oneOf:
      - $ref: '#/components/schemas/GenericCharge'
      - $ref: '#/components/schemas/AtmCharge'
      - $ref: '#/components/schemas/BepCharge'
      - $ref: '#/components/schemas/FundingCharge'
      - $ref: '#/components/schemas/PayoutCharge'
      - $ref: '#/components/schemas/PosCharge'
      - $ref: '#/components/schemas/MitChargeFromInitialCharge'
      - $ref: '#/components/schemas/MitCharge'
      - $ref: '#/components/schemas/MitFundingCharge'
    ScaMit:
      type: object
      required:
      - compliance
      - complianceReason
      - method
      properties:
        method:
          type: string
          enum:
          - none
        compliance:
          type: string
          enum:
          - mit
        complianceReason:
          type: string
          enum:
          - installment
          - ucof
    isoFieldRetrievalReferenceNumber:
      type: string
      description: Contents of field 37
      example: '131608123456'
    

# --- truncated at 32 KB (123 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/openapi/silverflow-retrieve-charges-api-openapi.yml