Statement list
https://sandbox-products.ddp.akoya.com/statements/{version}/{providerId}/{accountId}
Retrieve a list of available statements for the end-user's consented accounts. You may request a date range of up to two years of historical statements (maximum date ranges vary by provider).
The paginated response includes an array of statement information with the end-user's account id and statement details such as statement id, date, description, and status. The results also include links to GET the statement image.
Path Parameters
version*
stringdefault: v2Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2
providerId*
stringdefault: mikomoId of provider
accountId*
stringdefault: :accountIdAccount Identifier
Query Parameters
startTime
stringStart date for use in retrieval of statements (ISO 8601)
endTime
stringEnd date for use in retrieval of statements (ISO 8601)
offset
stringdefault: 0The number of items to skip before the first in the response. The default is 0.
limit
integerdefault: 50The maximum number of items to be returned in the response. The default is 50.
Headers
x-akoya-interaction-type
stringOptional but recommended header to include with each data request. Allowed values are `user` or `batch`. `user` indicates a request is prompted by an end-user action. `batch` indicates the request is part of a batch process.
batch
Responses
200
OK
Response Body
object
links
object
next
object
href
string
prev
object
href
string
statements
array of objects
An array of Statement, each with its HATEOAS link to retrieve the account statement
object
accountId
string
Corresponds to accountId in Account entity
statementId
string
Long-term persistent identity of the statement
statementDate
string
Date of the statement in ISO 8601.
description
string
Description of statement. Should include description of type of statement: monthly, quarterly, yearly.
links
array of objects
The links to retrieve this account statement, or to invoke other APIs
object
href
string
URL to invoke the action on the resource
action
string
HTTP Method to use for the request
GETPOSTPATCHDELETEPUTtypes
array of strings
Content-types that can be used in the Accept header.
string
status
string
Availability status of statement
AVAILABLEPROCESSINGFAILED400
Start or end date value is not in the ISO 8601 format
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
404
404 - Not found
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
500
500 - Internal server error
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
501
1106 - Version not supported or not implemented
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
503
503 - System is down for maintenance
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
Try it
Authorization
const options = {
"method": "GET",
"headers": {
"x-akoya-interaction-type": "batch"
}
}};
fetch('https://sandbox-products.ddp.akoya.com/statements/v2/mikomo/:accountId?startTime=2020-03-30&endTime=2021-03-30&offset=0&limit=50', options)
.then(response => response.json())
.catch(err => console.error(err));