Create Funding Channel

post/api/funding-channels

Create a Funding Channel to let your Cardholders create Funding Sources for a Funding Type's network and token. See Creating a Funding Channel for the parameters each Funding Type requires.

Request

Body application/json

accountIdstringrequired
The id of the partner account to add this Funding Channel to.
fundingTypeNamestringrequired
Name of the Funding Type to configure. See Funding Types for the available names.
purposestring
Allowed values:card-fundingbilling
The purpose of the Funding Channel. Defaults to "card-funding".
paramsobjectrequired
Parameters for the Funding Channel. The valid parameters depend on the Funding Type.
One of
storageAddressstringrequired
The address of the storage contract.

Response

Successful operation.

Body application/json

idstringrequired
Funding Channel primary identifier.
accountIdstringrequired
Partner Account ID.
createdAtstringrequired
Timestamp of Funding Channel creation.
fundingTypeNamestringrequired
Name of the Funding Type the Funding Channel configures. See Funding Types.
namestringrequired
Name of the Funding Channel.
purposestringrequired
Purpose of the Funding Channel.
modestringrequired
Funding Mode of the Funding Channel.
paramsobjectrequired
Parameters for the Funding Channel.
One of
storageAddressstringrequired
The address of the storage contract.
storageAddressstringdeprecated
Deprecated. See params for storage address.

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

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "storageAddress": "0x1234567890123456789012345678901234567890"
  }
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "partnerChannelAddress": "HGXCLM6NLGQ3SSSESMQNLC53ADPHHPDVHIEMYV7F4MHQFPKZEZI5PAZUPE"
  }
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "billingFundingSourceId": "dbc410b86ba0c6000662c7qff7d8fc75",
    "webhookBaseUrl": "https://example.com"
  }
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {}
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "storageAddress": "0x1234567890123456789012345678901234567890"
  }
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "partnerChannelAddress": "HGXCLM6NLGQ3SSSESMQNLC53ADPHHPDVHIEMYV7F4MHQFPKZEZI5PAZUPE"
  }
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "billingFundingSourceId": "dbc410b86ba0c6000662c7qff7d8fc75",
    "webhookBaseUrl": "https://example.com"
  }
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {}
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "storageAddress": "0x1234567890123456789012345678901234567890"
  }
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "partnerChannelAddress": "HGXCLM6NLGQ3SSSESMQNLC53ADPHHPDVHIEMYV7F4MHQFPKZEZI5PAZUPE"
  }
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "billingFundingSourceId": "dbc410b86ba0c6000662c7qff7d8fc75",
    "webhookBaseUrl": "https://example.com"
  }
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {}
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "storageAddress": "0x1234567890123456789012345678901234567890"
  }
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "partnerChannelAddress": "HGXCLM6NLGQ3SSSESMQNLC53ADPHHPDVHIEMYV7F4MHQFPKZEZI5PAZUPE"
  }
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "billingFundingSourceId": "dbc410b86ba0c6000662c7qff7d8fc75",
    "webhookBaseUrl": "https://example.com"
  }
}'

curl https://api.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {}
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "storageAddress": "0x1234567890123456789012345678901234567890"
  }
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "partnerChannelAddress": "HGXCLM6NLGQ3SSSESMQNLC53ADPHHPDVHIEMYV7F4MHQFPKZEZI5PAZUPE"
  }
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "billingFundingSourceId": "dbc410b86ba0c6000662c7qff7d8fc75",
    "webhookBaseUrl": "https://example.com"
  }
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {}
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "storageAddress": "0x1234567890123456789012345678901234567890"
  }
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "partnerChannelAddress": "HGXCLM6NLGQ3SSSESMQNLC53ADPHHPDVHIEMYV7F4MHQFPKZEZI5PAZUPE"
  }
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "billingFundingSourceId": "dbc410b86ba0c6000662c7qff7d8fc75",
    "webhookBaseUrl": "https://example.com"
  }
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {}
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "storageAddress": "0x1234567890123456789012345678901234567890"
  }
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "partnerChannelAddress": "HGXCLM6NLGQ3SSSESMQNLC53ADPHHPDVHIEMYV7F4MHQFPKZEZI5PAZUPE"
  }
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "billingFundingSourceId": "dbc410b86ba0c6000662c7qff7d8fc75",
    "webhookBaseUrl": "https://example.com"
  }
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {}
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "storageAddress": "0x1234567890123456789012345678901234567890"
  }
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "partnerChannelAddress": "HGXCLM6NLGQ3SSSESMQNLC53ADPHHPDVHIEMYV7F4MHQFPKZEZI5PAZUPE"
  }
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {
    "billingFundingSourceId": "dbc410b86ba0c6000662c7qff7d8fc75",
    "webhookBaseUrl": "https://example.com"
  }
}'

curl https://test.immersve.com/api/funding-channels \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "purpose": "card-funding",
  "params": {}
}'

Example Response

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

{
  "id": "315bad4e81ce0f26966a41b9d451638b",
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "createdAt": "2023-08-14T12:32:54",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "name": "immersve-polygon-usdc",
  "purpose": "card-funding",
  "mode": "deposit",
  "params": {
    "partnerChannelAddress": "HGXCLM6NLGQ3SSSESMQNLC53ADPHHPDVHIEMYV7F4MHQFPKZEZI5PAZUPE"
  },
  "storageAddress": "0x2e429C4324227F70f0101a17214d249cb04035Ec0"
}

{
  "id": "315bad4e81ce0f26966a41b9d451638b",
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "createdAt": "2023-08-14T12:32:54",
  "fundingTypeName": "polygon-amoy-usdc-universal-evm-test",
  "name": "immersve-polygon-usdc",
  "purpose": "card-funding",
  "mode": "deposit",
  "params": {
    "billingFundingSourceId": "dbc410b86ba0c6000662c7qff7d8fc75",
    "webhookBaseUrl": "https://example.com"
  },
  "storageAddress": "0x2e429C4324227F70f0101a17214d249cb04035Ec0"
}

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

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