For AI agents: visit https://developer.bitpay.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
bitpay
GuidesAPI & SDK DocumentationChangelog
bitpay
API & SDK Documentation
GuidesAPI & SDK DocumentationChangelog

Start Here

  • Standards & Concepts
  • Environments
  • Getting Access
  • Making Requests
  • Error Codes
  • Ledger Entry Codes
  • Signing API Calls

API Reference

  • Tokens
    • Request an API Tokenpost
    • Retrieve Approved API Tokensget
    • View the SIN(s) Linked to an Approved Tokenget
    • Link a New SIN to an Approved Tokenpost
    • Remove an SIN to an Approved Tokendel
  • Invoices
    • Create an Invoicepost
    • Update an Invoiceput
    • Retrieve an Invoiceget
    • Retrieve an Invoice by GUIDget
    • Retrieve Invoices Filtered by Queryget
    • Retrieve an Event Tokenget
    • Cancel an Invoicedel
    • Cancel an Invoice by GUIDdel
    • Request an Invoice Webhook to be Resentpost
  • Refunds
    • Create a Refund Requestpost
    • Update a Refund Requestput
    • Update a Refund by GUID Requestput
    • Retrieve a Refund Requestget
    • Retrieve a Refund by GUID Requestget
    • Retrieve Refunds of an Invoiceget
    • Cancel a Refund Requestdel
    • Cancel a Refund by GUID Requestdel
    • Request a Refund Notification to be Resentpost
  • Settlements
    • Retrieve Settlementsget
    • Retrieve a Settlementget
    • Fetch a Reconciliation Reportget
  • Ledgers
    • Retrieve Account Balancesget
    • Retrieve Ledger Entriesget
  • Recipients
    • Invite Recipientspost
    • Retrieve a Recipientget
    • Update a Recipientput
    • Remove a Recipientdel
    • Retrieve Recipients by Statusget
    • Request a Recipient Webhook to be Resentpost
  • Payouts
    • Create a Payoutpost
    • Create Payout Grouppost
    • Retrieve a Payoutget
    • Retrieve Payouts Filtered by Queryget
    • Cancel a Payoutdel
    • Cancel a Payout Groupdel
    • Request a Payout Webhook to be Resentpost
  • Bills
    • Create a Billpost
    • Retrieve a Billget
    • Update a Billput
    • Retrieve Bills by Statusget
    • Deliver a Bill Via Emailpost
  • Subscriptions
    • Create a Subscriptionpost
    • Retrieve a Subscriptionget
    • Update a Subscriptionput
    • Retrieve Subscriptions by Statusget
  • Rates
    • Retrieve all the rates for a given cryptocurrencyget
    • Retrieve the rates for a cryptocurrency / fiat pairget
  • Sessions
    • Create an API Sessionpost
  • Currencies
    • Retrieve the Supported Currenciesget
  • Wallets
    • Retrieve the Supported Walletsget

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 

Rates

Rates are exchange rates, representing the number of fiat currency units equivalent to one BTC.

Resource

TBD.

Updated 10 months ago


Retrieve Subscriptions by Status
Retrieve all the rates for a given cryptocurrency
Did this page help you?

Updated 10 months ago


Retrieve Subscriptions by Status
Retrieve all the rates for a given cryptocurrency
Did this page help you?
    • Resource