Skip to main content

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. Continue until nextCursor is undefined, indicating no more data.

Request​

Path Parameters

    fundingSourceId stringrequired

    ID for the Funding Source.

    Example: 2be03cd65da12fe29b8910af7b4b85e7

Query Parameters

    limit number

    amount of records to return (max 100)

    cursor string

    cursor to retrieve the next page

Responses​

Successful operation

Schema

    items

    object[]

  • Array [

    • id string

    ID of the Funding Source Interaction.

    fundingSourceId string

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

    accountId string

    The ID of the account that this Interaction relates to.

    type string

    Possible values: [Deposit, Withdrawal, Refund, Payment]

    The type of Funding Source Interaction:

    • Deposit - Funds added to the Funding Source.
    • Withdrawal - Funds removed from the Funding Source.
    • Refund - Return of paid funds to the Funding Source.
    • Payment - Transfer of funds from the Funding Source.
    status string

    The current status of the interaction. It will vary depending on the interaction type.

    amount number

    The minor units amount of the transaction.

    token string

    The token used in the transaction.

    createdAt string

    Date time on which the interaction was created.

    modifiedAt string

    Last modified date of this interaction.

    description string

    A description of the interaction.

    creditOrDebitIndicator string

    The credit or debit indicator of the interaction.

    context

    object

    ref string

    A context reference based on the type of the interaction. It could be a transactionId in the case of a payment, or an eventId in the case of an smart contract event.

    type string

    Possible values: [card-transaction, smart-contract-event]

    A context type for the context reference, which will depend on the interaction type.

    blockNumber string

    The chain block number in which the transactions was mined, when applicable.

    transactionHash string

    The blockchain transaction hash on which the interaction happened, when applicable.

    channel

    object

    id string

    Funding Channel primary identifier.

    type string

    The type of Funding Channel.

    strategy string

    The funding type strategy.

  • ]

    • pageInfo

    object

    Page info for paginated results, undefined if no page info

    nextCursor string

    Cursor for next page, undefined if no more pages

Loading...