Update a channel

patch
Update a channel

https://business-sandbox.cryptopay.me/api/channels/:id
This endpoint allows you to update a channel.
Request
Response
Request
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
Body Parameters
status
optional
string
Can be one of: enabled or disabled. If disabled, payments will be put on hold in case someone sends transactions to the channel address
name
optional
string
Channel name
description
optional
string
Channel description
Response
200: OK
Cake successfully retrieved.
{
"id": "50eb5775-f77e-4c64-870b-dc93624b5967",
"status": "enabled",
"name": "new channel name",
"description": "new channel description",
"receiver_currency": "EUR",
"pay_currency": "BTC",
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
"project_id": "25632c89-7f40-4693-8ed0-99bf5f79d3a6",
"custom_id": "631044494",
"uri": "bitcoin:2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
"hosted_page_url": "https://business-hosted.cryptopay.me/channels/50eb5775-f77e-4c64-870b-dc93624b5967"
}

API call example.

curl -X PATCH \
https://business-sandbox.cryptopay.me/api/channels/50eb5775-f77e-4c64-870b-dc93624b5967 \
-H 'Authorization: HMAC ***' \
-H 'Content-Type: application/json' \
-H 'Date: Tue, 19 Mar 2019 10:11:40 GMT' \
-d '{"name":"new channel name", "description":"new channel description"}'

Response schema.

Parameter

Type

Description

status

string

Can be one of: enabled or disabled. If disabled, payments will be put on hold in case someone sends transactions to the channel address

customer_id

string

The reference ID of your customer. See Customers section on the left for more information

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

hosted_page_url

string

Channel hosted page that renders channel details