Payments API

Fetch a Payment

GET /payments/{paymentLocator}
  • Request:

    Name

    Position

    Type

    Required

    paymentLocator

    path

    string

    required

  • Response:PaymentResponse2

PaymentResponse2

{
  // Required
  amount : number
  amountCurrency : string
  displayId : string
  fieldValues : map<string,[string]>
  invoiceLocator : string
  locator : string
  mediaByLocator : map<string,Media>
  postedTimestamp : timestamp

  // Optional
  reversedTimestamp : timestamp
}

Reverse a Payment

POST /payments/{paymentLocator}/reverse
  • Request:

    Name

    Position

    Type

    Required

    paymentLocator

    path

    string

    required

  • Response:PaymentResponse2

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.