Create a Channel

🚧
If you use walletID in the request that produces the webhook, note that you will also receive this field in the webhook response. In this case, you can ignore merchantID, since merchantId will be discontinued soon.

To create a channel, send the POST /api/v2/channel request with the body parameters:

{
  "payCurrency": "ETH",
  "displayCurrency": "EUR",
  "walletId": "a:25022613287255:zmHs0pg:1",
  "reference": "customer1topup",
  "customerId": "d063635e-0f83-4e47-a1f3-fc9484df1509",
  "complianceDetails": {
    "requesterIpAddress": "77.71.188.87",
    "partyDetails": [
      {
        "type": "ORIGINATOR",
        "entityType": "INDIVIDUAL",
        "firstName": "John",
        "lastName": "Doe",
        "dateOfBirth": "1984-06-30",
        "relationshipType": "THIRD_PARTY",
        "countryCode": "DE"
      }
    ]
  }
}

The details to be sent in this request are as follows:

Parameter	Description
`payCurrency`	Currency code that defines the cryptocurrency of the wallet.
`displayCurrency`	Currency code that specifies the currency in which prices are displayed.
`walletId`	Unique identifier of the wallet linked to the channel.
`reference`	Unique reference that will be displayed to the end user and serve as the title of the channel.

After successfully submitting the request, you receive the following response:

{
  "id": 65,
  "dateCreated": 1631619193321,
  "lastUpdated": 1631619193321,
  "walletId": "a:25022613287255:zmHs0pg:1",
  "walletCurrency": "EUR",
  "displayCurrency": "JPY",
  "payCurrency": "ETH",
  "address": "0xb4e8bb9918248007dc9d0dc12ae1142f0d62ef0e",
  "tag": null,
  "reference": "c1b933d5-3354-4f83-a05f-0b53f1be85f2",
  "status": "OPEN",
  "uuid": "9d1f67f2-a647-404b-9b02-247c77be81d0",
  "redirectUrl": "https://pay.sandbox.bvnk.com/channel?uuid=9d1f67f2-a647-404b-9b02-247c77be81d0",
  "uri": "ethereum:0xb4e8bb9918248007dc9d0dc12ae1142f0d62ef0e",
  "alternatives": null
}

Key takeaways include the following:

address is the created channel that you can share with the end-user.
redirectUrl is the URL to which you can redirect users each time they log in to your platform and initiate a top-up request.

👍
Tip
Instead of just showing users the destination address, redirect them to the redirectUrl whenever they want to top up. On that page, they will be able to scan a QR code from their wallet. This will eliminate the chance of mistyped addresses. Users will also be able to view the exact exchange rate for the transaction.

If you use walletID in the request that produces the webhook, note that you will also receive this field in the webhook response. In this case, you can ignore merchantID, since merchantId will be discontinued soon.

Tip

If you use `walletID` in the request that produces the webhook, note that you will also receive this field in the webhook response. In this case, you can ignore `merchantID`, since merchantId will be discontinued soon.