Reporting API

The Reporting API provides some limited query and reporting functions.

We are collecting feedback for any additional queries that banks would find useful for integration and reporting.

Reporting Note

The Provenance team is working on a more holistic aggregation and reporting tool that will superceded the basic functionality provided by DCC.

---

Retrieving Hash Balance (Gas)

GET /api/v1/balances/gas

Get the balance of HASH for the DCC middleware key pair address. HASH coin is needed to execute transactions against the Provenance Blockchain.

Gas Note

During DCC setup, HASH will need to be transferred to the key pair address before any endpoints will work against Provenance Blockchain.

Request

N/A

Response

Returns the number value of nhash remaining at your key pair address.

NHASH to HASH Conversion Note

1 HASH is equivalent to 1,000,000,000 nhash

---

Create Balance Report

POST /api/v1/balances

Initiate a new balance report which provides USDF coin balances for all of your registered bank accounts. A Persistence API callback will be completed upon generation.

Request

This request does not require a POST body.

Response

Returns a string value of "Report initialized".

Error Codes

400 - Bad Request

An existing balance report is already in progress.

500 - Internal Server Error

Some server error occurred.