Voltage Payments API

api specification the full voltage pay openapi spec can be found at the link below core resource categories 1\ wallets wallets are where your funds and credit balances are managed the api allows you to list wallets view all wallets in an organization get /organizations/{organization id}/wallets create wallets set up new wallets in development or production environments post /organizations/{organization id}/wallets retrieve wallet details get balance information and status for a specific wallet get /organizations/{organization id}/wallets/{wallet id} delete wallets remove wallets when no longer needed delete /organizations/{organization id}/wallets/{wallet id} view transaction history access the ledger of all transactions for a wallet get /organizations/{organization id}/wallets/{wallet id}/ledger 2\ payments the payments api enables sending and receiving bitcoin payments via lightning network key operations include list payments view payment history with filtering options get /organizations/{organization id}/environments/{environment id}/payments create payments initiate new send or receive payments post /organizations/{organization id}/environments/{environment id}/payments get payment details retrieve information about a specific payment get /organizations/{organization id}/environments/{environment id}/payments/{payment id} track payment history view the full lifecycle of a payment get /organizations/{organization id}/environments/{environment id}/payments/{payment id}/history detailed guides | | | | 3\ quotes the quotes api is used to lock in exchange rates for usd wallet conversions key operations include create a quote lock in a btc↔usd conversion rate post /organizations/{organization id}/environments/{environment id}/quotes get quote details retrieve information about a specific quote get /organizations/{organization id}/environments/{environment id}/quotes/{quote id} when to use quotes quotes are required for usd wallet payments (both sending and receiving) btc wallets do not require quotes 4\ lines of credit the credit system is central to voltage payments lines of credit can be denominated in either btc or usd btc line of credit wallets operate directly in btc no quotes required for payments usd line of credit wallets operate in usd with automatic btc conversion quotes required for payments the api allows you to view credit summary get details about your available credit line get /organizations/{organization id}/lines of credit/{line id}/summary view all credit lines list all lines of credit across your organization get /organizations/{organization id}/lines of credit/summaries note for staging, lines of credit are automatically created after you create your first wallet, read about it https //app archbee com/docs/czy bvrox mx3r m6yzp1/l4sp3ernfdbslxqajxoeg#oibqr common parameters most endpoints share similar parameter patterns organization id required for all operations environment id distinguishes between development and production environments wallet id identifies specific wallets authentication the voltage api uses x api key authentication methods for api calls api key authentication (via x api key header) \ header 'x api key your api key' response formats the api consistently returns 200/202 successful operations 400 badly formatted requests 403 permission errors (read/write access controls) 404 resource not found 500 server errors