search

Notifications

hashtag
Get Notifications History per Integration Source by PaymentId or PaymentExternalId

get
Query parameters
paymentIdinteger · int32Optional
paymentExternalIdstringOptional
Header parameters
AccessTokenstringRequired

access token

Responses
chevron-right
200

Returns all Notifications history by PaymentId or PaymentExternalId

application/json
NotificationIdinteger · int32Optional

Notification Id

NotificationGuidstring · uuidOptional

Unique Notification identifier

NotificationConfigIdinteger · int32Optional

Notification Configuration Id set up per Integration Source

CreatedDatestring · date-timeOptional

Notification Created date

ModifiedDatestring · date-time · nullableOptional
Payloadstring · nullableOptional

Notification payload sent out for transaction status

RetryCountinteger · int32 · nullableOptional

Number of retry attempts to send Notification payload to configured Notification URL

Postdatestring · date-time · nullableOptional

if available - the date the Notification was posted to configured Notification URL successfully

NotificationStatusinteger · enumOptionalPossible values:
NotificationUrlstring · nullableOptional

Url configure to post notifications to. The Integration Source endpoint to post notification payload to.

PaymentIdinteger · int32 · nullableOptional

Payment API PaymentId associated with the Notification

PaymentExternalIdstring · nullableOptional

Payment API PaymentExternalId associated with the Notification

get
/api/notifications

hashtag
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

AccessToken - optional if access token needed to hit notification url

Payload - test payload posting over to Url

Example notification test with payload sent out for transaction status:

POST /api/notificationTest
{
  ?Url = "", // your URL to post notification to.
  AccessToken=testToken, // optional if required to hit notification URL.
  Payload = {
  "PaymentId": 55514,
  "PaymentGuid": "4f2835cb-1afe-482b-aea6-bf6ea7061828",
  "PaymentDate": "2026-01-20T15:20:07.948",
  "PaymentExternalId": "19498411",
  "OriginalExternalID": "19498411",
  "RecurringProfileId": null,
  "RecurringProfileGuid": null,
  "NextBillDate": 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": 105.53,
  "DistributionType": null, // possible values: null, or "Direct Deposit" or "Check"
  "DistributionTypeValue": null, // possible values: null, or 1 - Direct Deposit or 2 - Check
  "DistributionStatus": "Processing", possible values: null, or "Processing", "Settled", "Refunded", "Voided"
  "DistributionId": null,
  "SourceGuid": "12345678-9012-1234-5678-123456789012",
  "SourceName": "DonationForm",
  "CharityId": null,
  "OrganizationGuid": "12345678-9012-1234-5678-123456789012",
  "OrganizationName": "TEST SOCIETY",
  "Ein": "00-0000000",
  "SalesforceAccountId": null,
  "FgExternalId": null,
  "BfgExternalId": null,
  "ArtezExternalId": null,
  "ArtezInstanceGuid": null,
  "ExternalConstituentId": null,
  "FirstName": "TEST",
  "LastName": "NAME",
  "Email": "[email protected]",
  "CardHolderName": "Test name",
  "CCLastDigits": "2222",
  "CCType": "Visa",
  "IpAddress": "127.0.0.1",
  "ExternalEventId": "9922",
  "ExternalEventGuid": null,
  "ExternalEventName": null,
  "ShippingFee": 0,
  "TaxableBenefit": 0,
  "TranId": "885ecade-735c-4b8c-9cfd-2870ebca049f",
  "Tip": 0,
  "VoidRequestDate": null,
  "VoidReason": null,
  "RefundRequestDate": null,
  "RefundReason": null,
  "ProcessorId": 1,
  "ProcessorGuid": "12345678-9012-1234-5678-123456789012",
  "PaymentMethodTypeId": 3,
  "Surcharge": null,
  "IsSurchargeEligible": false,
  "CheckLastDigits": null,
  "CheckNumber": null,
  "CheckTypeId": null,
  "CheckAccountTypeId": null,
  "FsApplicationFee": null,
  "EpfSessionId": "c2bdd62b-0f22-45fe-83f6-119a24e54f82",
  "PaymentLines": [
    {
      "PaymentLineId": 50256,
      "PaymentId": 55514,
      "CreatedDate": "2026-01-20T15:20:09.5520567Z",
      "ModifiedDate": "2026-01-20T15:20:09.45",
      "IsDeleted": false,
      "Amount": 100,
      "CardFeeAmount": 3.49,
      "CardTypeFeeAmount": 0,
      "CommissionAmount": 1.5,
      "PayFee": true,
      "TransactionSourceGroupId": 1,
      "CardFeeRate": 3.49,
      "TotalCommissionRate": 1.5,
      "TotalCommissionAmount": 1.5,
      "PartnerCommissionRate": 0,
      "PartnerCommissionAmount": 0,
      "FsCommissionRate": 1.5,
      "FsCommissionAmount": 1.5,
      "TotalFees": 5.53,
      "PerTransFee": 0.35,
      "ExternalLineId": null,
      "Tip": 0,
      "CommissionRateOverride": null,
      "CardFeeOnFeeAmount": 0.19,
      "Tax": 0
    }
  ]
}
}
Query parameters
urlstringOptional
payloadstringOptional
accessTokenstringOptional
Header parameters
AccessTokenstringRequired

access token

Responses
chevron-right
200

Success

No content
post
/api/notificationTest
No content

hashtag
Save Notification Configurations per an Integration Source

put
Header parameters
AccessTokenstringRequired

access token

Body
IntegrationSourceGuidstring · nullableOptional

internal use - Identifies integrated Product

Responses
chevron-right
200

Returns saved notification config

application/json
NotificationConfigIdinteger · int32Optional
NotificationConfigTypeinteger · enumOptionalPossible values:
NotificationProtocolTypeinteger · enumOptionalPossible values:
IntegrationSourceIdinteger · int32Optional
NotificationUrlstring · nullableOptional
NotificationEmailTostring · nullableOptional
NotificationEmailFromstring · nullableOptional
AccessTokenstring · nullableOptional
Retriesinteger · int32Optional
CreatedDatestring · date-timeOptional
ModifiedDatestring · date-time · nullableOptional
IsDeletedbooleanOptional
put
/api/notificationConfig
PreviousFeesNextRecurring Contracts

Last updated