Skip to main content

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.

QueryTypeDescription
merchantIdUUIDFilter by merchant
statusstringFilter by status
offsetnumberPagination offset
limitnumberPage size

Create Merchant Channel

POST /api/v2/channel

FieldTypeRequiredDescription
merchantIdUUIDYesMerchant identifier
displayCurrencystringYesDisplay currency (e.g., EUR)
payCurrencystringYesAccepted crypto currency
referencestringNoYour 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.

QueryTypeDescription
merchantIdUUIDFilter by merchant
channelUuidUUIDFilter by channel
statusstringPayment status
offsetnumberPagination offset
limitnumberPage size

Get Merchant Channel Payment by ID

GET /api/v1/channel-payment/{id}