Create a Funding Channel

POST 
/api/funding-channels

This endpoint can be used to create a Funding Channel.

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]

The name of the Funding Type.

params

object

required

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

storageAddress string

The address of the storage contract. Required for universal evm Funding Types.

Responses

200

Successful operation

application/json

Schema

Schema

id string

Funding Channel primary identifier.

createdAt string

Timestamp of Funding Channel creation.

storageAddress string

Fund storage smart contract address.

fundingTypeName string

The type of Funding Channel registered.

name string

Name of the Funding Channel.

Example (from schema)

{
  "id": "315bad4e81ce0f26966a41b9d451638b",
  "createdAt": "2023-08-14T12:32:54",
  "storageAddress": "0x2e429C4324227F70f0101a17214d249cb04035Ec0",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "name": "immersve-polygon-usdc"
}

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.

STORAGE_ADDRESS_INVALID storageAddress provided is invalid.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

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

Loading...