Payments API

Endpoint Index

ActionEndpoint
Fetch a paymentGET /payments/{paymentLocator}
Reverse a paymentPOST /payments/{paymentLocator}/reverse
Create a paymentPOST /payments
Update a paymentPATCH /payments/{paymentLocator}
Fetch paymentsGET /payments

Details

Fetch a payment
GET /payments/{paymentLocator}
    Request:
    NamePositionTypeRequired
    paymentLocatorpathstringrequired
    Response: PaymentResponse
PaymentResponse
required
locator string
displayId string
fieldValues map<string,[string]>
amount number
mediaByLocator map<string,Media>

optional
policyholderLocator string
policyLocator string
state string draft | ready | posted | declined | returned | discarded
createdTimestamp timestamp
updatedTimestamp timestamp
postedTimestamp timestamp
reversedTimestamp timestamp
amountCurrency string
invoiceLocator string

Note

Some optional fields, such as state, pertain to Cash Management and will only appear if Cash Management is enabled.

Payments assigned to Premium Reporting invoices will not be returned by this endpoint. To view the details of such payments, fetch the PremiumReportResponse, which will include PremiumReportingPaymentResponse details on the payments property of invoice.

Reverse a payment
POST /payments/{paymentLocator}/reverse
InvoicePaymentReversalRequest
optional
name string
details string

Note

InvoicePaymentReversalRequest is only available when Cash Management is enabled.

When an endorsement or renewal has a paid invoice and is then invalidated, the payment for that invoice will automatically be reversed.

Note

When a payment is reversed, if the invoice due date is in the past, it will have the due date reset to the end of the current day. This prevents the policy from becoming delinquent without the opportunity to reapply a payment.

Cash Management-Enabled Endpoints

The following endpoints are available to manage payments as independent objects when Cash Management is enabled.

Create a payment
POST /payments
PaymentCreateRequest
required
amount number

optional
policyholderLocator string
policyLocator string
fieldValues map<string,[string]>
amountCurrency string
Update a payment
PATCH /payments/{paymentLocator}
PaymentActionRequest
optional
action string draft | ready | decline | return | discard
paymentUpdate PaymentUpdateRequest
Fetch payments
GET /payments
    Request:
    NamePositionTypeRequired
    createdBeforeTimestampquerytimestampoptional
    invoiceLocatorquerystringoptional
    pageSizequeryintegeroptional
    pagingTokenquerystringoptional
    policyholderLocatorquerystringoptional
    policyLocatorquerystringoptional
    postedAfterTimestampquerytimestampoptional
    statequerystringoptional
PaymentPageResponse
required
payments [PaymentResponse]

optional
pagingToken string