> For the complete documentation index, see [llms.txt](https://peach-organization.gitbook.io/peach/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://peach-organization.gitbook.io/peach/webhooks/payment-webhook.md).

# 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

<table><thead><tr><th>Parameter</th><th>Values</th><th>Description</th></tr></thead><tbody><tr><td><pre class="language-javascript"><code class="lang-javascript">pch_firstName
</code></pre></td><td>string</td><td>The first name of the person who made the payment</td></tr><tr><td><pre class="language-javascript"><code class="lang-javascript">pch_lastName
</code></pre></td><td>string</td><td>The last name of the person who made the payment</td></tr><tr><td><pre class="language-javascript"><code class="lang-javascript">pch_city
</code></pre></td><td>string</td><td>The city name of the person who made the payment</td></tr><tr><td><pre class="language-javascript"><code class="lang-javascript">pch_street
</code></pre></td><td>string</td><td>The street name of the person who made the payment</td></tr><tr><td><pre class="language-javascript"><code class="lang-javascript">pch_streetNumber
</code></pre></td><td>string</td><td>The house/building number of the person who made the payment</td></tr><tr><td><pre class="language-javascript"><code class="lang-javascript">pch_aptNumber
</code></pre></td><td>string</td><td>The apartment/unit number of the person who made the payment</td></tr><tr><td><pre class="language-javascript"><code class="lang-javascript">pch_zipCode
</code></pre></td><td>string</td><td>The area zip code of the person who made the payment</td></tr><tr><td><pre class="language-javascript"><code class="lang-javascript">pch_personalDedication
</code></pre></td><td>string</td><td>A personal dedication message associated with the payment or donation</td></tr><tr><td><pre class="language-javascript"><code class="lang-javascript">pch_displayName
</code></pre></td><td>string</td><td>The name provided to be displayed on the website publicly</td></tr><tr><td><pre class="language-javascript"><code class="lang-javascript">pch_email
</code></pre></td><td>string</td><td>The email address of the person who made the payment</td></tr><tr><td><pre class="language-javascript"><code class="lang-javascript">pch_receiptEmail
</code></pre></td><td>string</td><td>The email address to be used for sending the payment receipt</td></tr><tr><td><pre class="language-javascript"><code class="lang-javascript"><strong>pch_phoneNumber
</strong></code></pre></td><td>string</td><td>The phone number of the person who made the payment</td></tr><tr><td><pre><code><strong>pch_tz
</strong></code></pre></td><td>string</td><td>The payer’s official identification number — national ID for individuals or company registration number for organizations.</td></tr></tbody></table>

#### System Fields

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://peach-organization.gitbook.io/peach/webhooks/payment-webhook.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.