The upcoming API change will remove a number of deprecated API fields and some API calls. It also adds new fields for multi-currency payments, including transactionCurrency. We list these fields and their recommended replacement below. For details see the BitPay API documentation here.
Who will be affected?
If you are using BitPay’s email billing tool, payment buttons, hosted catalog, donation buttons or donation page, you will not need to make any changes.
Who will not be affected?
If you have integrated with BitPay’s REST API (for invoices, refunds, adjustments, settlement reports, ledgers, Instant Payment Notifications, etc.), these changes will affect your BitPay implementation.
Plugin Updates
If you are using BitPay's PHP library, OpenCart plugin, Magento plugin, or Woocommerce plugin, you should update to the latest versions of these plugins. To access our updated plugins and PHP code library, see the links below:
- PHP: v2.2.20
- Magento 1, BitPay plugin v2.1.19
- OpenCart 3, BitPay plugin v3.0.2
- WooCommerce, BitPay plugin v2.2.15
Changes to BitPay's API
Changes for /Invoices
| Deprecated field, to be removed | New field |
|---|---|
| btcPrice (string) | paymentSubtotals (object) |
| btcDue (string) | paymentTotals (object) |
| btcPaid (string) | amountPaid (number) |
| rate (number) | exchangeRates (object) |
| exRates (object) | exchangeRates (object) |
| paymentUrls (object) | paymentCodes (object) |
| buyerPaidBtcMinerFee (string) | to be removed |
| bitcoinAddress (string) | to be removed |
| addresses (object) | to be removed |
| flags (object) -> refundable (boolean) (string) | to be removed |
| [not existing] | transactionCurrency (string) |
| [not existing] | supportedTransactionCurrencies (object) |
| [not existing] | minerFees (object) |
Changes for /Invoices/:invoiceId/Refunds
Refunds via the merchant dashboard work via BitPay’s email flow: the merchant requests that a payment be refunded, and BitPay sends an email to the buyer to collect the buyer’s refund address. This update will align the API with the merchant dashboard flow. Merchants using BitPay’s refund API should update their implementations.
| Deprecated field, to be removed | New field |
|---|---|
| bitcoinAddress (string) | refundEmail |
Changes for /Invoices/:invoiceId/adjustments
We will completely remove the invoice adjustments endpoint from the BitPay API (used for acceptance of underpayments and overpayments).
Now that BitPay only accepts payments sent using Payment Protocol wallets, underpayments and overpayments no longer occur frequently.
In the rare case that a payment results in an underpayment or overpayment, the buyer will be able to receive a refund via BitPay's automated email flow. If you have enabled automatic underpayment acceptance for certain payments, they will be accepted and credited to your merchant ledger.
Changes for /Settlements/:settlementId/reconciliationReport
| Deprecated field, to be removed | New field |
|---|---|
| btcPrice (string) | to be removed |
| [not available] | invoiceData (object) -> transactionCurrency (string) |
Changes for /ledgers
| Deprecated field, to be removed | New field |
|---|---|
| exRates (object) | to be removed |
| customerData (object) | to be removed |
| [not available] | transactionCurrency (string) |
Changes for Instant Payment Notifications
| Deprecated field, to be removed | New field |
|---|---|
| btcPrice (string) | paymentSubtotals (object) |
| btcDue (string) | paymentTotals (object) |
| btcPaid (string) | amountPaid (number) |
| rate (number) | exchangeRates (object) |
| [not existing] | transactionCurrency (string) |
As always, we recommend that you follow the BitPay developer documentation:
Comments
0 comments
Article is closed for comments.