Silverflow Retrieve Charges API

openapi: 3.2.0
info:
  description: '**This OpenAPI specification cannot be used for code generation.** Please reach out to your TAM regarding code generation using the API Spec.'
  version: 1.417.0
  title: Silverflow Retrieve Charges API
  contact:
    name: API Support
    email: support@silverflow.com
  license:
    name: Commercial
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'
  /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'
components:
  schemas:
    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.

        '
    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
    MitFundingChargeAuthentication:
      type: object
      required:
      - sca
      - cvc
      - avs
      description: 'Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used.

        '
      properties:
        sca:
          $ref: '#/components/schemas/mitFundingSca'
        cvc:
          $ref: '#/components/schemas/cvcResult'
        avs:
          $ref: '#/components/schemas/avsResult'
    MitFundingThreeDsAuthentication:
      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/MitFundingThreeDsAuthenticationResultResponse'
    FundingCharge:
      type: object
      required:
      - merchantAcceptorRef
      - card
      - key
      - amount
      - localTransactionDateTime
      - type
      - sender
      - receiver
      - status
      - fraudLiability
      - created
      - version
      - authentication
      - authorizationIsoFields
      additionalProperties: false
      description: 'A funding charge

        '
      properties:
        key:
          $ref: '#/components/schemas/chargeKey'
        merchantAcceptorRef:
          $ref: '#/components/schemas/components-schemas-AcceptorRef'
        card:
          $ref: '#/components/schemas/OutputCard'
        tokenDetails:
          $ref: '#/components/schemas/StoredTokenDetails'
        amount:
          $ref: '#/components/schemas/components-schemas-Amount'
        type:
          $ref: '#/components/schemas/FundingChargeType'
        localTransactionDateTime:
          $ref: '#/components/schemas/localTransactionDateTime'
        transactionReference:
          $ref: '#/components/schemas/transactionReference'
        receiver:
          $ref: '#/components/schemas/FundingReceiver'
        sender:
          $ref: '#/components/schemas/FundingSender'
        riskCheckResult:
          $ref: '#/components/schemas/RiskCheckResult'
        fraudLiability:
          $ref: '#/components/schemas/fraudLiability'
        status:
          $ref: '#/components/schemas/Status'
        authentication:
          $ref: '#/components/schemas/FundingPayoutChargeAuthentication'
        clearingMode:
          type: string
          enum:
          - none
          description: The clearing mode of the charge. For funding charges it is always `none`.
        authorizationIsoFields:
          $ref: '#/components/schemas/authorizationIsoFields'
        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'
    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
    openapi_components-schemas-InvalidInputErrorDetails:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - instance
      - validationErrors
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/errorType'
          - enum:
            - /silverflow/problems/invalid-input
        title:
          allOf:
          - $ref: '#/components/schemas/errorTitle'
          - enum:
            - Invalid Input
        status:
          allOf:
          - $ref: '#/components/schemas/errorStatus'
          - enum:
            - 400
        detail:
          $ref: '#/components/schemas/errorDetail'
        instance:
          $ref: '#/components/schemas/errorInstance'
        validationErrors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
          description: A list of validation errors.
    amexSpecificFields:
      type: object
      required:
      - acquirerReferenceData
      description: American Express-specific ISO8583 raw values
      properties:
        acquirerReferenceData:
          type: string
          description: Contents of field 31.
        cvcResult:
          type: string
          description: Contents of field 44, first byte.
          example: Y
        avsResult:
          type: string
          description: Contents of field 44, second byte.
          example: Y
    RiskCheckResult:
      type: object
      required:
      - provider
      - result
      - actionTaken
      description: 'Result of the risk check. The field is always present on a charge if a risk check was requested.

        '
      properties:
        provider:
          $ref: '#/components/schemas/riskProvider'
        fraudioResult:
          $ref: '#/components/schemas/FraudioResult'
        actionTaken:
          type: string
          description: 'The action taken on the charge after risk assessment.

            '
          enum:
          - proceeded
          - aborted
        result:
          type: string
          description: 'The result of the risk check.

            '
          enum:
          - success
          - error
    sequence:
      type: string
      title: Sequence
      description: 'Setting this to `initial` flags the charge as the initial charge in a sequence of payments.

        '
      enum:
      - initial
    isoFieldEciDiscover:
      type: string
      description: E-commerce Indicator
    ChargeAuthenticationBEP:
      type: object
      required:
      - sca
      - cvc
      - avs
      description: 'Object container for authentication. If present, contains Strong Customer Authentication (SCA) information, but also indicates whether CVC and AVS was used.

        '
      properties:
        sca:
          $ref: '#/components/schemas/ScaBEP'
        cvc:
          $ref: '#/components/schemas/cvcResultBEP'
        avs:
          $ref: '#/components/schemas/avsResultBEP'
    isoFieldRetrievalReferenceNumber:
      type: string
      description: Contents of field 37
      example: '131608123456'
    AtmTerminalCapability:
      type: string
      description: ATM terminal capabilities subset
      enum:
      - contactChip
      - contactlessChip
      - contactMagStripe
      - contactlessMagStripe
    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'
    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'
    openapi_components-schemas-currencyCode:
      type: string
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BRL
      - BSD
      - BTN
      - BWP
      - BYN
      - BZD
      - CAD
      - CDF
      - CHF
      - CLP
      - CNY
      - COP
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRU
      - MUR
      - MVR
      - MWK
      - MXN
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLL
      - SOS
      - SRD
      - SSP
      - STN
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - UYU
      - UZS
      - VES
      - VND
      - VUV
      - WST
      - XAF
      - XCD
      - XCG
      - XOF
      - XPF
      - YER
      - ZAR
      - ZMW
      - ZWL
      description: An alphabetic ISO-4217 currency code.
      externalDocs:
        description: Find more info here.
        url: https://www.iso.org/iso-4217-currency-codes.html
      example: EUR
    authorizationIsoFieldsBancontact:
      type: object
      required:
      - responseCode
      - responseCodeDescription
      - networkCode
      - systemTraceAuditNumber
      - retrievalReferenceNumber
      - eci
      - networkSpecificFields
      description: Object containing the raw values from the ISO8583 response message received from the network.
      properties:
        responseCode:
          $ref: '#/components/schemas/isoFieldResponseCode'
        responseCodeDescription:
          $ref: '#/components/schemas/isoFieldResponseCodeDescription'
        authorizationCode:
          $ref: '#/components/schemas/isoFieldAuthorizationCode'
        networkCode:
          type: string
          enum:
          - none
        systemTraceAuditNumber:
          $ref: '#/components/schemas/isoFieldSystemTraceAuditNumber'
        retrievalReferenceNumber:
          $ref: '#/components/schemas/isoFieldRetrievalReferenceNumber'
        eci:
          type: string
          enum:
          - none
        networkSpecificFields:
          $ref: '#/components/schemas/bancontactSpecificFields'
    isoFieldEciAmex:
      type: string
      description: E-commerce Indicator
    ThreeDsAuthentication:
      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/ThreeDsAuthenticationResultResponse'
    errorStatus:
      type: integer
      format: int32
      description: 'The HTTP status code generated by the origin server for this occurrence

        of the problem.

        '
    isoFieldNetworkCode:
      type: string
      description: Contents of field 63, subfield 1
      example: '0000'
    PayoutReceiver:
      type: object
      description: Details of the recipient of the payout.
      properties:
        firstName:
          allOf:
          - description: Recipient's first name.
          - $ref: '#/components/schemas/schemas-NameOfPeopleAndPlaces'
        middleName:
          allOf:
          - description: Recipient's middle name.
          - $ref: '#/components/schemas/schemas-NameOfPeopleAndPlaces'
        lastName:
          allOf:
          - description: Recipient's last name.
          - $ref: '#/components/schemas/schemas-NameOfPeopleAndPlaces'
        accountNumber:
          allOf:
          - description: The masked account number of the recipient.
          - $ref: '#/components/schemas/MaskedAccountNumber'
        accountNumberType:
          $ref: '#/components/schemas/payout-charge_AccountNumberType'
        address:
          allOf:
          - description: The address of the recipient.
          - $ref: '#/components/schemas/schemas-AddressInput'
        identification:
          allOf:
          - description: Identification used to verify the receiver.
          - $ref: '#/components/schemas/Identification'
    schemas-EntityNotFoundErrorDetails:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - instance
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/errorType'
          - enum:
            - /silverflow/problems/entity-not-found
        title:
          allOf:
          - $ref: '#/components/schemas/errorTitle'
          - enum:
            - Not Found
        status:
          allOf:
          - $ref: '#/components/schemas/errorStatus'
          - enum:
            - 404
        detail:
          $ref: '#/components/schemas/errorDetail'
        instance:
          $ref: '#/components/schemas/errorInstance'
    BillingAddress:
      type: object
      required:
      - postalCode
      additionalProperties: false
      description: 'The billing address of the cardholder

        '
      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'
    errorInstance:
      type: string
      description: 'A reference that identifies the specific occurrence of the error. The instance is unique for every error.

        '
    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
    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-created:
      type: string
      description: The date and time this object was created
      format: iso-8601-date-time
      readOnly: true
    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'
    orderPos:
      description: 'The method used to place the order.

        '
      type: string
      enum:
      - counter
    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'
    ChargesPage:
      allOf:
      - $ref: '#/components/schemas/PageWithMoreItems'
      - type: object
        required:
        - charges
        properties:
          charges:
            type: array
            items:
              $ref: '#/components/schemas/Charge'
    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'
    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'
    errorType:
      type: string
      description: 'A relative URI reference, this property can be used to perform automated error handling.

        '
    PayoutChargeType:
      type: object
      description: 'Describes the kind of charge the merchant wants to submit.

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

            '
          type: string
          enum:
          - payout
        cardEntry:
          $ref: '#/components/schemas/PayoutCardEntry'
        order:
          $ref: '#/components/schemas/PayoutOrder'
        payoutType:
          description: '- `account-to-account`: Payout transaction for moving money from one account to another account, both of which are owned by the sender. Currently only supported for **Visa** <a class="experimental-tag-link" href="https://docs.silverflow.com/guides/api-lifecycle#tag/EXPERIMENTAL-Tag"><span class="tag experimental-tag">EXPERIMENTAL</span></a> and **Mastercard**.

            - `fast-refund`: Transaction that returns funds to the same card used in the original purchase. <span class="tag network-tag mastercard-tag">MASTERCARD</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>

            - `general-funds-disbursement`: Generic funds disbursement transaction used to push funds from a business to an individual cardholder for various purposes. Currently only supported for **Visa** and **Mastercard**.

            - `liquid-assets`: Payout of liquid or cryptocurrency asset proceeds to a card account, e.g., from a sale or cash out. Currently only supported for **Visa**.

            - `merchant-disbursement`: Merchant payments for purchase transaction processing where the settlement payment is sent directly to a card account. Currently only supported for **Visa** and **Mastercard**.

            - `online-gambling`: Payouts of online casino winnings. Currently only supported for **Visa** and **Mastercard**.

            - `person-to-person`: Payout transaction moving funds from the sender''s account to the receiver''s account. Currently only supported for **Mastercard**.

            - `wallet-transfer`: Payout transaction for adding funds to a digital wallet, the direct acquisition of cryptocurrency, or the acquisition of liquid assets (for example, stocks, shares, foreign currency). Currently only supported for **Visa**.

            '
          type: string
          enum:
          - account-to-account
          - fast-refund
          - general-funds-disbursement
          - liquid-assets
          - merchant-disbursement
          - online-gambling
          - person-to-person
          - wallet-transfer
    FundingIntent:
      description: 'The intention of the cardholder

        '
      type: string
      enum:
      - funding
    responseCardEntry:
      description: 'The method used to capture the card details.

        '
      type: string
      enum:
      - e-commerce
      - manual
      - card-on-file
      - terminal
      - token
      - token-on-file
      example: e-commerce
    errorDetail:
      type: string
      description: 'A human readable explanation specific to this occurrence of the problem.

        '
    ClearingStatus:
      type: string
      description: Clearing status of the charge
      enum:
      - none
      - manual
      - pending
      - completed
      - cancelled
      - abandoned
      example: pending
    riskProvider:
      type: string
      description: 'Provider for the risk check.

        '
      enum:
      - fraudio
    PageWithMoreItems:
      type: object
      properties:
        moreItems:
          type: boolean
        offsetToken:
          $ref: '#/components/schemas/components-schemas-offsetToken'
    InternalServerErrorDetails:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - instance
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/errorType'
          - enum:
            - /silverflow/problems/internal-server-error
        title:
          allOf:
          - $ref: '#/components/schemas/errorTitle'
          - enum:
            - Internal Server Error
        status:
          allOf:
          - $ref: '#/components/schemas/errorStatus'
          - enum:
            - 500
        detail:
          $ref: '#/components/schemas/errorDetail'
        instance:
          $ref: '#/components/schemas/errorInstance'
    isoFieldAuthorizationCode:
      type: string
      description: Contents of field 38
      example: 4A4316
    clearAfter:
      type: string
      description: 'If provided, clearing will not occur before this point in time.

        If no timezone is included, it is assumed to be UTC.

        The value may be at most 6 months in the future from when the charge was created.

        '
      format: iso-8601-date-time
    methodBEP:
      description: 'Indicates the method that was used to comply to SCA.

        '
      type: string
      enum:
      - bep
    isoFieldResponseCodeDescription:
      type: string
      description: The description of the `responseCode`
      example: Approved
    BepChargeType:
      description: 'Describes the kind of charge the merchant wants to submit.

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

            '
          enum:
          - purchase
        cardEntry:
          type: string
          description: 'The method used to capture the card details.

            '
          enum:
          - e-commerce
        order:
          type: string
          description: 'The method used to place the order.

            '
          enum:
          - checkout
        sequence:
          type: string
          description: 'Setting this to `initial` flags the charge as the initial charge in a sequence of payments.


            **From November 22, 2026 this field will be removed since it currently does not have any effect on the charge creation.**

            '
          enum:
          - initial
          deprecated: true
    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
    MitFromInitialChargeSequence:
      type: string
      description: 'This endpoint only allows subsequent transaction of an initial charge which can be created through the `/charges` endpoint.

        '
      enum:
      - subsequent
    refundedChargeKey:
      description: 'The charge key of the refunded charge.


        **This field is only available for charges created on the [Refund endpoint](#operation/refund) with `createRefundCharge` set to `true`.**

        '
      type: string
      pattern: ^chg-[a-zA-Z0-9]+$
      minLength: 5
      maxLength: 120
      example: chg-1e1dAHhgstYTUhlphPzZ
    MitChargeTypeFunding:
      type: object
      description: Describes the kind of charge the merchant wants to submit.
      required:
      - intent
      - cardEntry
      - order
      - sequence
      - fundingType
      properties:
        intent:
          description: 'The intention of the cardholder

            '
          type: string
          enum:
          - funding
        cardEntry:
          type: string
          enum:
          - card-on-file
          - token-on-file
        order:
          type: string
          enum:
          - recurring
          - ucof
          - standing-order
        sequence:
      

# --- 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