Notifications

Get Notifications per Integration Source by PaymentId or PaymentExternalId

get

Query parameters

paymentIdinteger · int32Optional

paymentExternalIdstringOptional

Header parameters

AccessTokenstringRequired

access token

Responses

200

Returns all Notifications by PaymentId or PaymentExternalId

application/json

400

Bad Request

application/json

404

If the Notifications are not found

application/json

get

/api/notifications

HTTPcURLJavaScriptPython

GET /api/notifications HTTP/1.1
AccessToken: text
Accept: */*

[
  {
    "NotificationId": 1,
    "NotificationGuid": "123e4567-e89b-12d3-a456-426614174000",
    "NotificationConfigId": 1,
    "CreatedDate": "2026-01-27T17:52:31.364Z",
    "ModifiedDate": "2026-01-27T17:52:31.364Z",
    "Payload": "text",
    "RetryCount": 1,
    "Postdate": "2026-01-27T17:52:31.364Z",
    "NotificationStatus": 1,
    "NotificationUrl": "text",
    "PaymentId": 1,
    "PaymentExternalId": "text"
  }
]

Used to test sending over a transaction notification payload to the notification url endpoint configured per an Integration Source

post

Parameters:

Url - Integration Source endpoint to post payload to. Example: https://{yourenvironment.yourdomain}.com/api/yourNotification endpoint

Payload - test payload posting over to Url

AccessToken - optional if access token needed to hit notification url

Example notification payload sent out for transaction status: { "paymentId": 1088, "paymentGuid": "e511a3db-390d-487c-b06b-563fdfe80178", "paymentDate": "2019-05-22T00:42:12.39", "paymentExternalId": "19228326", "recurringProfileId": null, "processStatus": 2, possible values: NotProcessed = 1 "Not Processed", Authorized = 2 "Awaiting Authorization", Settled = 4 "Authorized", Rejected = 5 "Rejected", RefundRequired = 6 "Refund Required", AwaitingRefund = 7 "Awaiting Refund", Refunded = 8 "Refunded", Cancelled = 9 "Cancelled", Chargeback = 10 "Chargeback", RefundRejected = 11 "Refund Rejected" "processStatusValue": "Awaiting Authorization", "paymentResult": 3, possible values: Pending = 1, Processing = 2, Successful = 3, Failed = 4, Refunded = 5, Cancelled = 6 "paymentResultValue": "Successful", "amount": 215.13, "distributionType": null, possible values: "Direct Deposit" or "Check" "distributionTypeValue": null, possible values: 1 - Direct Deposit or 2 - Check "distributionStatus": "Processing", possible values: "Processing" or "Settled" "sourceGuid": "936525b5-9ad5-4a14-bda6-436c9da9057b", "sourceName": "Firstgiving", "organizationGuid": "246a8894-40f8-46e7-97c1-858a7c6dc408", "organizationName": "ST ANDREWS SCHOOL", "ein": "050262717", "salesforceAccountId": null, "fgExternalId": null, "bfgExternalId": null, "artezExternalId": null, "artezInstanceGuid": null, "firstName": "test", "lastName": "testing", "email": "[email protected]", "cardHolderName": "testig", "ccLastDigits": "1111", "ccType": "Visa", "paymentLines": [ { "paymentLineId": 1114, "paymentId": 1088, "createdDate": "2019-05-22T00:42:33.823", "modifiedDate": null, "isDeleted": false, "amount": 100, "cardFeeAmount": 2.78, "commissionAmount": 8.25, "payFee": true }, { "paymentLineId": 1115, "paymentId": 1088, "createdDate": "2019-05-22T00:42:33.823", "modifiedDate": null, "isDeleted": false, "amount": 100, "cardFeeAmount": 2.6, "commissionAmount": 1.5, "payFee": true } ] }

Query parameters

urlstringOptional

payloadstringOptional

accessTokenstringOptional

Header parameters

AccessTokenstringRequired

access token

Responses

200

Success

No content

400

Failure

application/json

post

/api/notificationTest

HTTPcURLJavaScriptPython

POST /api/notificationTest HTTP/1.1
AccessToken: text
Accept: */*

No content

Save Notification Configurations per an Integration Source

put

Header parameters

AccessTokenstringRequired

access token

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

IntegrationSourceGuidstring · nullableOptional

internal use - Identifies integrated Product

Responses

200

Returns saved notification config

application/json

400

If the notification config are not saved

application/json

404

Not Found

application/json

put

/api/notificationConfig

HTTPcURLJavaScriptPython

PUT /api/notificationConfig HTTP/1.1
AccessToken: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 290

{
  "IntegrationSourceGuid": "text",
  "NotificationConfigs": [
    {
      "NotificationConfigurationTypeId": "text",
      "NotificationProtocolTypeId": "text",
      "NotificationUrl": "text",
      "NotificationEmailFrom": "[email protected]",
      "NotificationEmailTo": "[email protected]",
      "Retries": 1,
      "AccessToken": "text",
      "IsDeleted": true
    }
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

[
  {
    "NotificationConfigId": 1,
    "NotificationConfigType": 1,
    "NotificationProtocolType": 1,
    "IntegrationSourceId": 1,
    "NotificationUrl": "text",
    "NotificationEmailTo": "text",
    "NotificationEmailFrom": "text",
    "AccessToken": "text",
    "Retries": 1,
    "CreatedDate": "2026-01-27T17:52:31.364Z",
    "ModifiedDate": "2026-01-27T17:52:31.364Z",
    "IsDeleted": true
  }
]