Stablecoins API

OpenAPI schemas for the Stablecoins API, used to hold and move stablecoin and fiat balances.

Beta

The Stablecoins API is currently in beta. Request/response shapes might be subject to change. Please, reach out to your Volt contact before integrating.

Supporting documentation

Implementation guide

In progress

Wallets

Get list of wallets GET

Get list of wallets. Wallets are returned oldest first, without deposit details.

Create wallet POST

Create new wallet for the given currency. Whether the wallet is FIAT or CRYPTO is derived from the currency automatically. The first wallet a...

Get wallet details GET

Fetch particular wallet details, including status, balance and deposit details.

Update wallet PATCH

Update wallet: change its label and/or make it the target wallet.

Channels

Get list of channels GET

Get list of channels. Channels are returned oldest first, without QR images.

Create channel POST

Create new reusable deposit channel for one of your end users in one crypto currency. The channel's addresses are permanently bound to that end...

Get channel details GET

Fetch particular channel details, including status and per-network deposit addresses with rendered QR images.

Get list of channel payments GET

Get list of deposits received on the channel, oldest first. Fetch a single payment with GET /channel-payments/{id}.

Get channel payment details GET

Fetch particular channel payment details, including its on-chain evidence and conversion outcome.

Get channel rate GET

Get the current indicative rate for the channel's conversion. It is an estimate for showing at payment initiation, not a locked quote: the live rate...

Payouts

Get list of payouts GET

Get list of payouts. Payouts are returned oldest first.

Create payout POST

Create new crypto payout from one of your wallets to an external address.

Get payout details GET

Fetch particular payout details, including its current status, settled amounts, rate and on-chain transaction (once known).

Wallet transfers

Get list of wallet transfers GET

Get list of wallet transfers. Transfers are returned oldest first.

Create wallet transfer POST

Create new wallet transfer, moving funds from one of your wallets to another. The same currency on both sides executes as an INTERNAL book move;...

Get wallet transfer details GET

Fetch particular wallet transfer details, including its current status and, once executed, the settled target amount and rate.

Webhooks

Channel payment status change notification Webhook

Sent to the notification URL when it was provided at related channel creation; otherwise to the webhook URL configured in Fuzebox. | Type |...

Payout status change notification Webhook

Sent to the notification URL when it was provided at payout creation; otherwise to the webhook URL configured in Fuzebox. | Type | Description...

How is this guide?

Last updated on

Create Refund report POST

This endpoint allows you to request a refund report for a specific period. Once requested, your report will be generated asynchronously and available at the `/reports/id/download endpoint` as a CSV file once it's been generated. Check on the availability status of your report using the `/reports/{id}` endpoint. The `startDate` and `endDate` may be a maximum of **92 days** apart, so you can generate reports containing 3 months data. If you supply a `customerId` for any merchant within your customer hierarchy, only that merchant's data will be returned. If a `customer ID` is **not** provided, the report will contain data for all merchants within your customer hierarchy. If you supply an `accountId` for Connect account, only data related to this account will be returned. If an `account ID` is **not** provided, the report will contain data related to all Connect accounts.

Get list of wallets GET

Get list of wallets. Wallets are returned oldest first, without deposit details.