Making ad hoc and scheduled credit card and ACH payments

1. Issue a GET /billingAccounts/{systemId}/paymentSources request.
   You can optionally pass the sourceName parameter to get just the payment profiles that were made from a specific source, such as Service Portal or Sales Portal.

   Note: Be aware that SourceName is a relatively new feature and therefore prior payments might not be marked with this parameter. You can use any value for the sourceName parameter. But a best practice is to use consistent values to enable reliable filtering when performing lookups in the core InsuranceNow user interface.
   Select the appropriate prior payment with methodCd=Credit Card. The following code shows an example of a typical response:

   {
     "id": "APIPaymentSourceList-1625703649-940996514",
     "electronicPaymentSource": [
       {
         "id": "!X8pYzI63yyqIhtjsfHt9T4IlnXY=",
         "sourceName": "Account Payment",
         "methodCd": "Credit Card",
         "action": "None",
         "paymentServiceAccountId": "IIC",
         "transactionId": "2528036",
         "creditCardNumber": "****1111",
         "creditCardTypeCd": "Visa"
       }
     ]
   }

2. Use the values from the previous endpoint result in a call to the POST /billingAccounts/{systemId}/paymentRequest or scheduledPaymentRequest endpoint as follows:

   • Copy the masked credit card number value from creditCardNumber field to the field of the same name.
   • Copy the value in the id field to the paymentOnFileId field.
   Note: Certain fields are required based on the validation for the type of payment you are handling. For example, creditCardNumber is required when dealing with a credit card payment.
   The following code shows an example of a typical paymentRequest or scheduledPaymentRequest POST event:

   {
     "paymentMethod": "Credit Card",
     "_comment": Following element used only in scheduledPaymentRequest and must be in YYYY-mm-dd format.
     "scheduledDate": "2024-04-18" 
     "payments": [
       {
         "sourceRef": "4",
         "sourceCd": "Web Portal",
         "checkAmt": "87.50",
         "receiptAmt": "87.50",
         "paymentOnFileId": "!X8pYzI63yyqIhtjsfHt9T4IlnXY=",
         "electronicPaymentSource": {
           "sourceName": "Service Portal",
           "creditCardNumber": "****1111",
         }
       }
     ]
   }

   Note: creditCardNumber must be a masked value. If you are dealing with an unmasked credit card number, you must mask it before sending it to InsuranceNow. Guidewire security practices do not allow storing full credit card numbers in InsuranceNow.

To make a credit card payment through an external payment service, such as Authorize.net or through One Inc via the Guidewire Payments API, requires your API caller to have a PCI-compliant integrated iFrame for secure payment processing. If properly configured, the payment service returns a transaction ID or payment profile ID that InsuranceNow uses to confirm via the payment service.

{
  "paymentMethod": "Credit Card",
  "_comment": Following element used only in scheduledPaymentRequest and must be in YYYY-mm-dd format.
  "scheduledDate": "2024-04-18" 
  "payments": [
    {
      "sourceRef": "4",
      "sourceCd": "Web Portal",
      "checkAmt": "87.50",
      "receiptAmt": "87.50",
      "electronicPaymentSource": {
        "sourceName": "Service Portal",
        "creditCardNumber": "XXXX1234",
        "customerProfileId": "<customerProfileId>",
        "customerPaymentProfileId": "<paymentProfileId>",
        "paymentServiceAccountId": "<carrierCd>"
      }
    }
  ]
}

The customerProfileId and customerPaymentProfileId values are the customer account number and customer current transaction number from your payment service. Authorize.net provides both values. One Inc via Guidewire Payments API uses the same value for both fields.

The paymentServiceAccountId field is generally the carrier code for the policy being paid. You can retrieve this value in several ways. For example:

• Get the value from the current Policy or Account resource, which you could have retrieved prior to this call by using GET /policies/{systemId} or GET /billingAccounts/{systemId} respectively.
• Use the GET /billingAccounts/{systemId}/paymentSources endpoint as described in the previous example to determine whether there were any prior payments on the account. This endpoint returns the paymentServiceAccountId in any prior payments, which is the carrier code.

To make an ACH payment request through an external payment service, such as Authorize.net or through One Inc via the Guidewire Payments API, requires your API caller to have a PCI-compliant integrated iFrame for secure payment processing. If properly configured, the payment service will return a transaction ID or payment profile ID that InsuranceNow uses to confirm via the payment service.

{
  "paymentMethod": "ACH",
  "_comment": Following element used only in scheduledPaymentRequest and must be in YYYY-mm-dd format.
  "scheduledDate": "2024-04-18" 
  "payments": [
    {
      "sourceRef": "4",
      "sourceCd": "Web Portal",
      "checkAmt": "1.35",
      "receiptAmt": "1.35",
      "electronicPaymentSource": {
        "sourceName": "Service Portal",
        "achBankAccountTypeCd": "Checking",
        "achBankAccountNumber": "XXXX0293",
        "customerProfileId": "<customerProfileId>",
        "customerPaymentProfileId": "<paymentProfileId>",
        "paymentServiceAccountId": "<carrierCd>"
      }
    }
  ]
}

The customerProfileId and customerPaymentProfileId values are the customer account number and customer current transaction number from your payment service. Authorize.net provides both values. One Inc via Guidewire Payments API uses the same value for both fields.

The achBankAccountTypeCd field is optional. Typical values are "Checking" and "Savings". You can provide this value if the iFrame or payment service interface provides it. If included, it enhances the details that InsuranceNow displays from the core user interface.

To make an ACH payment request that does not a prior payment profile and not through an external payment service, such as Authorize.net or One Inc via the Guidewire Payments API, requires ACH details such as the bank account number, bank routing number, and other information.

{
  "paymentMethod": "ACH",
  "_comment": Following element used only in scheduledPaymentRequest and must be in YYYY-mm-dd format.
  "scheduledDate": "2024-04-18" 
  "payments": [
    {
      "sourceRef": "8",
      "sourceCd": "Web Portal",
      "checkAmt": "2.77",
      "receiptAmt": "2.77",
      "electronicPaymentSource": {
        "methodCd": "ACH",
        "sourceName": "Service Portal",
        "achName": "Smith, Joe",
        "achBankName": "Wells Fargo",
        "achBankAccountTypeCd": "Checking",
        "achBankAccountNumber": "1234567",
        "achRoutingNumber": "011001959",
        "achStandardEntryClassCd": "Personal"
      }
    }
  ]
}