Menu

## SettlementException extends BitPayException
in package

SettlementException.php : 20

Generic settlement exception.

##### Tags

author

  BitPay Integrations integrations@bitpay.com

license

  http://www.opensource.org/licenses/mit-license.php MIT

### Table of Contents

#### Properties

$apiCode : string|null
$bitPayCode : string
$bitPayMessage : string

#### Methods

__construct() : mixed
  Construct the SettlementException.
getApiCode() : string

### Properties

#### $apiCode

BitPayException.php : 24
`protected string|null $apiCode`

#### $bitPayCode

SettlementException.php : 23
`private string $bitPayCode = "BITPAY-SETTLEMENTS-GENERIC"`

#### $bitPayMessage

SettlementException.php : 22
`private string $bitPayMessage = "An unexpected error occurred while trying to manage the settlements"`

### Methods

#### __construct()

SettlementException.php : 32

Construct the SettlementException.

`public __construct([string $message = "" ][, int $code = 151 ][, Exception $previous = null ][, string|null $apiCode = "000000" ]) : mixed`

##### Parameters

$message : string = ""

  [optional] The Exception message to throw.

$code : int = 151

  [optional] The Exception code to throw.

$previous : Exception = null
$apiCode : string|null = "000000"

  [optional] The API Exception code to throw.

#### getApiCode()

BitPayException.php : 46
`public getApiCode() : string`

##### Return values

string —

Error code provided by the BitPay REST API

## Search results