Payment Webhook

The payment webhook notifies your endpoint whenever a new payment or form submission is created in the system. To configure the webhook, navigate to Settings → Developer Tools and provide your endpoint URL.

Note: A payment object represents the total amount paid by the payer. For recurring payments, a single event will be sent reflecting the full amount at the time the payment is created.

Parameters

Information Inputted By The User

Parameter	Values	Description
pch_firstName	string	The first name of the person who made the payment
pch_lastName	string	The last name of the person who made the payment
pch_city	string	The city name of the person who made the payment
pch_street	string	The street name of the person who made the payment
pch_streetNumber	string	The house/building number of the person who made the payment
pch_aptNumber	string	The apartment/unit number of the person who made the payment
pch_zipCode	string	The area zip code of the person who made the payment
pch_personalDedication	string	A personal dedication message associated with the payment or donation
pch_displayName	string	The name provided to be displayed on the website publicly
pch_email	string	The email address of the person who made the payment
pch_receiptEmail	string	The email address to be used for sending the payment receipt
pch_phoneNumber	string	The phone number of the person who made the payment

System Fields

Parameter	Values	Description
pch_paymentId	string	A unique payment ID linked to this payment
pch_accountId	string	A unique account ID linked to the organization
pch_campaignId	string	A unique campaign ID linked to the campaign through which this payment was made
pch_contactId	string	A unique contact ID linked to the contact who made the payment
pch_importId	string	A unique import ID linked to the import from which this payment was imported
pch_agentId	string	A unique agent ID through whom this payment was made (empty if the payment was not made through an agent)
pch_marketingCampaignId	string	If the payment was made through a link that was sent in a marketing campaign, this will contain the unique marketing campaign ID
pch_donationTotalSum	float	Total sum of all transactions in the payment
pch_donationTransactionSum	float	Sum to be charged in the each transaction Note: will be equal to to pch_donationTotalSum if it is not a recurring payment.
pch_exchangeRate	float	The exchange rate of the payment relative to NIS
pch_donationCurrency	string	The currency that the payment was made in
pch_splitAcrossMonths	integer	Total number of months to split payment across
pch_isRecurringPayment	boolean	True if the payment is recurring. False if the payment is a one time payment.
pch_managedExternally	boolean	True if the payment was not made through PEACH (was imported has historic payment)
pch_donationMethod	string	Method through which this payment was made (e.g. Stripe, Tranzilla, Manual etc.)
pch_paymentType	string	Type of payment (such as Credit Card, Bank Transfer, Offline etc.)
pch_cancelled	boolean	True if the payment was cancelled.
pch_receiptUrl	string	URL to the receipt from the payment
pch_receiptNumber	string	The receipt number assigned to the receipt
pch_updatedByUserId	string	The user ID of the user that made the most recent update to the payment object
pch_purchaseTitle	string	The receipt product text (e.g. Donation, Payment)
pch_customProperties	Object	Custom properties that the organization added manually
pch_createdAt	integer	When the payment object was created, saved as a Unix timestamp
pch_updatedAt	integer	The last time the payment object was updated, saved as a Unix timestamp
pch_paymentDate	integer	When the payment occurred, saved as a Unix timestamp
pch_scheduleDate	integer	The scheduled date for the next transaction (if there exist any future transactions), saved as a Unix timestamp
pch_voucher	string	Voucher that was used with this payment
pch_sumPreVoucher	float	The sum of the payment before the voucher was applied
pch_status	string	The payment status. Can be one of the following values: processed, failed, scheduled, requiresAction, awaitingConfirmed, canceled
pch_storedBillingMethod	Object	Object containing billing method information
pch_bank	string	Bank from which a bank transfer was made
pch_bankName	string	Contact's name as registered in bank from which a bank transfer was made
pch_bankBranch	string	Bank branch from which a bank transfer was made
pch_bankAccount	string	Bank account number from which a bank transfer was made
pch_chequeNumber	string	Cheque number for a payment that was made through a cheque
pch_otherDescription	string	Description information for the receipt
pch_receiptLang	string	The language that the receipt is in
pch_nextBillingCycle	integer	next transaction number from this payment
pch_endDate	integer	The end date of a recurring payment, saved as a Unix timestamp
pch_isInstallments	boolean	True if the payment is with installments
pch_failedReason	string	Error code