Creating channel
POST
/api/public/v1/channels
This endpoint creates channels.
Headers
Body
Response
Response Body
Last updated
POST
/api/public/v1/channels
This endpoint creates channels.
Headers
Body
Response
Response Body
Last updated
Name | Value |
---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Content-Type
application/vnd.api+json
Authorization
Bearer <api_key>
targetCurrency
string
Channel currency to display to end users. Determines the currency due after processing and conversion. Refer to supported currencies.
payNetwork
string
Payment network code. Refer to supported networks.
reference
string
The custom reference ID to tie the channel and its deposits to end-user who pays. This can be anything you choose. Must be a unique value for each channel you create.
status
string
Channel status. Can be either enabled
or disabled
. If enabled
, deposits get processed and credited to the merchant's account as normal. If disabled
, deposits do not get credited to the merchant's account.
data.id
string
Channel ID.
data.type
string
Always channels
.
data.attributes.targetCurrency
string
Channel currency to display to end users. Determines the currency due after processing and conversion. Refer to supported currencies.
data.attributes.payCurrency
string
Crypto currency that customer must pay in. Refer to supported currencies.
data.attributes.address
string
Channel address.
data.attributes.networkCode
string
Payment network code. Refer to supported networks.
data.attributes.networkName
string
Network name.
data.attributes.reference
string
The custom reference ID to tie the channel and its deposits to end-user who pays.
data.attributes.status
string
Channel status. Can be either enabled
or disabled
. If enabled
, deposits get processed and credited to the merchant's account as normal. If disabled
, deposits do not get credited to the merchant's account.
data.attributes.createdAt
string
Timestamp when a channel was created.
data.attributes.updatedAt
string
Timestamp when a channel was last updated.