View Webhook Logs

View webhook Logs

GET https://api.synapsefi.com/v3.1/subscriptions/logs

This endpoint allows you to view subscription logs.

Query Parameters

Name	Type	Description
page	integer	Page number
per_page	integer	Number of logs per page

Headers

Name	Type	Description
X-SP-GATEWAY	string	Your Client ID & Secret, separated by a pipe

200 Subscription logs successfully retrieved.

{
  "error_code": "0",
  "http_code": "200",
  "limit": 20,
  "logs": [
    {
      "_id": {
        "$oid": "5e56fa05d03ead769a92a9e6"
      },
      "client_id": "5d76ce618b200d0065333ea1",
      "date": 1582758405055,
      "function": "NODE|PATCH",
      "http_response_code": "200",
      "http_response_text": "1582758405733-6805281697306",
      "http_responses": [
        {
          "date": 1582758405775,
          "http_response_code": "200",
          "http_response_text": "1582758405733-6805281697306",
          "http_url": "https://postb.in/1582757979813-9249319576192"
        }
      ],
      "http_url": "https://postb.in/1582757979813-9249319576192",
      "obj_id": "NODE_5e56d1a5c2e6f3013abf5dc6",
      "safe_obj": {
        "_id": {
          "$oid": "5e56d1a5c2e6f3013abf5dc6"
        },
        "_rest": {
          "_id": "5e56d1a5c2e6f3013abf5dc6",
          "allowed": "CREDIT-AND-DEBIT",
          "client": {
            "id": "5d76ce618b200d0065333ea1",
            "name": "Test User"
          },
          "extra": {
            "note": null,
            "other": {
              "access_token": "5e56fa035834d0004a8aafdb",
              "micro_meta": {
                "micro_attempts": 0,
                "micro_sent_count": 0,
                "skip_micro": false
              },
              "updated_on": 1582758404000
            },
            "supp_id": ""
          },
          "info": {
            "account_num": "8901",
            "address": "P.O. BOX 85139, RICHMOND, VA, US",
            "balance": {
              "amount": "800.00",
              "currency": "USD",
              "updated_on": 1582758404000
            },
            "bank_code": "capone",
            "bank_hlogo": "https://cdn.synapsepay.com/bank_logos_v3p1/CapitalOne360_h.png",
            "bank_logo": "https://cdn.synapsepay.com/bank_logos_v3p1/CapitalOne360_v.png",
            "bank_long_name": "CAPITAL ONE N A ",
            "bank_name": "CAPITAL ONE N A ",
            "bank_url": "http://www.capitalone.com",
            "class": "CHECKING",
            "match_info": {
              "email_match": "no_match",
              "name_match": "no_match",
              "phonenumber_match": "no_match"
            },
            "name_on_account": " ",
            "nickname": "SynapsePay Test Checking Account - 8901",
            "routing_num": "0407",
            "type": "BUSINESS"
          },
          "is_active": true,
          "timeline": [
            {
              "date": 1582748068691,
              "note": "Node created."
            },
            {
              "date": 1582748069313,
              "note": "node_not_credit -- Unable to send micro deposits as node allowed is not CREDIT."
            },
            {
              "date": 1582757444913,
              "note": "Node's 'is_active' toggled to True."
            }
          ],
          "type": "ACH-US",
          "user_id": "5e56d17a5b5a1e0081e0d9c6"
        },
        "allowed": "CREDIT-AND-DEBIT",
        "client": {
          "id": "5d76ce618b200d0065333ea1",
          "name": "Test Client"
        },
        "extra": {
          "note": null,
          "supp_id": ""
        },
        "info": {
          "account_num": "8901",
          "address": "P.O. BOX 85139, RICHMOND, VA, US",
          "balance": {
            "amount": "800.00",
            "currency": "USD"
          },
          "bank_code": "capone",
          "bank_hlogo": "https://cdn.synapsepay.com/bank_logos_v3p1/CapitalOne360_h.png",
          "bank_logo": "https://cdn.synapsepay.com/bank_logos_v3p1/CapitalOne360_v.png",
          "bank_long_name": "CAPITAL ONE N A ",
          "bank_name": "CAPITAL ONE N A ",
          "bank_url": "http://www.capitalone.com",
          "class": "CHECKING",
          "match_info": {
            "email_match": "no_match",
            "name_match": "no_match",
            "phonenumber_match": "no_match"
          },
          "name_on_account": " ",
          "nickname": "SynapsePay Test Checking Account - 8901",
          "routing_num": "0407",
          "type": "BUSINESS"
        },
        "is_active": true,
        "timeline": [
          {
            "date": {
              "$date": 1582748068691
            },
            "note": "Node created."
          },
          {
            "date": {
              "$date": 1582748069313
            },
            "note": "node_not_credit -- Unable to send micro deposits as node allowed is not CREDIT."
          },
          {
            "date": {
              "$date": 1582757444913
            },
            "note": "Node's 'is_active' toggled to True."
          }
        ],
        "type": "ACH-US",
        "user_id": "5e56d17a5b5a1e0081e0d9c6",
        "webhook_meta": {
          "date": {
            "$date": 1582758405055
          },
          "function": "NODE|PATCH",
          "log_id": "5e56fa05d03ead769a92a9e6",
          "updated_by": "SELF"
        }
      },
      "safe_obj_hash": "5e2c44aa373afc38b31d6f525407cef2de4c3877b93dbb8204ef78b2822d0bef",
      "updated_by": "SELF"
    },
    {
      ...
    }
  ],
  "logs_count": 2,
  "page": 1,
  "page_count": 2,
  "success": true
}

400 Unable to retrieve subscription logs.

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

Webhook Log Expiration Webhook logs expire 15 days from date of creation.

Example Request

HTTP

GET /v3.1/subscriptions/logs HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW

Python

allsublogs = client.webhook_logs()

JavaScript

client.getWebhookLogs();

Ruby

client.webhook_logs()

PHP

$client->get_webhook_logs()

Go

data, err := client.GetWebhookLogs()