Skip to main content

AddDeductiblePayment

Records a payment against the claim's deductible. Void by sending negative PaymentAmount.

Purpose

Records a payment against the claim's deductible. Returns the new deductible-payment ID. Void a previously recorded payment by sending the same data with a negative PaymentAmount.

Endpoint

  • Method: AddDeductiblePayment

  • SOAPAction (1.1): "https://ftservices.onlinereportinginc.com/v2/AddDeductiblePayment"

  • Parameter wrapper: <oPayment>

Authentication

Standard credentials apply, supplied inside the <oPayment> wrapper. See Authentication & Authorization.

Parameters

Name

Type

Required

Description

Login

string

yes

Authorized FileTrac system login.

Password

string

yes

Password for the login.

CompanyKey

string

yes

The unique company code provided by FileTrac.

FileTracClaimID

int

yes

System ID of the claim.

PayeeID

int

conditional

System ID of the contact within the claim. Required when not creating a new contact inline.

PayeeFirstName

string

conditional

First name — supplied when creating a new contact inline.

PayeeLastName

string

conditional

Last name — supplied when creating a new contact inline.

PayeeContactTypeID

int

conditional

Contact type ID — supplied when creating a new contact inline. From GetContactTypes.

PayeeContactType

string

conditional

Contact type name — alternative to PayeeContactTypeID. From the ContactType enum or GetContactTypes.

PaymentDate

dateTime

no

Payment date. Server default applies if omitted.

PaymentCheckNumber

string

no

Check number associated with the payment.

PaymentInvoiceNumber

string

no

Invoice number associated with the payment.

PaymentTaxID

string

no

Payee tax ID.

PaymentAmount

decimal

yes

Amount. Cents optional. Negative values void a prior payment.

PaymentMemo

string

no

Internal memo (not the memo printed on a check).

Payee resolution rules

  • Pass PayeeID to attach the payment to an existing contact on the claim.

  • When PayeeID is not supplied, FileTrac creates a new contact inline using PayeeFirstName, PayeeLastName, and either PayeeContactTypeID or PayeeContactType.

  • If neither pattern produces a valid contact, the call returns error (3) (see below).

Response

Returns a complex AddDeductiblePaymentResult:

Field

Datatype

Description

DeductiblePaymentID

int

The new payment's ID on success. 0 on failure.

ResponseMessage

string

Success or a failure-identifying string.

Errors

Error Message

Cause

Remediation

ERROR inserting Deductible Payment.

The payment insert failed.

Validate the payload; retry.

(1) Claim not found - invalid claimID or File Number

The claim cannot be located.

Confirm FileTracClaimID.

(2) Invalid contactID supplied: 'contactID'

The PayeeID does not exist within the claim.

Confirm via GetClaimDetail.

(3) Invalid contact information supplied: 'contactFirstName contactLastName' for Type: 'contactType'

The new-contact fields don't compose a valid contact (e.g., unknown type).

Confirm the contact-type name or ID via GetContactTypes.

(4) Payment amount exceeds balance of deductible

The payment amount exceeds the deductible less prior payments.

Reduce the payment amount.

Remarks

  • Payments are immutable. Void via inverse amount; no edit or delete is available.

  • A contact is mandatory. Either supply a valid PayeeID or supply the new-contact fields. Without one of these, the call fails.

  • Payments cannot exceed available deductible balance. Negative payments (voids) can offset prior payments only down to zero — they cannot push the balance below the original deductible.

  • Excess-payment splitting does not apply here. Unlike AddInvoicePayment, this method does not split overflowing payments.

Example Request (SOAP 1.1)

POST /v2/service.asmx HTTP/1.1
Host: ftservices.onlinereportinginc.com
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://ftservices.onlinereportinginc.com/v2/AddDeductiblePayment"<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddDeductiblePayment xmlns="https://ftservices.onlinereportinginc.com/v2/">
      <oPayment>
        <Login>integration.svc</Login>
        <Password>•••••••••</Password>
        <CompanyKey>ACME-AC-001</CompanyKey>
        <FileTracClaimID>881204</FileTracClaimID>
        <PayeeID>442101</PayeeID>
        <PaymentDate>2026-05-22T00:00:00</PaymentDate>
        <PaymentCheckNumber>10042</PaymentCheckNumber>
        <PaymentAmount>2500.00</PaymentAmount>
        <PaymentMemo>Deductible applied — wind claim</PaymentMemo>
      </oPayment>
    </AddDeductiblePayment>
  </soap:Body>
</soap:Envelope>

Example Response (SOAP 1.1)

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddDeductiblePaymentResponse xmlns="https://ftservices.onlinereportinginc.com/v2/">
      <AddDeductiblePaymentResult>
        <DeductiblePaymentID>78421</DeductiblePaymentID>
        <ResponseMessage>Success</ResponseMessage>
      </AddDeductiblePaymentResult>
    </AddDeductiblePaymentResponse>
  </soap:Body>
</soap:Envelope>

Related Methods

Did this answer your question?