/statements
Lists statement delivery attempt details with the option to filter for one specific user.
Request
The request body at this endpoint is the statements JSON object.
The search_filters object and all of its nested keys are optional. They can be used to filter the statement delivery attempts.
Results are paginated; by default, the first 20 results are returned. You can request up to 100 results per page ("per_page": 100)
The page and per_page keys can instead be specified in query parameters (e.g. by appending ?page=2&per_page=2 or ?per_page=100 to the end of the URL). If these keys are already specified in the request body, the request body keys take precedence. This allows a requester to fetch several pages using the same signatures if desired.
Authorization / Authentication
Apps using Access Token Authorization
Use a valid access token in an Authorization: Bearer request header.
See Authenticating with an Access Token for more details.
Apps using ECDSA Authentication
The auth signature header is required for this request. The user signature header is optional if you would like to get transactions for all users. If you choose to omit the user signature header, you'll also need to omit the user_handle from the Header object.
See the section on ECDSA Authentication for more detail about ECDSA signature generation.
Note - We recently renamed the field auth_handle to app_handle. For backward compatibility, auth_handle is still valid but has been removed from our documentation.
GET /0.2/statements HTTP/1.1
Host: sandbox.silamoney.com
Content-Type: application/json
// if using OAuth2
Authorization: Bearer [GENERATED JWT TOKEN HERE]
// if using ECDSA
authsignature: [GENERATED AUTHSIGNATURE HEX STRING HERE]
usersignature: [GENERATED USERSIGNATURE HEX STRING HERE]
{
"header": {
"created": 1234567890,
"app_handle": "handle.silamoney.eth",
"user_handle":"user.silamoney.eth",
"version": "0.2",
"reference": "<your unique id>"
},
"search_filters":{
"start_date": "2022-07-19",
"end_date": "2022-09-20",
"user_name": "Postman User",
"user_handle": "1659592367",
"account_type":"<wallet_address> or <virtual_account>",
"email":"[email protected]",
"status":"Unsent",
"identifier":"3531854e-0d04-431b-9534-7ac309ae625f",
"wallet_address": "wallet_address", // legacy, backwards compatibility only
"page":1,
"per_page":20
}
}
Key | Type | Descsription |
---|---|---|
header | JSON object | Required. Requires these keys in JSON format: created, app_handle. user_handle is optional. See the /check_handle endpoint for the complete list of fields in this object. |
search_filters | JSON object | Optional. Allows filtering results. |
search_filters.user_name | String | Optional. user_name of the end user. |
search_filters.user_handle | String | Optional. user_handle of the end user. |
search_filters.account_type | String | Optional. Valid values: wallet_address virtual_account |
search_filters.email | String | Optional. Registered email for the end user. |
search_filters.status | String | Optional. Must be one of unsent, failed, success. Example: unsent |
search_filters.wallet_address | String | Optional. Backwards compatibility only. Disregard if not already utilizing. |
search_filters.page | Integer | Optional. Min Length: 1 Default: 1 |
search_filters.per_page | Integer | Optional. Min: 1 Max: 100 Default per page: 20 |
search_filters.start_date | string / ISO‑8601 date | Optional. Only return documents created on or after this date. |
search_filters.end_date | string / ISO‑8601 date | Optional. Only return documents created before or on this date. |
search_filters.identifier | String | Optional. |
Response
HTTP/1.1 200 OK
{
"success": true,
"status": "SUCCESS",
"reference": "<your unique id>",
"response_time_ms": "171",
"documents": [
{
"user_handle": "user.silamoney.eth",
"document_id": "279687a0-30c6-463d-85bc-eee9bf395e21",
"name": "passport_2017",
"filename": "img_201901022_034923",
"hash": "075f0956584cfa8d32beb384fcf51ce3ee30a7e5aeee6434acc222928a30db3e",
"type": "id_passport",
"size": "12345678",
"created": "2020-08-03T17:09:24.917939"
}
],
"pagination": {
"returned_count": 1,
"total_count": 1,
"current_page": 1,
"total_pages": 1
}
}
Status Code | Success Attribute | Description |
---|---|---|
200 | true | Able to return transaction information. |
400 | false | Bad request format - check validation_details for more information. |
403 | false | Bad/absent signature header. |
500 | false | Server-side issue; please reach out to Sila support. |
Updated 3 days ago