Failed subscription payment webhook
When an subscription payment fails, an automation can be triggered. The subscription details can be sent to the endpoint of your choice
automationTrigger
string
Event type that triggered the webhook (failedSubscriptionPayment)
contactId
string (UUID)
Unique contact identifier
paymentDate
number (timestamp)
Date/time of the attempted payment
donorFirstName
string
Donor first name
donorDisplayName
string
Full donor name for display
string
Donor email address
receiptEmail
string
Email address for receipt delivery
donorPhoneNumber
string
Donor phone number
documentLanguage
string
Document language
donationCurrency
string
Currency of the donation
paymentType
string
Payment type
donationSum
number
Donation sum attempted
sum
number
Amount processed / registered in system
donationMethod
string
Donation method
campaignId
string
Campaign ID associated with donation
accountId
string
Account identifier
isInstallments
boolean
Whether donation is split into installments
managedExternally
boolean
Indicates if payment is handled externally
cancelled
boolean
Whether payment was cancelled
completed
boolean
Whether payment processing completed
status
string
Payment status
failedReason
string / null
Reason for failure if available
purchaseTitle
string
Transaction title
tz
string / null
Donor Israeli ID / company number
agentId
string
Agent handling the transaction
exchangeRate
number
Exchange rate applied
exchangeRateToUSD
number
Exchange rate to USD
paymentId
string (UUID)
Payment identifier
transactionId
string (UUID)
Transaction identifier
transactionDate
number (timestamp)
Transaction date/time
transactionRef
string / null
Transaction reference
transactionResult
string / null
Transaction result
paymentMethodId
string (UUID)
Payment method identifier
paymentMethodSource
string
Source of the payment method
masavBusinessName
string
MASAV business name
externalReceiptCreated
boolean
Whether an external receipt was generated
receiptSendMethod
string
Method for sending receipt (
cc4dig
string / null
Last 4 digits of card, if relevant
partition
string
Internal partition key
paypalSubscriptionId
string / null
PayPal subscription ID
paypalOrderId
string / null
PayPal order ID
SK1
string
Internal status key
incomes
array
List of income breakdown objects
futureCommitment
boolean
Indicates a future commitment pledge
externalSubscriptionId
string / null
External subscription identifier
requiresTracking
boolean
Whether tracking is required
isFormSubmission
boolean
Whether this was a form submission
createReceipt
boolean
Whether to generate a receipt
source
string
Source of payment in system
donorNameInBank
string
Donor name as appears in bank
splitAccountV2
string / null
Internal split account reference
chargeDay
number / null
Scheduled charge day
backend
boolean
Internal backend flag
paymentCategory
string
Category of payment
Last updated