Gateway Business Reporting API Specification

Gateway Business Reporting API

Deposits

This section includes functions to get information about deposits.

Get Deposit List

get /accounts/{accountId}/deposits

This endpoint will return a list of deposits and the deposit details for a given account ID. Unless specified otherwise, this endpoint will return every deposit for the given account ID since the ID was created.

Parameters

accountId required

Type

string

start

Type

string

Example

?start=2017-07-19 13:30:00

end

Type

string

Example

?end=2017-07-21 23:59:59

count

Type

integer

Example

Example Response

200 Authorized

401 Unauthorized

Get Deposit by ID

get /accounts/{accountId}/deposits/{depositId}

Get deposit by deposit ID for a given account ID.

Parameters

accountId required

Type

string

depositId required

Type

string

Example Response

200 Authorized

401 Unauthorized