Statements by User

Get the statement for a user

Use this call if you want the transaction statement for the specific user. Statements are returned per month and returned in two formats (CSV & PDF) which you will be able to download through a URL.

API ENDPOINT

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

QUERY PARAMETER

page :
integer

Page number

per_page :
integer 20

Number of Statements per page

EXAMPLE REQUEST

GET /v3.1/users/5b4b2d9d14ddee0049e651e9/statements HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_zUWrVRmZ19KoHBtJ8EqhYkj70uvTXOyx34nD0Q2b|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
user.get_statements()
user.getStatementsByUser();
user.get_user_statement()
$page=null;
$per_page=null;

$user->get_user_statements($page, $per_page);
data, err := user.GetStatements()

EXAMPLE RESPONSE

A successful response will include the urls for the user statement in CSV and PDF for you to download. All you have to do is grab the URL you wish and open a new browser tab and paste the returned link from the response.

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "page": 1,
    "page_count": 1,
    "statements": [
        {
            "_id": "5b4b2ec82775e400bb7b560b",
            "date_end": 1728000000000,
            "date_start": 1451433600000,
            "urls": {
                "csv": "https://cdn.synapsepay.com/uploads/2018/07/15/FEevRbZ7yHrVBdYQAgKcoGlmJs9aiM5C6UWhp32NTnOzPtD8kS.csv",
                "pdf": "https://cdn.synapsepay.com/uploads/2018/07/15/PFJ2VhjyQSxcGXg9f5uLq63beli0UOEMk0YHd8t7Z4RsaN1DnI.pdf"
            }
        },
        {
            ...
        }
    ],
    "statements_count": 2,
    "success": true
}

Statements by User


Get the statement for a user

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.