For AI agents: visit https://developer.bitpay.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Guides API & SDK Documentation Changelog

API & SDK Documentation

Guides API & SDK Documentation Changelog

Start Here

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

API Reference

Tokens
Invoices
Refunds
Settlements
Ledgers
- Retrieve Account Balancesget
- Retrieve Ledger Entriesget
Recipients
Payouts
Bills
Subscriptions
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
Java SDK
Node SDK
PHP SDK
Python SDK

Demo Apps

General Overview
Java (Spring Boot) Kiosk Demo
PHP (Laravel) Kiosk Demo
C# (.NET) Kiosk Demo
PHP (Symfony) Kiosk Demo

Powered by

Cancel a Payout Group

Facades: payout

Overview

Allows a merchant to cancel a payout group request

Example

const cancelledPayouts = client.cancelPayouts('payoutGroupId');

Updated about 1 year ago

Create Payout Group

Get Payout by ID

Did this page help you?

Updated about 1 year ago

Create Payout Group

Get Payout by ID

Did this page help you?

- Overview
- Example