Payments API

Endpoint Index

Action	Endpoint
Fetch a payment	GET /payments/{paymentLocator}
Reverse a payment	POST /payments/{paymentLocator}/reverse
Create a payment	POST /payments
Update a payment	PATCH /payments/{paymentLocator}
Fetch payments	GET /payments

Details

Fetch a payment¶

GET /payments/{paymentLocator}

Request:

Name	Position	Type	Required
paymentLocator	path	string	required

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

Request:

Name	Position	Type	Required
invoicePaymentReversalRequest	body	InvoicePaymentReversalRequest	optional
paymentLocator	path	string	required

Response: PaymentResponse

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

Request:

Name	Position	Type	Required
paymentCreateRequest	body	PaymentCreateRequest	required

Response: PaymentResponse

PaymentCreateRequest¶

required
amount number

optional
policyholderLocator string
policyLocator string
fieldValues map<string,[string]>
amountCurrency string

Update a payment¶

PATCH /payments/{paymentLocator}

Request:

Name	Position	Type	Required
paymentActionRequest	body	PaymentActionRequest	required
paymentLocator	path	string	required

Response: PaymentResponse

PaymentActionRequest¶

optional
action string draft | ready | decline | return | discard
paymentUpdate PaymentUpdateRequest

Fetch payments¶

GET /payments

Request:

Name	Position	Type	Required
createdBeforeTimestamp	query	timestamp	optional
invoiceLocator	query	string	optional
pageSize	query	integer	optional
pagingToken	query	string	optional
policyholderLocator	query	string	optional
policyLocator	query	string	optional
postedAfterTimestamp	query	timestamp	optional
state	query	string	optional

Response: PaymentPageResponse

PaymentPageResponse¶

required
payments [PaymentResponse]

optional
pagingToken string