Omni API

Form Configuration

The Hosted Payment Form supports configuration options that allow you to customize its appearance and behavior. Use the formConfig object in your API requests to control how the payment form collects billing information.

Billing Information Capture Levels

The billingInfoCaptureLevel property controls how much billing information is collected from the customer. There are two options:
  • Full (Default) - Collects complete billing address including street address, city, state, country, and ZIP/postal code. This is the default if no formConfig is specified.
  • Minimal - Collects only the ZIP/postal code, displayed inline with the card fields for a streamlined checkout experience.

Full Billing Mode (Default)

When billingInfoCaptureLevel is set to Full (or when no formConfig is provided), the form displays complete billing address fields:

Hosted Payment Form - Full Billing Full billing mode collects complete address information

Compact Form Mode (Minimal Billing)

When billingInfoCaptureLevel is set to Minimal, the form displays a compact layout with only the ZIP/postal code field shown inline with the card fields:

Hosted Payment Form - Compact/Minimal Billing Compact form mode with minimal billing (ZIP code only)

This compact form is ideal for scenarios where:

  • You want to minimize friction in the checkout process
  • Full address information is not required for your business needs
  • You're processing card-not-present transactions where basic AVS (ZIP code) verification is sufficient

Usage Example

Include the formConfig object in your request to customize the form:

```json { "amount": 1000, "paymentMethodId": "pmt_vrt_01JRZPTWS99Z7RB57Q1CVWSWDS", "invoiceNumber": "inv_12345", "formConfig": { "billingInfoCaptureLevel": "Minimal" } } ```

ACH Payment Method Restrictions

Important: ACH payment methods always require full billing information. The Minimal billing capture level is not supported for ACH transactions. If you attempt to use billingInfoCaptureLevel: Minimal with an ACH payment method, the request will be rejected with a validation error.

Form Configuration Properties

Property Type Default Description
billingInfoCaptureLevel string Full Controls billing information collection. Values: Full, Minimal