Get platform account statement

Request

Get statement for a specified Platform Account

Security

Bearer

Path

platformAccountIdstringrequired

The RippleNet platform account ID that you want to get a statement for. Example: bitso

Query

start-datestringrequired

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-datestringrequired

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.
Set it to 0 to get the first page of results.

Default:0

sizeinteger, [ 1 .. 100 ]

Number of payment and transfer objects to return per page.

Default:10

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/monitor/platform/accounts/{platformAccountId}/statement?start-date=string&end-date=string&page=0&size=10' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned statement for a specified platform account.

Bodyapplication/json

account_namestringrequired

Name of the account the statement covers.

Example:"trans_usd_sf"

start_datetimestring, (date-time)required

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

Example:"2018-08-06T23:13:55.997Z"

end_datetimestring, (date-time)required

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

Example:"2020-08-06T23:13:55.997Z"

generated_atstring, (date-time)required

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

Example:"2019-10-01T21:58:23.621Z"

currencystringrequired

Currency supported by the account.

Example:"USD"

ownerstringrequired

Owner of the account

Example:"rn.us.ca.san_francisco"

opening_balancenumberrequired

Opening balance of the account for the given date range.

Example:0

closing_balancenumberrequired

Closing balance of the account for the given date range.

Example:-909

transactionsobjectrequired

Provides a content array and a set of pagination information fields.

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",
  "opening_balance": 0,
  "closing_balance": -909,
  "transactions": {
    "content": [ … ],
    "total_elements": 1,
    "sort": "string",
    "first": true,
    "last": true,
    "number": 0,
    "numberOfElements": 1,
    "size": 10,
    "totalPages": 1
  }
}