BitPay is a global cryptocurrency payment service provider. It enables the acceptance of Bitcoin and other cryptocurrencies as payment for goods and services, converting them into local currency if desired. Known for its security features, low processing fees compared to traditional payment methods, and support for multiple cryptocurrencies, BitPay has become a major player in bridging the gap between digital assets and everyday commerce. Learn more about BitPay.

Payment method properties


Markets (consumer)	Global Excluding: `BD` `BO` `CU` `DZ` `EC` `EG` `ID` `IR` `IQ` `KG` `KH` `KP` `MA` `NP` `PK` `SY` `VN`
Processing currencies	`EUR` `GBP` `USD`
Consumer currencies	`BTC` `BCH` `ETH` `DOGE` `LTC` `POL` `XRP`
Authentication methods	`REDIRECT`
Authentication timeout	2 hours
Minimum payment amount	1.00 USD or equivalent
Maximum payment amount	No Limit
Payment instrument	`PASSTHROUGH_WALLET`
Recurring payments	No
Separate captures	No
Refund	No
Refund validity	N/A
Disputes	No
Settlement risk	No
Sandbox availability	BitPay sandbox

Make a BitPay payment

BitPay payments follow our standardized REDIRECT payment flow. Enabling you to offer a seamless desktop experience. We recommend including all relevant settings for any authentication methods you support.

To create a DOKU payment, you'll need to provide the following data at minimum when calling our payment charges API:

Field	Description
paymentMethod	`BITPAY`
amount.value	The amount to be paid in the smallest units of the currency used.
amount.currency	`EUR` `GBP` `USD`
consumer.country	The country where the consumer is shopping.
authenticationSettings: REDIRECT settings.returnUrl	Add the URL where the consumer should be redirected after they complete the payment. Required for the `REDIRECT` flow.

Request

POST /v1/payment-charges

{
  "paymentMethod": "BITPAY",
  "amount": {
    "value": 1000,
    "currency": "USD"
  },
  "consumer": {
    "country": "US"
  },
  "authenticationSettings": [
    {
      "type": "REDIRECT",
      "settings": {
        "returnUrl": "https://www.webshop.com/order-results-page"
      }
    }
  ]
}

Response

You'll receive our standard payment charge response with the available authentication methods:

{
  "id": "charge_Y3JVzvEaJpvG53xd2R2Zt",
  "paymentMethod": "BITPAY",
  "paymentMedium": "ECOMMERCE",
  "scheduleType": "UNSCHEDULED",
  "instrumentId": "instr_Asu0ig2PXXZSiNrhY44A5",
  "currency": "USD",
  "country": "US",
  "status": "AUTHENTICATION_PENDING",
  "consumer": {
    "country": "US"
  },
  "authenticationMethods": [
    {
      "details": {
        "requestUrl": "https://redirection-target.ppro.com",
        "requestMethod": "GET"
      },
      "type": "REDIRECT"
    }
  ],
  "authorizations": [
    {
      "id": "authz_aPobet0FNZNU1bYqfexFd",
      "amount": 1000,
      "status": "AUTHENTICATION_PENDING",
      "createdAt": "2025-06-21T08:34:20.766Z",
      "updatedAt": "2025-06-21T08:34:20.766Z"
    }
  ],
  "captures": [],
  "refunds": [],
  "voids": [],
  "createdAt": "2025-06-21T08:34:20.114Z",
  "updatedAt": "2025-06-21T08:34:20.766Z",
  "_links": {
    "authorizations": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/authorizations"
    },
    "captures": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/captures"
    },
    "refunds": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/refunds"
    },
    "voids": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/voids"
    }
  }
}

Pick the desired authentication method

REDIRECT

Redirect your consumer to the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl.
For example, with the value of https://redirection-target.ppro.com/ using the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod HTTP method.
The consumer will be presented with the reference number and instructions to complete the payment.

Handling the payment result

REDIRECT

After the consumer completes the payment, they are redirected to the returnUrl specified in the payment charge creation request.
Upon redirect back to your site, retrieve the latest payment status by performing a GET /v1/payment-charges/{paymentChargeId}. Use the returned status field to determine and display the final payment outcome to the consumer.
Additionally, webhooks are triggered to notify you of the payment result. This ensures you receive the outcome even if the consumer closes their browser or fails to return to your website.

Payment instrument

A PASSTHROUGH_WALLET instrument will be created for BitPay, with no additional data provided.

Request

GET /v1/payment-instruments/{instrument-id}

Response

{
    "id": "instr_vlhrwkPclBlrhf8gnANVh",
    "type": "PASSTHROUGH_WALLET"
}