Documentation

Application

Table of Contents

Interfaces

Env
BillStatus
Contains bill statuses: Can be "draft", "sent", "new", "paid", or "complete"
Facade
Facades named collections of capabilities that can be granted, such as the ability to create invoices or grant refunds
InvoiceStatus
The type Invoice status.
RefundStatus
Refund status list
RecipientReferenceMethod
List of recipient reference methods

Classes

BillClient
InvoiceClient
LedgerClient
PayoutClient
PayoutRecipientsClient
RateClient
RefundClient
SettlementClient
TokenClient
WalletClient
BillCreationException
BillDeliveryException
BillException
BillQueryException
BillUpdateException
BitPayException
CurrencyException
CurrencyQueryException
InvoiceCancellationException
InvoiceCreationException
InvoiceException
InvoicePaymentException
InvoiceQueryException
InvoiceUpdateException
LedgerException
LedgerQueryException
PayoutBatchCancellationException
PayoutBatchCreationException
PayoutBatchException
PayoutBatchNotificationException
PayoutBatchQueryException
PayoutCancellationException
PayoutCreationException
PayoutException
PayoutNotificationException
PayoutQueryException
PayoutRecipientCancellationException
PayoutRecipientCreationException
PayoutRecipientException
PayoutRecipientNotificationException
PayoutRecipientQueryException
PayoutRecipientUpdateException
PayoutUpdateException
RateException
RateQueryException
RefundCancellationException
RefundCreationException
RefundException
RefundNotificationException
RefundQueryException
RefundUpdateException
SettlementException
SettlementQueryException
WalletException
WalletQueryException
Currency
Object containing currency information
BuyerProvidedInfo
Information collected from the buyer during the process of paying an invoice. Initially this object is empty.
MinerFees
The total amount of fees that the purchaser will pay to cover BitPay's UTXO sweep cost for an invoice.
RefundInfo
For a refunded invoice, this object will contain the details of executed refunds for the corresponding invoice.
Shopper
This object will be available on the invoice if a shopper signs in on an invoice using his BitPay ID.
UniversalCodes
Object containing wallet-specific URLs for payment protocol.
PayoutGroup
PayoutGroupFailed
PayoutTransaction
Contains the cryptocurrency transaction details for the executed payout.
InvoiceData
Object containing relevant information from the paid invoice.
PayoutInfo
Object containing the settlement info provided by the Merchant in his BitPay account settings.
RefundInfo
Object containing information about the refund.
Settlement
Settlement data object.
Currencies
Details of what currencies support payments for this wallet
CurrencyQr
Object containing QR code related information to show for this payment method
JsonMapperFactory

        
On this page

Search results