Sign in

v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB
Balances and statements

Get ledger account statement

Get statement for a specified Ledger account.

Note: This operation is deprecated. Use the Reports API to view your statements.

get/statement/ledger/{account_name_with_address}

Path parameters

account_name_with_addressstring required

The RippleNet account name and address that you want to return a statement for. Use the format accountname@ripplenetaddress. For example, san_francisco@rn.us.ca.san_francisco.

Query parameters

start-datestring required

The lower bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, 2018-08-06T23:13:55.997Z.

end-datestring required

The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC For example, 2018-08-06T23:15:13.218Z.

pageinteger

The page number for paginated results. The value is zero-based, where 0 represents the first page.<br/> Set it to 0 to get the first page of results.

sizeinteger

Number of payment and transfer objects to return per page.

Response

Successfully returned statement for a specified ledger account.

account_namestring required

Name of the account the statement covers.

start_datetimestring date-time required

Lower bound of the date-time range the statement covers, as an ISO-8601 timestamp in UTC.

end_datetimestring date-time required

Upper bound of the date-time range the statement covers, as an ISO-8601 timestamp in UTC.

generated_atstring date-time required

Time at which the statement was generated, as an ISO-8601 timestamp in UTC.

currencystring required

Currency supported by the account.

ownerstring required

Owner of the account

opening_balancenumber required

Opening balance of the account for the given date range.

closing_balancenumber required

Closing balance of the account for the given date range.

Example response

{
  "account_name": "trans_usd_sf",
  "start_datetime": "2018-08-06T23:13:55.997Z",
  "end_datetime": "2020-08-06T23:13:55.997Z",
  "generated_at": "2019-10-01T21:58:23.621Z",
  "currency": "USD",
  "owner": "rn.us.ca.san_francisco",
  "closing_balance": -909,
  "transactions": {
    "content": [
      {
        "transaction_id": "9eca588f-e89d-4629-82fa-da9c4646310f",
        "transaction_type": "PAYMENT",
        "transaction_state": "COMPLETED",
        "balance_change": -15,
        "balance_result": -909,
        "created_at": "2019-10-01T21:28:28.354Z",
        "end_to_end_id": "91ecb6bd-4dd8-4b53-a900-72b79f3064e4",
        "internal_id": "8afd8e99-4ad4-4f4e-9bb7-018ad8c3a89c",
        "venue_id": "nz7RpAujYgnQtjEM",
        "transaction_hash": "DB0AFC09E0A94FC1D11F8CBABA48A184E27094F8DD32FCBC46F316E98011E2A6",
        "balance_change_created_at": "2019-10-01T21:28:28.354Z",
        "sender_address": "rn.us.ca.san_francisco",
        "receiver_address": "rn.mx.mexico"
      }
    ],
    "total_elements": 1,
    "first": true,
    "last": true,
    "numberOfElements": 1,
    "size": 10,
    "totalPages": 1
  }
}