Create a channel

post
Create a channel

https://business-sandbox.cryptopay.me/api/channels
This endpoint allows you to create channels.
Request
Response
Headers
Authorization
required
string
HMAC using API key and signature
Content-Type
required
string
application/json
Date
required
string
Current date in HTTP-date format
Query Parameters
pay_currency
required
string
The cryptocurrency which you want to accept
receiver_currency
required
string
The currency which all incoming transactions will be converted to
custom_id
required
string
The channel reference ID in your system
name
optional
string
Channel name
description
optional
string
Channel description
201: Created
{
"id": "50eb5775-f77e-4c64-870b-dc93624b5967",
"name": "channel name",
"description": "channel description",
"receiver_currency": "EUR",
"pay_currency": "BTC",
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
"project_id": "25632c89-7f40-4693-8ed0-99bf5f79d3a6",
"custom_id": "631044494",
"uri": "bitcoin:2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4"
}

All channel payments inherit their parent channels' custom_id value

API call example.

curl -X POST \
https://business-sandbox.cryptopay.me/api/channels \
-H 'Authorization: HMAC ***' \
-H 'Content-Type: application/json' \
-H 'Date: Tue, 19 Mar 2019 10:11:40 GMT' \
-d '{"pay_currency":"BTC", "receiver_currency":"EUR", "name":"channel name", "description":"channel description", "custom_id":"631044494"}'

Response schema.

Parameter

Type

Description

id

string

Channel ID

name

string

Channel name

description

string

Channel description

receiver_currency

string

The currency which all incoming transactions will be converted to

pay_currency

string

The cryptocurrency which you want to accept

address

string

Channel cryptocurrency address

project_id

string

Project ID. Learn more about projects

custom_id

string

The channel reference ID in your system

uri

string

Channel URI. May be used for generating a QR code