List Funding Source 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.
Path Parameters
- fundingSourceId string required
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
- 200
- 403
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
items object[]
Array [id stringID of the Funding Source Interaction.
fundingSourceId stringThe ID of the Funding Source that this Interaction relates to.
accountId stringThe ID of the account that this Interaction relates to.
type stringPossible 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 stringThe current status of the interaction. It will vary depending on the interaction type.
amount numberThe minor units amount of the transaction.
token stringThe token used in the transaction.
createdAt stringDate time on which the interaction was created.
modifiedAt stringLast modified date of this interaction.
description stringA description of the interaction.
creditOrDebitIndicator stringThe credit or debit indicator of the interaction.
context object
ref stringA context reference based on the type of the interaction. It could be a
transactionId
in the case of a payment, or aneventId
in the case of an smart contract event.type stringPossible values: [
card-transaction
,smart-contract-event
]A context type for the context reference, which will depend on the interaction type.
blockNumber stringThe chain block number in which the transactions was mined, when applicable.
transactionHash stringThe blockchain transaction hash on which the interaction happened, when applicable.
channel object
id stringFunding Channel primary identifier.
type stringThe type of Funding Channel.
strategy stringThe funding type strategy.
]pageInfo object
Page info for paginated results, undefined if no page info
nextCursor stringCursor for next page, undefined if no more pages
{
"items": [
{
"id": "f0220f084a182e3f4b4d605cda1d3340",
"fundingSourceId": "2be03cd65da12fe29b8910af7b4b85e7",
"accountId": "979254377d0e05002242d038926a5691",
"type": "Payment",
"status": "processing-successful",
"amount": 20000,
"token": "USDC",
"createdAt": "2023-11-15T00:48:48.902Z",
"modifiedAt": "2023-11-15T00:49:59.261Z",
"description": "1 Queen Street Auckland NZ",
"creditOrDebitIndicator": "credit",
"context": {
"ref": "1000000488078",
"type": "smart-contract-event",
"blockNumber": "42409064",
"transactionHash": "0x3c561ba7fb04b8176f5478d26172d7cef02cf4ac6806e047ffaf5af70ccf1e69"
},
"channel": {
"id": "315bad4e81ce0f26966a41b9d451638b",
"type": "polygon-usdc-universal-evm-live",
"strategy": "universal-evm"
}
}
],
"pageInfo": {
"nextCursor": "dGhlIG5leHQgY3Vyc29yIGdvZXMgaGVyZQ=="
}
}
No Authorization to access resource
- application/json
- Schema
- Example (from schema)
Schema
- statusCode integer required
- statusName string required
- errorCode string required
- reason string
{
"statusCode": 403,
"statusName": "Forbidden",
"errorCode": "FORBIDDEN",
"reason": "Unauthorized"
}