> 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/iframe-integration.md).

# Iframe Integration

### Iframe URL

#### <https://www.peach-in.com/cmp/iframe/{urlId}> <a href="#undefined" id="undefined"></a>

### Example

```
<iframe src="https://www.peach-in.com/cmp/iframe/{urlId}" height="100%" width="100%" />
```

{% hint style="info" %}
Customize the height and width according to your needs
{% endhint %}

##

#### The above URL will display the campaign payment flow as it is configured in the [campaign settings](https://www.peach-in.com/portal/campaigns) <a href="#undefined" id="undefined"></a>

#### You can customize the flow by passing in URL params  <a href="#undefined" id="undefined"></a>

{% hint style="info" %}
Note: All field values must be valid according to the validation rules set in the campaign fields section
{% endhint %}

#### Parameters

<table><thead><tr><th width="211.33333333333331">Parameter</th><th>Values</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><code>sum</code></td><td>integer <br></td><td>No</td><td><p></p><p>Sets payment sum, By setting this, the first step of the payment flow will be skipped</p></td></tr><tr><td>recurring</td><td>true</td><td>No</td><td><p>Sets the payment as recurring. If <code>months</code> is not specified, the payment will recur until canceled. Applicable only to recurring payments;   </p><p>Not supported for installments.</p></td></tr><tr><td>months</td><td>integer<br></td><td>No</td><td>Sets the amount of billing  cycles for the payment.<br><br>Not supported for installments.</td></tr><tr><td>webhook</td><td>Valid URL</td><td>No</td><td>Webhook URL to send payment info on successful payment </td></tr><tr><td>redirect_url</td><td>Valid URL</td><td>No</td><td>URL to redirect user after successful payment</td></tr><tr><td>skip_input</td><td>true</td><td>No</td><td>Skips to last step of the payment flow <br><br>If set to <code>true</code>, you must pass in <code>first_name</code>, <code>last_name</code>,<br><code>sum</code>,<br><code>email</code>, and <code>telephone</code> </td></tr><tr><td>first_name </td><td>string</td><td>Required if skip_input is true</td><td></td></tr><tr><td>last_name</td><td>string</td><td>Required if skip_input is true</td><td></td></tr><tr><td>telephone</td><td>string</td><td>Required if skip_input is true</td><td></td></tr><tr><td>email</td><td>string</td><td>Required if skip_input is true</td><td></td></tr><tr><td>back_url</td><td>Valid URL</td><td>No</td><td>if validation does not pass you can define a URL for user to be redirected to when clicking back.<br>Defaults to previous page </td></tr><tr><td>hide_back_button</td><td>true</td><td>No</td><td>Hides the back button on failed validation page </td></tr><tr><td>show_bit</td><td>true</td><td>No</td><td>Sets the default payment option on the last section to bit</td></tr><tr><td>currency</td><td>string</td><td>No</td><td><p>Sets the default currency if it is supported by the campaign</p><p><br>Valid options: "ILS", "USD", "EUR", "GBP"</p></td></tr></tbody></table>

### Custom Properties

To set custom properties use the internal name of your property&#x20;