BTCPay Server

Commerce & fulfillmentCredentials form

Create and track bitcoin invoices, payment requests, refunds and payouts on a self-hosted BTCPay Server through its Greenfield API.

11 actions

Action	Effect	Data handled
btcpay_get_server_infoReturns the server's version, supported payment methods and sync status	read	General
btcpay_list_storesLists the stores the API key can see, with their ids and default currencies	read	General
btcpay_get_storeReturns one store's settings: name, website, default currency, invoice expiration and speed policy	read	General
btcpay_list_invoicesLists a store's invoices, filtered by status, order id, text or a creation period, paged with skip and take	read	Personal data
btcpay_get_invoiceReturns one invoice with its amount, status, checkout link and metadata, and its payment methods on request	read	Personal data
btcpay_create_invoiceCreates an invoice in a store for an amount and currency; share its checkoutLink with the payer	write	Personal data
btcpay_mark_invoice_statusMarks an invoice as Settled or Invalid by hand, for example when it was paid outside BTCPay	write	General
btcpay_refund_invoiceCreates a refund for a paid invoice as a pull payment the buyer claims; returns its view link	write	Personal data
btcpay_list_payment_requestsLists a store's payment requests (reusable invoices a payer can pay in parts)	read	Personal data
btcpay_create_payment_requestCreates a payment request with a title and amount that the payer can pay through its public page	write	Personal data
btcpay_list_payoutsLists a store's payouts (refunds and pull-payment claims) with their state	read	Personal data

Sign-in

Also included

dexby.createSession({
  userId: customer.id,
  connectors: ['btcpay']
})