WePay logo
      Nothing Found

Get a notification

get/notifications/{id}

The GET /notifications/{id} call allows your platform to look up a notification. 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
path Parameters
id
required
string [ 1 .. 255 ] characters

ID of the notification, generated by WePay when the notification is created.

header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
id
required
string [ 1 .. 255 ] characters

ID of the notification, generated by WePay when the notification is created.

resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
notifications
path
required
string

The HTTP path of the resource. The path can be used to retrieve details about the resource and perform actions on it.

required
object

This owner resource and owner path of the object.

topic
required
string

Topic of the notification event.

event_time
required
integer <int64> >= 0

Indicates when a notification event was triggered.

required
object

Contains details of a notification's payload.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "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"
}