BitPay PHP SDK

RESTcli
in package

Tags
author

BitPay Integrations integrations@bitpay.com

license

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

Table of Contents

Properties

$baseUrl  : string
$client  : Client
$ecKey  : PrivateKey
$identity  : string
$proxy  : string

Methods

__construct()  : mixed
RESTcli constructor.
delete()  : string
Send DELETE request.
get()  : string
Send GET request.
init()  : void
Initialize Client.
post()  : string
Send POST request.
responseToJsonString()  : string
Convert Response object into json
update()  : string
Send PUT request.
isErrorStatus()  : bool

Properties

$identity

protected string $identity

Methods

__construct()

RESTcli constructor.

public __construct(string $environment, PrivateKey $ecKey[, string|null $proxy = null ]) : mixed
Parameters
$environment : string
$ecKey : PrivateKey
$proxy : string|null = null
Tags
throws
BitPayException

delete()

Send DELETE request.

public delete( $uri[, array<string|int, mixed>|null $parameters = null ]) : string
Parameters
$uri :
$parameters : array<string|int, mixed>|null = null
Tags
throws
BitPayException
Return values
string

get()

Send GET request.

public get( $uri[, array<string|int, mixed>|null $parameters = null ][, bool $signatureRequired = true ]) : string
Parameters
$uri :
$parameters : array<string|int, mixed>|null = null
$signatureRequired : bool = true
Tags
throws
BitPayException
Return values
string

(json)

post()

Send POST request.

public post( $uri[, array<string|int, mixed> $formData = [] ][, bool $signatureRequired = true ]) : string
Parameters
$uri :
$formData : array<string|int, mixed> = []
$signatureRequired : bool = true
Tags
throws
BitPayException
Return values
string

(json)

responseToJsonString()

Convert Response object into json

public responseToJsonString(Response $response) : string
Parameters
$response : Response
Tags
throws
BitPayException
throws
Exception
Return values
string

update()

Send PUT request.

public update( $uri[, array<string|int, mixed> $formData = [] ]) : string
Parameters
$uri :
$formData : array<string|int, mixed> = []
Tags
throws
BitPayException
Return values
string

isErrorStatus()

private isErrorStatus(array<string|int, mixed> $body) : bool
Parameters
$body : array<string|int, mixed>
Return values
bool

        
On this page

Search results