Acknowledging payments

The following InsuranceNow API endpoints enable you to acknowledge payments from external payment vendors and record them in the InsuranceNow billing system:
Billing acknowledgement endpoint
POST /billingAccounts/{systemId}/acknowledgePayments
One Inc payment-specific endpoint
POST /interfaces/oneinc/notifications/acknowledgePayments

Using these endpoints, you can process and acknowledge within InsuranceNow payments that have been processed externally, either by a Guidewire-supported payment service, such as One Inc PremiumPay, or by an independent payment service that is not linked to InsuranceNow. Note that these endpoints only update the InsuranceNow billing system and do not actually process the payment.

Billing acknowledgement endpoint

The billing acknowledgement endpoint is used internally by the Service Portal. It records the transactional details of the payment service that was exercised by the Service Portal. Although it records payment service details to display within the billing system, it does not process the actual payment, and therefore cannot be used to make refunds via the original payment service.

Credit card payment through One Inc example

Credit card payment made from the Service Portal or Agent Portal through an external payment service such as One Inc.
{
  "submitPaymentAcknowledgeRequests": [
    {
      "lastFourDigits": "*611",
      "paymentAmount": 23.09,
      "checkAmt": 45.34,
      "paymentCategory": "Credit Card",
      "paymentServiceAccountId": "IIC",
      "sourceName": "OneInc",
      "transactionId": "23143123432",
      "statusCd": "Complete",
      "memo": "The monthly payment for homeowners "
    }
  ]
}

Credit card payment through PayPal example

Credit card payment made with the assistance of an external payment system such as PayPal, using its iFrame to log into the insured's account so as to obfuscate the actual payment type.

{
  "submitPaymentAcknowledgeRequests": [
    {
      "lastFourDigits": "*611",
      "paymentAmount": 23.09,
      "checkAmt": 45.34,
      "paymentCategory": "Credit Card",
      "paymentServiceAccountId": "IIC",
      "sourceName": "PayPal Account",
      "transactionId": "23143123432",
      "statusCd": "Complete",
      "memo": "Car one time payment",
      "receiptDt": "2025-01-15",
      "sourceCd": "PayPal"
    }
  ]
}

ACH payment through One Inc example

ACH payment made via an external payment system such as One Inc.
{
  "submitPaymentAcknowledgeRequests": [
    {
      "checkAmt": 14,
      "statusCd": "Active",
      "memo": "External Payment",
      "receiptDt": "2024-05-29",
      "lastFourDigits": "3890",
      "paymentAmount": 14,
      "paymentCategory": "ACH",
      "sourceName": "Web Payment",
      "transactionId": "3981-3901-2945-9458",
      "achName": "James Doe",
      "achBankName": "Wells Fargo",
      "achBankAccountTypeCd": "Checking",
      "achStandardEntryClassCd": "Personal"
    }
  ]
}

One Inc payment-specific endpoint

The One Inc payment-specific acknowledgement endpoint is a webhook endpoint that One Inc can call. It directly updates InsuranceNow with payment information that originated in the One Inc payment system. Like the billing acknowledgement endpoint, this endpoint can update the appropriate billing account in InsuranceNow with One Inc payment details. Because this endpoint is specific to One Inc, it can map some payment details onto the InsuranceNow billing account details for the payment transaction. However it does not have logic to communicate with One Inc to do additional followup transactions, such as a reversal to the One Inc account.

Note: Details for the following examples might change as One Inc makes changes to the data it sends to InsuranceNow via this interface endpoint. The values shown are from One Inc examples and include sample data.

One Inc-specific credit card payment

Credit card payment made via One Inc. Payment details sent to InsuranceNow to update the billing account details on this payment transaction.

{
  "SubmitPaymentAcknowledgeRequests": [
    {
      "CustomerId": "aaaaaaa-22222-33333-44444-5555555",
      "ExternalCustomerId": "",
      "AccountId": 131,
      "CustomerName": "Tom Williamson",
      "AuthCode": "",
      "TokenId": "",
      "PaymentCategory": "Credit Card",
      "PaymentMethod": {
        "Type": "CreditCardPaymentMethodDetails",
        "CardType": 4,
        "HolderZip": "00000",
        "CardExpirationMonth": 4,
        "CardExpirationYear": 2022,
        "LastFourDigits": "*611"
      },
      "BatchNumber": 123423,
      "TransactionId": "23143123432",
      "SessionId": "",
      "PaymentAmount": 99.99,
      "Timezone": "EDT",
      "TransactionDate": "2021-05-13T14:41:12.7035832",
      "ScheduledPaymentCreationDate": "2022-03-15T11:29:44.5098533-07:00",
      "OutboundApiKey": "",
      "ClientReferenceData": {
        "ClientReferenceData1": "P-2345234532",
        "ClientReferenceData2": "",
        "ClientReferenceData3": "",
        "ClientReferenceData4": "",
        "ClientReferenceData5": ""
      },
      "ExtendedParameters": {
        "CustomerName": "Tom Williamson",
        "SendReceiptBy": "CommunicationModule",
        "CommunicationModuleTemplateKey": "BankAccountReceiptTemplate"
      },
      "SelectedAmounts": [
        {
          "PaymentAmountKey": "4910203",
          "UserSelectedAmount": 2,
          "AccountGroupCode": "Insurance Bills"
        }
      ]
    }
  ]
}

