WePay logo
      Nothing Found

Get a collection of notifications

get/notifications

The GET /notifications call allows your platform to look up a collection of notifications. The notifications resource allows your platform to retrieve details on a specific notification or a collection of notifications. Your platform can utilize notifications to gain insight into WePay’s system, communicate with your users, monitor issues, etc.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
page
string

Return elements from this page.

page_size
integer [ 1 .. 50 ]
Default: 10

Return no more than this many elements per page. If not specified, page_size defaults to 10. Maximum value allowed is 50.

object_type
string

The scope type of a notification. Acceptable values are WePay API resources, related to the notification topic. For example ,payments, payment_methods, accounts, legal_entities, refunds, disputes etc.

object_id
string

The scope ID of a notification, related to the object_type.

event_time_start
integer <int64> >= 0

Event time indicates when a notification event was triggered. TThis parameter will set the timestamp for the start of the search window.

event_time_end
integer <int64> >= 0

Event time indicates when a notification event was triggered. This parameter will set the timestamp for the end of the search window.

header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
required
Array of objects unique

An array of notification results.

previous
required
string or null

An opaque path for the previous page of results. Perform an HTTP GET to obtain the previous page.

next
required
string or null

An opaque path for the next page of results. Perform an HTTP GET to obtain the next page.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": "/notifications?page=0f3ef5b0-625d-4a80-9f5a-80bc0959fef7",
  • "previous": null,
  • "api_version": "3.0",
  • "results": [
    • {
      • "event_time": 1511307578,
      • "id": "aceecf2c-e432-4aac-90a3-8f3b7fbb6420",
      • "owner": {
        • "id": "171845",
        • "path": null,
        • "resource": "applications"
        },
      • "path": "/notifications/aceecf2c-e432-4aac-90a3-8f3b7fbb6420",
      • "payload": {
        • "amount": 4200,
        • "auto_capture": true,
        • "create_time": 1511307571,
        • "currency": "",
        • "custom_data": null,
        • "failure_reason": null,
        • "fee_amount": 0,
        • "id": "00000000-0000-0000-0000-00000c42a66e",
        • "owner": {
          • "id": "40200612-e849-4172-8308-657cf3a0de27",
          • "path": "/accounts/40200612-e849-4172-8308-657cf3a0de27",
          • "resource": "accounts"
          },
        • "path": "/payments/00000000-0000-0000-0000-00000c42a66e",
        • "payment_method": {
          • "id": "00000000-6363-0000-0000-0000052023f3",
          • "path": "/payment_methods/00000000-6363-0000-0000-0000052023f3",
          • "resource": "payment_methods"
          },
        • "pending_reasons": null,
        • "resource": "payments",
        • "status": "completed",
        • "txnr_app_fee": null,
        • "txnr_merchant": null
        },
      • "resource": "notifications",
      • "topic": "payments.completed",
      • "api_version": "3.0"
      },
    • {
      • "event_time": 1511307573,
      • "id": "5fcfaa99-3193-482f-b3f4-4f0f4fe30d65",
      • "owner": {
        • "id": "171845",
        • "path": null,
        • "resource": "applications"
        },
      • "path": "/notifications/5fcfaa99-3193-482f-b3f4-4f0f4fe30d65",
      • "payload": {
        • "amount": 4200,
        • "auto_capture": true,
        • "create_time": 1511307571,
        • "currency": "",
        • "custom_data": null,
        • "failure_reason": null,
        • "fee_amount": 0,
        • "id": "00000000-0000-0000-0000-00000c42a66e",
        • "owner": {
          • "id": "40200612-e849-4172-8308-657cf3a0de27",
          • "path": "/accounts/40200612-e849-4172-8308-657cf3a0de27",
          • "resource": "accounts"
          },
        • "path": "/payments/00000000-0000-0000-0000-00000c42a66e",
        • "payment_method": {
          • "id": "00000000-6363-0000-0000-0000052023f3",
          • "path": "/payment_methods/00000000-6363-0000-0000-0000052023f3",
          • "resource": "payment_methods"
          },
        • "pending_reasons": null,
        • "resource": "payments",
        • "status": "completed",
        • "txnr_app_fee": null,
        • "txnr_merchant": null
        },
      • "resource": "notifications",
      • "topic": "payments.completed",
      • "api_version": "3.0"
      }
    ]
}