Skip to main content

AddReservePayment

Records a payment against a specific reserve on a claim. Void by sending negative PaymentAmount.

Purpose

Records a payment against a specific reserve on a claim. Returns the reserve-payment ID and a response message. Void a previously recorded payment by sending the same data with a negative PaymentAmount.

Endpoint

  • Method: AddReservePayment

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

  • 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.

ReserveID

int

conditional

System ID of the reserve. Either ReserveID or ReserveName is required.

ReserveName

string

conditional

Reserve type name — may be used as a substitute for ReserveID when the reserve type is unique on 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 payee contact inline.

PayeeLastName

string

conditional

Last name — supplied when creating a new payee contact inline.

PayeeContactTypeID

int

conditional

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

PayeeContactType

string

conditional

Contact type name — alternative to PayeeContactTypeID.

PaymentDate

dateTime

no

Payment date. Server default applies if omitted.

PaymentCheckNumber

string

no

Check number.

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).

Response

Returns a complex AddReservePaymentResult:

Field

Datatype

Description

ReservePaymentID

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 Reserve Payment.

Generic insert failure.

Retry; validate payload.

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

The claim cannot be located.

Confirm FileTracClaimID.

(2) Invalid contactID supplied: xxxxxx

The PayeeID does not exist within the claim.

Confirm via GetClaimDetail or pass new-contact fields.

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

New-contact creation failed (e.g., unknown contact type).

Confirm contact-type name or ID via GetContactTypes.

(4) Payment amount exceeds balance of reserve.

The payment amount would push the reserve balance negative.

Reduce the payment, or increase the reserve via AddReserve first.

Remarks

  • Payments are immutable. Void via inverse amount.

  • ReserveID is the reliable selector. ReserveName works only when the reserve type is unique on the claim — and an adjustment company can have multiple reserves of the same type if they're attached to different contacts.

  • A payee is mandatory. Either supply PayeeID or supply the new-contact fields. The reserve itself can be claim-level or contact-level, but every payment must identify a payee.

  • Payments cannot exceed the available reserve balance. Increase the reserve first if necessary.

  • The reserve's Incurred amount is unaffected by payments. Payments draw down the reserve balance available for future payments; they do not reduce the reserve.

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/AddReservePayment"<?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>
    <AddReservePayment xmlns="https://ftservices.onlinereportinginc.com/v2/">
      <oPayment>
        <Login>integration.svc</Login>
        <Password>•••••••••</Password>
        <CompanyKey>ACME-AC-001</CompanyKey>
        <FileTracClaimID>881204</FileTracClaimID>
        <ReserveID>20431</ReserveID>
        <PayeeID>442108</PayeeID>
        <PaymentDate>2026-05-26T00:00:00</PaymentDate>
        <PaymentCheckNumber>20122</PaymentCheckNumber>
        <PaymentAmount>15000.00</PaymentAmount>
        <PaymentMemo>Partial settlement — roof replacement</PaymentMemo>
      </oPayment>
    </AddReservePayment>
  </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>
    <AddReservePaymentResponse xmlns="https://ftservices.onlinereportinginc.com/v2/">
      <AddReservePaymentResult>
        <ReservePaymentID>78540</ReservePaymentID>
        <ResponseMessage>Success</ResponseMessage>
      </AddReservePaymentResult>
    </AddReservePaymentResponse>
  </soap:Body>
</soap:Envelope>

Related Methods

Did this answer your question?