View all User Transactions

Transactions

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

This endpoint allows you to get all transactions 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,
   "success": true,
   "trans": [
      {
         "_id": "5fe9656638707c7ccff07747",
         "_v": 2,
         "amount": {
            "amount": 500.1,
            "currency": "USD"
         },
         "client": {
            "id": "589acd9ecb3cd400fa75ac06",
            "name": "SynapseFi"
         },
         "extra": {
            "asset": null,
            "created_on": 1609131366079,
            "group_id": null,
            "ip": "255.127.79.76",
            "latlon": "unknown,unknown",
            "location": {
               "address_city": null,
               "address_country_code": null,
               "address_postal_code": null,
               "address_subdivision": null,
               "lat": 0,
               "lon": 0
            },
            "note": "Test transaction",
            "other": {
               "affect_limits": true,
               "attachments": [],
               "chargeback_disputed": false,
               "dispute_form": null,
               "dispute_meta": {},
               "dispute_reason": null,
               "disputed": false,
               "is_provisional_credit": false
            },
            "process_on": 1609131366079,
            "rate": null,
            "rate_limit": null,
            "same_day": false,
            "settlement_delay": 0,
            "supp_id": "",
            "tracking_number": null
         },
         "fees": [
            {
               "fee": 0.5,
               "note": "Synapse Facilitator Fee",
               "to": {
                  "id": "55b3f8c686c2732b4c4e9df6"
               }
            }
         ],
         "from": {
            "id": null,
            "meta": {
               "account_number": "",
               "amount": "",
               "back_signature": false,
               "check_back": "",
               "check_front": "",
               "check_number": "",
               "check_quality_bucket_num": null,
               "front_signature": false,
               "is_check": true,
               "is_endorsed": false,
               "name": "",
               "original_check_back": "https://cdn.synapsepay.com/uploads/2020/12/28/K4yOZmVhBSYx0eFCkGjvnasWipblH1EAt62QTMcof0D8gLIwu7.gif",
               "original_check_front": "https://cdn.synapsepay.com/uploads/2020/12/28/gMuhZos8CR30am16N5jDELf9lAyHzbqUB0iSxKO7ncVwGXQIve.gif",
               "routing_number": ""
            },
            "nickname": null,
            "type": "RDC",
            "user": {
               "_id": null,
               "legal_names": []
            }
         },
         "recent_status": {
            "date": 1609131671606,
            "note": "Next",
            "status": "SETTLED",
            "status_id": "4"
         },
         "timeline": [
            {
               "date": 1609131366079,
               "note": "Transaction Created.",
               "status": "CREATED",
               "status_id": "1"
            },
            {
               "date": 1609131525193,
               "note": "Next",
               "status": "PROCESSING-DEBIT",
               "status_id": "2"
            },
            {
               "date": 1609131593564,
               "note": "Next",
               "status": "PROCESSING-CREDIT",
               "status_id": "3"
            },
            {
               "date": 1609131671606,
               "note": "Next",
               "status": "SETTLED",
               "status_id": "4"
            }
         ],
         "to": {
            "id": "5fe96562c54d7b7bcda9b9da",
            "nickname": "My Deposit Account",
            "type": "DEPOSIT-US",
            "user": {
               "_id": "5fe50a777562960078d3a5c6",
               "legal_names": [
                  "Test User"
               ]
            }
         }
      },
      {
         ...
      },
      ...
   ],
   "trans_count": 3
}

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/trans?page=1&per_page=2 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_ohpVj1iwMQgqHR0ATzbGEU4fBuXOJ0FWZk28y7cD|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

cURL

curl --location --request GET 'https://uat-api.synapsefi.com/v3.1/users/5fe50a777562960078d3a5c6/trans?page=1&per_page=2' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_ohpVj1iwMQgqHR0ATzbGEU4fBuXOJ0FWZk28y7cD|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json'

Python

//

JS

//

PHP

//

GO

//