One Inc-specific ACH payment

ACH payment made via One Inc. Payment details sent to InsuranceNow to update the billing account details on this payment transaction.
{
  "SubmitPaymentAcknowledgeRequests": [
    {
      "CustomerId": "aaaaaaa-22222-33333-44444-5555555",
      "ExternalCustomerId": null,
      "AccountId": null,
      "CustomerName": "Tom Williamson",
      "TokenId": "",
      "InstanceName": "CarrierDBInstance",
      "PaymentMethod": {
        "Type": "EftPaymentMethodDetails",
        "AccountType": 1,
        "BankName": "World Bank",
        "LastFourDigits": "*123"
      },
      "BatchNumber": 123423,
      "TransactionId": "23143123432",
      "SessionId": null,
      "PaymentAmount": 99.99,
      "Timezone": "EDT",
      "TransactionDate": "2021-05-13T14:41:12.7035832",
      "OutboundApiKey": "",
      "ClientReferenceData": {
        "ClientReferenceData1": "P-2345234532"
      },
      "ExtendedParameters": {
        "ClientReferenceData2": "SystemIndicator",
        "ClientReferenceData3": "Location",
        "ClientReferenceData4": "Additional Info",
        "ClientReferenceData5": "Source Account",
        "CustomerName": "Tom Williamson",
        "SendReceiptBy": "CommunicationModule",
        "CommunicationModuleTemplateKey": "BankAccountReceiptTemplate"
      },
      "SelectedAmounts": [
        {
          "PaymentAmountKey": "sample string 1",
          "UserSelectedAmount": 2,
          "AccountGroupCode": "sample string 3"
        }
      ]
    }
  ]
}

One Inc-specific PayPal payment

PayPal payment made via One Inc. Payment details sent to InsuranceNow to update the billing account details on this payment transaction. 
{
  "SubmitPaymentAcknowledgeRequests": [
    {
      "CustomerId": "aaaaaaa-22222-33333-44444-5555555",
      "ExternalCustomerId": null,
      "AccountId": null,
      "CustomerName": "Tom Williamson",
      "TokenId": "",
      "PaymentCategory": "PayPal",
      "InstanceName": "CarrierDBInstance",
      "PaymentMethod": {
        "Type": "PayPalPaymentMethodDetails",
        "PayPalAccountId": "paypal-universal-test@oneinc.com"
      },
      "BatchNumber": 123423,
      "TransactionId": "23143123432",
      "SessionId": null,
      "PaymentAmount": 99.99,
      "Timezone": "EDT",
      "TransactionDate": "2021-05-13T14:41:12.7035832",
      "OutboundApiKey": "",
      "ClientReferenceData": {
        "ClientReferenceData1": "P-2345234532",
        "ClientReferenceData2": "",
        "ClientReferenceData3": "",
        "ClientReferenceData4": "",
        "ClientReferenceData5": ""
      },
      "ExtendedParameters": {
        "CustomerName": "Tom Williamson",
        "SendReceiptBy": "CommunicationModule",
        "CommunicationModuleTemplateKey": "PayPalReceiptTemplate"
      },
      "SelectedAmounts": [
        {
          "PaymentAmountKey": "sample string 1",
          "UserSelectedAmount": 2,
          "AccountGroupCode": "sample string 3"
        }
      ]
    }
  ]
}

One Inc policy search

The policy search endpoint is described here because it often goes hand-in-hand with the One Inc payment endpoint. For payments made with One Inc using their Interactive Voice Response (IVR) system, One Inc interacts with InsuranceNow to obtain the required policy/account information, and uses this information to inform the insured of their current policy payment installment.

Given either the policy number or account number and a set of verifiable fields (such as the postal code, email address, and phone number) InsuranceNow returns a response with the specific policy and its currently-due billing installment details.
GET /interfaces/oneinc/policies/search
{
  "limit": 0,
  "offset": 0,
  "sortBy": "DESC",
  "searchParameters": {
    "policyNumber": "HO00000080",
    "accountNumber": "HO00000080",
    "postalCode": "95119",
    "emailAddress": "test@guidewire.com",
    "phoneNumber": "9999999999",
    "insuredName": "James Doe",
    "policyExpirationDate": "20221012"
  }
}
Response
{
  "totalCount": 1,
  "isSuccessful": true,
  "results": [
    {
      "status": "Active",
      "policyNumber": "HO00000022",
      "customerId": "2",
      "customerName": "Doe, James",
      "premium": "0.00",
      "remainingBalance": "780.46",
      "minimumAmountDue": "0.00",
      "otherAmountAllowed": false,
      "zipCode": "95119",
      "policyDetails": {
        "type": "AutoPolicyDetails"
      },
      "paymentsAreAllowed": true,
      "isScheduledPayEnabled": false,
      "isSuccessful": false
    }
  ]
}