Payment Channel
Accept recurring crypto payments on reusable addresses, without an order per payment.
A payment channel is a reusable way to accept crypto without creating an order for every payment. You create a channel, attach one or more addresses to it, and anything received on those addresses is credited to the receive currency you configured.
Endpoint overview
| HTTP Request | Description |
|---|---|
POST /public/payment-channels | Create a payment channel. |
GET /public/payment-channels | List your payment channels. |
GET /public/payment-channels/{id} | Retrieve a single channel. |
PUT /public/payment-channels/{id} | Update a channel. |
DELETE /public/payment-channels/{id} | Delete a channel. |
POST /public/payment-channels/addresses | Attach a new address to a channel. |
GET /public/payment-channels/addresses | List addresses across your channels. |
GET /public/payment-channels/addresses/{id} | Retrieve a single address. |
GET /public/payment-channels/currencies/pay | Currencies a payer can pay in. |
GET /public/payment-channels/currencies/receive | Currencies you can receive in. |
Typical flow
- Call
GET /public/payment-channels/currencies/receiveto see which currencies you can settle in, andGET /public/payment-channels/currencies/payfor what payers can send. - Create the channel with
POST /public/payment-channels. - Attach an address with
POST /public/payment-channels/addresses. Give each payer their own address if you need to attribute incoming funds. - Funds received on those addresses are credited to the channel's receive currency.
Scopes
| Scope | Grants |
|---|---|
payment-channel:read | List and retrieve channels. |
payment-channel:write | Create, update and delete channels, and read receivable currencies. |
payment-channel-address:read | List and retrieve channel addresses. |
payment-channel-address:create | Attach new addresses, and read payable currencies. |
See Scopes for the full list, and Generating API keys to grant them.
Updated 39 minutes ago
Did this page help you?