Payments API
Endpoint Index
Action | Endpoint |
---|---|
Fetch a payment | GET /payments/{paymentLocator} |
Reverse a payment | POST /payments/{paymentLocator}/reverse |
Details
Fetch a payment¶
GET /payments/{paymentLocator}
Request:
Name | Position | Type | Required |
---|---|---|---|
paymentLocator | path | string | required |
Response:
PaymentResponse
PaymentResponse¶
requiredlocator stringdisplayId stringpostedTimestamp timestampfieldValues map<string,[string]>amount numberamountCurrency stringinvoiceLocator stringmediaByLocator map<string,Media>optionalreversedTimestamp timestamp
Reverse a payment¶
POST /payments/{paymentLocator}/reverse
Request:
Name | Position | Type | Required |
---|---|---|---|
paymentLocator | path | string | required |
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.