Pular para o conteúdo

Get ledger account statement
Obsoleto

Requisição

Get statement for a specified Ledger account.

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

Segurança
Bearer
Caminho
account_name_with_addressstringobrigatório

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.

Consulta
start-datestringobrigatório

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-datestringobrigatório

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.

Padrão:0
sizeinteger, [ 1 .. 100 ]

Number of payment and transfer objects to return per page.

Padrão:10
curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/statement/ledger/{account_name_with_address}?start-date=string&end-date=string&page=0&size=10' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respostas

Successfully returned statement for a specified ledger account.

Corpoapplication/json
account_namestringobrigatório

Name of the account the statement covers.

Exemplo:"trans_usd_sf"
start_datetimestring, (date-time)obrigatório

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

Exemplo:"2018-08-06T23:13:55.997Z"
end_datetimestring, (date-time)obrigatório

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

Exemplo:"2020-08-06T23:13:55.997Z"
generated_atstring, (date-time)obrigatório

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

Exemplo:"2019-10-01T21:58:23.621Z"
currencystringobrigatório

Currency supported by the account.

Exemplo:"USD"
ownerstringobrigatório

Owner of the account

Exemplo:"rn.us.ca.san_francisco"
opening_balancenumberobrigatório

Opening balance of the account for the given date range.

Exemplo:0
closing_balancenumberobrigatório

Closing balance of the account for the given date range.

Exemplo:-909
transactionsobjectobrigatório

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

Resposta
{
  "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
  }
}