BVbvnk
Crypto Channels

Create channel

Changed on

Creates a channel through which your customers can send crypto payments.

post/api/v2/channel

Request

Request body

walletIdstring required

Merchant ID is deprecated. Use walletId instead.

Unique identifier of the wallet used in the operation.

payCurrencystring required

The cryptocurrency code that the channel will operate on.

displayCurrencystring required

The currency which pricing will be displayed to the end user in, can be the same as payCurrency, or can be different.

referencestring required

An external reference for the channel that your customer will see. Also serves as the title of the channel.

customerIdstring required

Uniquely identifying the party requesting the payment. If multiple payments for same party are requested, the ID should remain consistent.

Example request

{
  "walletId": "a:24092328494070:G5i4XZ9:1",
  "payCurrency": "ETH",
  "displayCurrency": "EUR",
  "reference": "c1b933d5-3354-4f83-a05f-0b53f1be85f2",
  "customerId": "d063635e-0f83-4e47-a1f3-fc9484df1509",
  "complianceDetails": {
    "requesterIpAddress": "172.16.254.1",
    "partyDetails": [
      {
        "entityType": "INDIVIDUAL",
        "type": "BENEFICIARY",
        "firstName": "John",
        "lastName": "Doe",
        "dateOfBirth": "1984-06-30",
        "relationshipType": "THIRD_PARTY",
        "countryCode": "DE",
        "regionCode": "null"
      }
    ]
  }
}

Response

Created

idinteger

The UUID of the channel.

dateCreatedinteger

The date and time, encoded into UNIX epoch timestamps.

lastUpdatedinteger

The date and time, encoded into UNIX epoch timestamps.

merchantIdstring

The merchant ID linked to the channel.

walletCurrencystring

The wallet currency of the channel.

displayCurrencystring

The display currency of the channel.

payCurrencystring

The payed currency of the channel.

addressstring

The address of the channel

tagstring

The tag for payments

networkstring

The network of the channel.

We recommend using the network parameter instead of protocol.

protocolstring

The protocol of the channel. Deprecated. Use network instead.

referencestring

The custom reference for the channel payment.

status'OPEN'

The status of the channel.

uuidstring

The UUID of the channel.

redirectUrlstring

The redirect URL to the channel payment page.

uristring

The URI of the address for QR code

walletIdstring

Unique identifier of the wallet used in the operation.

walletDescriptionstring

Human-readable description of the wallet used for the channel.

peggedboolean

Indicates whether the pay currency is a pegged stablecoin (e.g., USDC, USDT) that maintains a fixed value relative to a fiat currency. Set to true for stablecoins, false for volatile cryptocurrencies like BTC or ETH.

accountReferencestring

Unique identifier linking the channel to a specific account or entity within your system. Enables tracking and reconciliation of transactions across multiple channels belonging to the same account or customer relationship.

Example response

{
  "id": 59157,
  "dateCreated": 1631619193321,
  "lastUpdated": 1631619193321,
  "merchantId": "0a12a214-1619-43fa-9be1-0029f6a440a0",
  "walletCurrency": "EUR",
  "displayCurrency": "EUR",
  "payCurrency": "USDC",
  "address": "0x225c8e46493f603e4577ab059c9fb38bb70475ba",
  "network": "ETHEREUM",
  "protocol": "ERC20",
  "reference": "c1b933d5-3354-4f83-a05f-0b53f1be85f2",
  "uuid": "9d1f67f2-a647-404b-9b02-247c77be81d0",
  "redirectUrl": "https://pay.sandbox.bvnk.com/channel?uuid=9d1f67f2-a647-404b-9b02-247c77be81d0",
  "uri": "ethereum:0xb4e8bb9918248007dc9d0dc12ae1142f0d62ef0e",
  "alternatives": [
    {
      "network": "SOLANA",
      "protocol": "SOL",
      "address": "Cg41CUBFVMGodMowefNQEmYLZyiJm5fh1QkGbV441c48",
      "tag": null,
      "uri": "solana:4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU/transfer?address=Cg41CUBFVMGodMowefNQEmYLZyiJm5fh1QkGbV441c48"
    },
    {
      "network": "ARBITRUM",
      "protocol": "ARBITRUM",
      "address": "0xdaf97c16cfb25430638346adcaeb9385b86ef8a8",
      "tag": null,
      "uri": "arbitrum:0x548e21c12e84d43ce8aca9990597e6a3bf61e114/transfer?address=0xdaf97c16cfb25430638346adcaeb9385b86ef8a8"
    }
  ],
  "walletId": "a:25080425672469:LoaFAwD:1",
  "walletDescription": "USDC Omni Wallet",
  "accountReference": "b0cb95a5-66a5-4d2d-9b12-f500daf1f1fd",
  "contact": {
    "id": "9b9dab06-31ea-4acb-897c-e50c0e2d785f",
    "name": "John Doe",
    "relationshipType": "THIRD_PARTY",
    "entity": {
      "externalId": "4a06d2bb-c321-4ee3-a9e6-d3598c021db1",
      "firstName": "John",
      "lastName": "Doe",
      "dateOfBirth": "30-06-1984",
      "address": {
        "country": "DE"
      },
      "category": "INTERNAL",
      "type": "INDIVIDUAL"
    },
    "updatedAt": "2026-02-23T10:26:34.979Z",
    "createdAt": "2026-02-23T10:26:34.979Z"
  }
}

Changes