Jump to Content
Guides
API & SDK Documentation
Changelog
API & SDK Documentation
Guides
API & SDK Documentation
Changelog
Lite vs. Full SDK
All
Pages
Start typing to search…
JUMP TO
Start Here
Standards & Concepts
Environments
Getting Access
Making Requests
Error Codes
Ledger Entry Codes
Signing API Calls
API Reference
Tokens
Request an API Token
post
Retrieve Approved API Tokens
get
View the SIN(s) Linked to an Approved Token
get
Link a New SIN to an Approved Token
post
Remove an SIN to an Approved Token
del
Invoices
Create an Invoice
post
Update an Invoice
put
Retrieve an Invoice
get
Retrieve an Invoice by GUID
get
Retrieve Invoices Filtered by Query
get
Retrieve an Event Token
get
Cancel an Invoice
del
Cancel an Invoice by GUID
del
Request an Invoice Webhook to be Resent
post
Refunds
Create a Refund Request
post
Update a Refund Request
put
Update a Refund by GUID Request
put
Retrieve a Refund Request
get
Retrieve a Refund by GUID Request
get
Retrieve Refunds of an Invoice
get
Cancel a Refund Request
del
Cancel a Refund by GUID Request
del
Request a Refund Notification to be Resent
post
Settlements
Retrieve Settlements
get
Retrieve a Settlement
get
Fetch a Reconciliation Report
get
Ledgers
Retrieve Account Balances
get
Retrieve Ledger Entries
get
Recipients
Invite Recipients
post
Retrieve a Recipient
get
Update a Recipient
put
Remove a Recipient
del
Retrieve Recipients by Status
get
Request a Recipient Webhook to be Resent
post
Payouts
Create a Payout
post
Create Payout Group
post
Retrieve a Payout
get
Retrieve Payouts Filtered by Query
get
Cancel a Payout
del
Cancel a Payout Group
del
Request a Payout Webhook to be Resent
post
Bills
Create a Bill
post
Retrieve a Bill
get
Update a Bill
put
Retrieve Bills by Status
get
Deliver a Bill Via Email
post
Subscriptions
Create a Subscription
post
Retrieve a Subscription
get
Update a Subscription
put
Retrieve Subscriptions by Status
get
Rates
Retrieve all the rates for a given cryptocurrency
get
Retrieve the rates for a cryptocurrency / fiat pair
get
Sessions
Create an API Session
post
Currencies
Retrieve the Supported Currencies
get
Wallets
Retrieve the Supported Wallets
get
Notifications (Webhooks)
Notifications Overview
Invoices
Refunds
Recipients
Payouts
Notification Codes
HMAC Verification
SDKs
BitPay SDK Overview
C# SDK
C# Full SDK (version < 5.0.0)
Create an Invoice
Retrieve an Invoice
Retrieve Invoice Filtered By Query
Update Invoice
Delete an Invoice
Create a Bill
Retrieve a Bill
Update a Bill
Deliver a Bill
Get Ledgers
Create Payout Recipients
Get Payout Recipient by ID
Get Payout Recipients
Update Payout Recipient
Delete Payout Recipient
Request Payout Recipient Notification
Recipient Webhooks
Create Payout Request
Get Payout Request by ID
Get Payout Request
Cancel Payouts
Request Payout Notification
Payout Webhooks
Get Exchange Rates
Create Refund Request
Get Refund Request
Get All Refund Requests on Invoice
Update a Refund
Cancel a Refund
Request Refund Notification
Retrieve Settlements
Retrieve a Settlement by ID
Get Settlement Reconciliation Report
Get Supported Wallets
Java SDK
Java Full SDK (version < 9.0.0)
Create an Invoice
Retrieve an Invoice
Retrieve an Invoice by GUID
Retrieve Invoices
Update an Invoice
Cancel an Invoice
Cancel an Invoice by GUID
Pay an Invoice
Create a Refund
Create a Refund with GUID
Create a Refund by Object
Retrieve a Refund
Retrieve a Refund by GUID
Get All Refund Requests by Invoice ID
Update a Refund
Update a Refund by GUID
Cancel a Refund
Cancel a Refund by GUID
Request a Refund Notification
Retrieve Settlements
Retrieve a Settlement
Fetch a Reconciliation Report
Retrieve Account Balances
Retrieve Ledger Entries
Create Payout Recipients
Get Payout Recipient
Get Payout Recipients
Update Payout Recipient
Delete Payout Recipient
Request Payout Recipient Notification
Recipient Webhooks
Create Payout Request
Create Payout Group
Cancel a Payout Group
Get Payout by ID
Get Payouts
Cancel Payout
Request Payout Notification
Payout Webhooks
Create a Bill
Retrieve a Bill
Retrieve Bills
Retrieve Bills by Status
Update a Bill
Deliver a Bill
Get Exchange Rates
Retrieve Supported Wallets
Node SDK
Node Full SDK 6.x
Node Full SDK (version < 5.0.0)
Create an Invoice
Retrieve an Invoice
Retrieve an Invoice by GUID
Retrieve Invoices
Update an Invoice
Cancel an Invoice
Cancel an Invoice by GUID
Pay an Invoice
Create Refund Request
Get Refund
Get Refund by GUID
Get All Refunds on Invoice
Update Refund
Update Refund by GUID
Cancel Refund
Cancel Refund by GUID
Request Refund Notification
Get Settlements
Get Settlement by ID
Get Settlement Reconciliation Export
Retrieve Account Balances
Retrieve Ledger Entries
Create Payout Recipients
Get Payout Recipient
Get Payout Recipients
Update Payout Recipients
Delete Payout Recipient
Request Payout Recipient Notification
Recipient Webhooks
Create Payout Request
Create Payout Group
Cancel a Payout Group
Get Payout by ID
Get Payouts
Cancel Payouts
Request Payout Notification
Payout Webhooks
Create Bill
Retrieve a Bill
Retrieve Bills by Status
Update a Bill
Deliver Bill
Get Exchange Rates
Get Currencies
Get Supported Wallets
PHP SDK
PHP Full SDK (version < 8.0.0)
Create an Invoice
Retrieve an Invoice
Retrieve an Invoice by GUID
Retrieve Invoices
Update an Invoice
Cancel an Invoice
Cancel an Invoice by GUID
Pay an Invoice
Create a new refund request
Get existing refund request
Get all refund requests on an Invoice
Update Refund Request
Cancel Refund Request
Request Refund Notification
Get Settlements
Get Settlement by ID
Get Settlement Reconciliation Report
Retrieve Account Balances
Retrieve Ledger Entries
Create Payout Recipients
Get Payout Recipient
Get Payout Recipients
Update Payout Recipient
Delete Payout Recipient
Request Payout Recipient Notification
Recipient Webhooks
Create Payout Request
Create Payout Group
Cancel a Payout Group
Get Payout by ID
Get Payouts
Cancel Payouts
Request Payout Notification
Payout Webhooks
Create Bill
Retrieve a Bill
Retrieve Bills by Status
Update a Bill
Deliver Bill
Get Exchange Rates
Get Currencies
Python SDK
Create an Invoice
Retrieve an Invoice
Retrieve an Invoice by GUID
Retrieve Invoices
Update an Invoice
Cancel an Invoice
Cancel an Invoice by GUID
Pay an Invoice
Create a new refund request
Get existing refund request
Get all refund requests on an Invoice
Update Refund Request
Update Refund Request by GUID
Cancel Refund Request
Cancel Refund Request by GUID
Request Refund Notification
Get Settlements
Get Settlement by ID
Get Settlement Reconciliation Report
Retrieve Account Balances
Retrieve Ledger Entries
Create Payout Recipients
Get Payout Recipient
Get Payout Recipients
Update Payout Recipient
Delete Payout Recipient
Request Payout Recipient Notification
Recipient Webhooks
Create Payout Request
Create Payout Group
Cancel a Payout Group
Get Payout by ID
Get Payouts
Cancel Payouts
Request Payout Notification
Payout Webhooks
Create Bill
Retrieve a Bill
Retrieve Bills by Status
Update a Bill
Deliver Bill
Get Exchange Rates
Get Currencies
Retrieve Supported Wallets
Demo Apps
General Overview
Java (Spring Boot) Kiosk Demo
PHP (Laravel) Kiosk Demo
C# (.NET) Kiosk Demo
PHP (Symfony) Kiosk Demo
Powered by
Lite vs. Full SDK
Ask AI
