Payments API

Endpoint Index

ActionEndpoint
Fetch a paymentGET /payments/{paymentLocator}
Reverse a paymentPOST /payments/{paymentLocator}/reverse

Details

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

optional
reversedTimestamp timestamp
Reverse a payment
POST /payments/{paymentLocator}/reverse
    Request:
    NamePositionTypeRequired
    paymentLocatorpathstringrequired
    Response: PaymentResponse

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.