Channel API
Create and manage payment channels for persistent payment endpoints.
Channel
List Merchant Channels
GET /api/v2/channel
Retrieve a list of merchant channels based on filters.
| Query | Type | Description |
|---|---|---|
merchantId | UUID | Filter by merchant |
status | string | Filter by status |
offset | number | Pagination offset |
limit | number | Page size |
Create Merchant Channel
POST /api/v2/channel
| Field | Type | Required | Description |
|---|---|---|---|
merchantId | UUID | Yes | Merchant identifier |
displayCurrency | string | Yes | Display currency (e.g., EUR) |
payCurrency | string | Yes | Accepted crypto currency |
reference | string | No | Your reference |
Response:
{
"uuid": "channel-uuid",
"merchantId": "merchant-uuid",
"displayCurrency": "EUR",
"payCurrency": "USDC",
"address": {
"address": "0xCHANNEL...ADDR",
"network": "ETHEREUM"
},
"reference": "user-topup-cust-123",
"status": "ACTIVE"
}
Get Merchant Channel by UUID
GET /api/v2/channel/{uuid}
Get Merchant Channel Spot Rates
GET /api/v2/channel/{uuid}/spot-rates
Get current exchange rates for a specific channel.
Channel Payment
List Merchant Channel Payments
GET /api/v1/channel-payment
List all payments received through channels.
| Query | Type | Description |
|---|---|---|
merchantId | UUID | Filter by merchant |
channelUuid | UUID | Filter by channel |
status | string | Payment status |
offset | number | Pagination offset |
limit | number | Page size |
Get Merchant Channel Payment by ID
GET /api/v1/channel-payment/{id}