Skip to main content

Optional Address

The optional address feature allows merchants to process payments without requiring the customer's full billing address. When enabled, only the billing country is mandatory.

When to Use Optional Address​

Use this feature when merchants do not collect a full billing address from the customer but still need to process payments.

Enabling Optional Address​

Optional address is an account-level configuration and must be configured on the merchant account before it can be used.

Behaviour​

When optional address is enabled:

  • country remains mandatory.
  • addressLine1, city, and postcode become optional.
  • Additional billing address fields may still be supplied when available.
  • For UI integrations, billing address fields are not displayed when an optional address is enabled, even if additional billing address fields are supplied.

Examples​

The following examples show the difference between the standard billing address behaviour and optional address behaviour.

Optional Address​

Optional Address Request
{
    "customer": {
        "customerId": "1",
        "email": "[email protected]",
        "firstName": "Test",
        "surname": "Client",
        "dateOfBirth": "03042000",
        "address": {
            "country": "GBR"
        }
    }
}

Standard Address​

Standard Address Request
{
    "customer": {
        "customerId": "1",
        "email": "[email protected]",
        "firstName": "Test",
        "surname": "Client",
        "dateOfBirth": "03042000",
        "address": {
            "addressLine1": "123 Street",
            "city": "Guildford",
            "province": "Surrey",
            "postcode": "GU2 2YG",
            "country": "GBR"
        }
    }
}