List Funding Channels

GET 
/api/accounts/:accountId/funding-channels

Retrieves a list of Funding Channels for the given account

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

accountId stringrequired

Partner account id to retrieve Funding Channels for.

Query Parameters

limit number

amount of records to return (max 100)

cursor string

cursor to retrieve the next page

Responses

200

Successful operation

application/json

Schema

Schema

items

object[]

Array [

id stringrequired

Funding Channel primary identifier.

accountId stringrequired

Partner Account ID.

createdAt stringrequired

Timestamp of Funding Channel creation.

fundingTypeName stringrequired

The type of Funding Channel registered.

name stringrequired

Name of the Funding Channel.

purpose stringrequired

Purpose of the Funding Channel.

params

object

required

Parameters for the Funding Channel.

oneOf

universal-evm

storageAddress string

The address of the storage contract.

algorand

partnerChannelAddress string

The address of the partner channel.

custodial

billingFundingSourceId string

The ID of the billing funding source.

webhookBaseUrl string

The base URL for the webhook.

simulator

object

storageAddress stringdeprecated

Deprecated. See params for storage address.

]

pageInfo

object

Page info for paginated results, undefined if no page info

nextCursor string

Cursor for next page, undefined if no more pages

Example (from schema)

{
  "items": [
    {
      "id": "315bad4e81ce0f26966a41b9d451638b",
      "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
      "createdAt": "2023-08-14T12:32:54",
      "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
      "name": "immersve-polygon-usdc",
      "purpose": "card-funding"
    }
  ],
  "pageInfo": {
    "nextCursor": "dGhlIG5leHQgY3Vyc29yIGdvZXMgaGVyZQ=="
  }
}

403

No Authorization to access resource

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...