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 RequestDescription
POST /public/payment-channelsCreate a payment channel.
GET /public/payment-channelsList 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/addressesAttach a new address to a channel.
GET /public/payment-channels/addressesList addresses across your channels.
GET /public/payment-channels/addresses/{id}Retrieve a single address.
GET /public/payment-channels/currencies/payCurrencies a payer can pay in.
GET /public/payment-channels/currencies/receiveCurrencies you can receive in.

Typical flow

  1. Call GET /public/payment-channels/currencies/receive to see which currencies you can settle in, and GET /public/payment-channels/currencies/pay for what payers can send.
  2. Create the channel with POST /public/payment-channels.
  3. Attach an address with POST /public/payment-channels/addresses. Give each payer their own address if you need to attribute incoming funds.
  4. Funds received on those addresses are credited to the channel's receive currency.

Scopes

ScopeGrants
payment-channel:readList and retrieve channels.
payment-channel:writeCreate, update and delete channels, and read receivable currencies.
payment-channel-address:readList and retrieve channel addresses.
payment-channel-address:createAttach new addresses, and read payable currencies.

See Scopes for the full list, and Generating API keys to grant them.


Did this page help you?