Immersve Docs
GithubX

List Funding Source Interactions

get/api/funding-sources/{fundingSourceId}/interactions

Retrieves a list of Funding Source Interactions for a given Funding Source.

This API uses cursor-based pagination. Start by making a request without a cursor to get the first page. Use the nextCursor from the pageInfo in the response as the cursor for subsequent requests to retrieve further pages. Empty pages can be expected, subsequent requests may return more items. Continue until nextCursor is undefined, indicating no more data.

Request

Path Parameters

  • fundingSourceIdstringrequired

    ID for the Funding Source.

Query Parameters

  • limitnumber

    Amount of records to return (max 100)

  • cursorstring

    Cursor to retrieve the next page

  • typestring[]

    Filter for interaction types

  • createdFromstring

    Filter for interactions from this date (inclusive). Value should be a ISO 8601 string.

  • createdTostring

    Filter for interactions up to this date (inclusive). Value should be a ISO 8601 string.

Response

Successful operation.

Body application/json

  • itemsobject[]

    Items

    • idstring

      ID of the Funding Source Interaction.

    • fundingSourceIdstring

      The ID of the Funding Source that this Interaction relates to.

    • accountIdstring

      The ID of the account that this Interaction relates to.

    • typestring
      Allowed values:DepositWithdrawalRefundPayment

      The type of Funding Source Interaction:

      • Deposit – Funds credited in the context of a deposit transaction.
      • Withdrawal – Funds debited in the context of a withdrawal request.
      • Refund – Funds credited in the context of a card payment refund.
      • Payment – Funds debited in the context of a card payment purchase.
    • statusstring

      The current status of the interaction. Interaction lifecycle typically flows from Pending to either Confirmed or Discarded. Other intermediate statuses will vary depending on the interaction and funding types. Unknown statuses should be treated as "pending".

    • amountstring

      The minor units amount of the transaction.

    • tokenstring

      A user-friendly description of the underlying asset. More specific details about the asset can be discovered via the related Funding Channel (see the "channel" attribute).

    • createdAtstring

      Date time on which the interaction was created.

    • modifiedAtstring

      Last modified date of this interaction.

    • descriptionstring

      A user-friendly description of the interaction. For payments, this will include the merchant display name.

    • creditDebitIndicatorstring
      Allowed values:creditdebit

      The direction of the balance adjustment for the interaction:

      • credit – Balance increased.
      • debit – Balance decreased.
    • assetQuoteobject

      The currency conversion that was applied to this interaction.

      • baseAmountobject

        The amount that was converted from.

        • valuestring

          The amount in the smallest denomination of the currency.

        • currencystring

          The currency the amount is denominated in.

      • quoteAmountobject

        The amount that was converted to.

        • valuestring

          The amount in the smallest denomination of the currency.

        • currencystring

          The currency the amount is denominated in.

      • exchangeRateobject

        The exchange rate used to perform the conversion.

        • baseCurrencystring

          The currency the rate converts from.

        • quoteCurrencystring

          The currency the rate converts to.

        • ratestring

          The number of units of the quote currency that one unit of the base currency is worth.

      • createdAtstring

        Date time at which the rate was quoted.

    • channelobject

      Related Funding Channel identifying attributes.

      • idstring

        Funding Channel primary identifier.

      • typestring

        The type of Funding Channel.

      • strategystring

        The funding type strategy.

    • contextobject

      Surrounding context identifying attributes.

      One of

      • typestring
        Allowed values:card-transaction
      • refstring

        The card payment transaction identifier.

  • pageInfoobject

    Page info for paginated results, undefined if no page info

    • nextCursorstring

      Cursor for next page, undefined if no more pages