Create Funding Channel

POST 
/api/funding-channels

This endpoint can be used to create a Funding Channel. See Funding Protocols for available funding types.

Request

application/json

Body

required

accountId stringrequired

The id of the partner account to add this Funding Channel to.

fundingTypeName stringrequired

Possible values: [polygon-amoy-usdc-universal-evm-test, polygon-usdc-universal-evm-live, arbitrum-mainnet-usdc-universal-evm, arbitrum-sepolia-usdc-universal-evm, algorand-usdc, algorand-testnet-usdc, simulator-usdc, custodial-usdc-live, custodial-usdc-test]

The name of the Funding Type.

purpose string

Possible values: [card-funding, billing]

The purpose of the Funding Channel. Defaults to "card-funding".

params

object

required

Parameters for the Funding Channel. The valid parameters depend on the Funding Type.

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

Responses

200

Successful operation

application/json

Schema

Schema

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.

Example (from schema)

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

403

User is not allowed to perform the action with the reason stated in the errorCode

FORBIDDEN Insufficient permissions to perform the action.

ACCOUNT_TYPE_INVALID accountType of the accountId is not of type PARTNER.

FUNDING_CHANNEL_EXISTS Instance of this FundingChannel has already been claimed

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

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

Loading...