Statement
https://sandbox-products.ddp.akoya.com/statements/{version}/{providerId}/{accountId}/{statementId}
Retrieve a specific account statement file. Use HTTP Accept request-header to specify desired content types.
For the initial launch, only PDF statements are supported. PDFs are returned in the response.
cURL request
We recommend using the auto-generated cURL request with the {idToken}, accountId, providerId, statementId, and version with an added cURL parameter to return the output to a file. For example:
BASH
curl --request GET --url https://sandbox-products.ddp.akoya.com/statements/v2/mikomo/513815781465/P9CvLPKDaFRMbNDkhu1 --header "accept: application/pdf" --header "authorization: Bearer {idtoken}" --output example.pdfPath 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
statementId*
stringdefault: statementIdStatement Identifier
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 - An image of an account statement
File Response: application/pdf
File Response: image/gif
File Response: image/jpeg
File Response: image/tiff
File Response: image/png
Headers
Acceptstring
302
302 - Statement is available at specified location. URL is returned via the `Location` HTTP header
400
Statement is processing and is not yet available
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
Account exists but contains no statements
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
406
1203 - Content Type not Supported
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/statementId', options)
.then(response => response.json())
.catch(err => console.error(err));