Using the payment_type field for the quoting API

This document describes how to use the payment_type field which is used to dictate which products can be offered, based on the payment type which the platform or organization currently supports.

The payment_type field

There is a field called payment_type which is supported at the root level of the /v1/quote/{product-name} API which can have three possible values:

• integrated_payments
• invoice_payments
• null (or not provided / present)

If your platform, or the organization on the platform, only supports integrated payments (like using Stripe Connect with Vertical Insure), or only supports invoiced payments (where the platform or the organization collects money up front, and then Vertical Insure sends an invoice to collect the payment for the insurance), this field allows the organization to specify that, and Vertical Insure can choose a corresponding product to offer.

For example, take this quote request:

{
    "customer": {
        "email_address": "test01@example.com",
        "first_name": "Example",
        "last_name": "Customer",
        "state": "ON",
        "street": "123 Street",
        "postal_code": "M5B 2R8",
        "city": "Toronto",
        "country": "CA"
    },
    "policy_attributes": {
        "event_end_date": "YYYY-MM-DD",
        "event_start_date": "YYYY-MM-DD",
        "insurable_amount": 45000,
        "insurable_amount_currency": "CAD",
        "participant": {
            "first_name": "Participant",
            "last_name": "Name"
        }
    },
    "currency": "CAD",
    "payment_type": "invoice_payments"
}

Because payment_type is invoice_payments, Vertical Insure will attempt to offer a product which is compatible with invoice payments.

Note

**This feature is currently only honored for registration-cancellation.