Payment Webhook
Parameters
Information Inputted By The User
string
The first name of the person who made the payment
string
The last name of the person who made the payment
string
The city name of the person who made the payment
string
The street name of the person who made the payment
string
The house/building number of the person who made the payment
string
The apartment/unit number of the person who made the payment
string
The area zip code of the person who made the payment
string
A personal dedication message associated with the payment or donation
string
The name provided to be displayed on the website publicly
string
The email address of the person who made the payment
string
The email address to be used for sending the payment receipt
string
The phone number of the person who made the payment
System Fields
string
A unique payment ID linked to this payment
string
A unique account ID linked to the organization
string
A unique campaign ID linked to the campaign through which this payment was made
string
A unique contact ID linked to the contact who made the payment
string
A unique import ID linked to the import from which this payment was imported
string
A unique agent ID through whom this payment was made (empty if the payment was not made through an agent)
string
If the payment was made through a link that was sent in a marketing campaign, this will contain the unique marketing campaign ID
float
Total sum of all transactions in the payment
float
Sum to be charged in the each transaction Note: will be equal to to pch_donationTotalSum if it is not a recurring payment.
float
The exchange rate of the payment relative to NIS
string
The currency that the payment was made in
integer
Total number of months to split payment across
boolean
True if the payment is recurring. False if the payment is a one time payment.
boolean
True if the payment was not made through PEACH (was imported has historic payment)
string
Method through which this payment was made (e.g. Stripe, Tranzilla, Manual etc.)
string
Type of payment (such as Credit Card, Bank Transfer, Offline etc.)
boolean
True if the payment was cancelled.
string
URL to the receipt from the payment
string
The receipt number assigned to the receipt
string
The user ID of the user that made the most recent update to the payment object
string
The receipt product text (e.g. Donation, Payment)
Object
Custom properties that the organization added manually
integer
When the payment object was created, saved as a Unix timestamp
integer
The last time the payment object was updated, saved as a Unix timestamp
integer
When the payment occurred, saved as a Unix timestamp
integer
The scheduled date for the next transaction (if there exist any future transactions), saved as a Unix timestamp
string
Voucher that was used with this payment
float
The sum of the payment before the voucher was applied
string
The payment status. Can be one of the following values: processed, failed, scheduled, requiresAction, awaitingConfirmed, canceled
Object
Object containing billing method information
string
Bank from which a bank transfer was made
string
Contact's name as registered in bank from which a bank transfer was made
string
Bank branch from which a bank transfer was made
string
Bank account number from which a bank transfer was made
string
Cheque number for a payment that was made through a cheque
string
Description information for the receipt
string
The language that the receipt is in
integer
next transaction number from this payment
integer
The end date of a recurring payment, saved as a Unix timestamp
boolean
True if the payment is with installments
string
Error code
Last updated