Use the optional prePopulate object in a payment session to pre-fill non-sensitive customer contact and billing details on Hosted Payment Forms and reduce checkout friction.

When you create a payment session for Hosted Payment Form (HPF), you can optionally send customer data that should already appear on the form. This helps reduce checkout friction because customers do not need to re-enter information you already have.

You can pre-populate the following non-sensitive fields:

• Email address
• Phone number
• Billing address, including country, state, city, address line 1, address line 2, and zip code

To pre-populate these fields, include the optional prePopulate object in your CreatePaymentSession request.

Each field supports:

• value to specify the value displayed on the form
• visible to control whether the field is shown to the payer

If you set visible to false, the field is hidden on the form but the value is still submitted with the payment.

If you do not provide prePopulate, your existing integration continues to work without changes.

Supported payment methods

Pre-populated customer data is supported only for these payment methods which support the collection of this additional data:

• Credit Card
• ACH
• SEPA Direct Debit
• BACS Direct Debit
• PAD