View all User Statements

Statements

GET https://api.synapsefi.com/v3.1/users/:user_id/statements

This endpoint allows you to get all statements linked to a user.

Path Parameters

Name	Type	Description
user_id	string	ID of User.

Query Parameters

Name	Type	Description
per_page	integer	Maximum documents to return per page. Default and max allowed is 20.
page	integer	Page number of the paginated request. Default is 1.

Headers

Name	Type	Description
X-SP-USER	string	User's OAuth key and device fingerprint, separated by a pipe.
X-SP-USER-IP	string	IP address of user's device.
X-SP-GATEWAY	string	Your Client ID and Secret, separated by a pipe.

200 Users successfully retrieved.

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "page": 1,
    "page_count": 1,
    "statements": [
        {
            "_id": "5fe96574002e2e01443f6281",
            "client": {
                "id": "589acd9ecb3cd400fa75ac06",
                "name": "SynapseFi"
            },
            "date_end": 1556755199999,
            "date_start": 1556582400000,
            "end_date": 1556755199999,
            "ending_balance": 0.0,
            "node_id": "5fe96562c54d7b7bcda9b9da",
            "opening_balance": 0.0,
            "type": "ONDEMAND_STATEMENT",
            "urls": {
                "csv": "https://cdn.synapsepay.com/uploads/2020/12/28/ATw3x9oyCLGkB1uJmYbI0XfDMQWn8N5r2UcHV6iszR7ZPe0OdF.csv",
                "json": "https://cdn.synapsepay.com/uploads/2020/12/28/mwNRF3ahz2TI0At0uiogB9ZMP6fxS7OYXGyp1J4lQHUkdcqb8W.json",
                "pdf": "https://cdn.synapsepay.com/uploads/2020/12/28/FKupyRJik0hPc6VMSCHb2Q8ZOYxvN5nedsolgrWBazI4AD1Ejt.pdf"
            },
            "user_id": "5fe50a777562960078d3a5c6"
        }
    ],
    "statements_count": 1,
    "success": true
}

400 Query failing

{
    "error": {
        "code": "missing_user_credentials",
        "en": "User credentials are missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Example Request

HTTP

GET /v3.1/users/5fe50a777562960078d3a5c6/statements HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_J6ciReHx79dWna8lvzFIoyfKGt1YujX2LqN54Q0r|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

cURL

curl --location --request GET 'https://uat-api.synapsefi.com/v3.1/users/5fe50a777562960078d3a5c6/statements' \
--header 'X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_J6ciReHx79dWna8lvzFIoyfKGt1YujX2LqN54Q0r|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' 

Python

//

JS

//

PHP

//

GO

//