Pay Ex Gratia Claim Coverage Payment Detail (POST)

Process a discretionary ex gratia payment for a claim coverage payment detail, enabling payment even when coverage or policy limits are exceeded.

Use this resource to pay the full adjusted amount for a loss type payment detail, regardless of whether policy limits are reached. The system records limit consumption only up to the remaining available limit and tracks the excess as an ex gratia amount.

Resource

{claimId}, {coverageId}, and {paymentDetailId} are placeholders.

1/connect/insurance/claims/{claimId}/coverages/{coverageId}/payment-details/{paymentDetailId}/pay-ex-gratia

Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/claims/0Zkxx000000001dEAA/coverages/0kPxx000000002fEAA/payment-details/0l2xx000000003gEAA/pay-ex-gratia

Available Version

66.0

HTTP Methods

POST

Path Parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`claimId`	String	ID of the claim.	Required	66.0
`coverageId`	String	ID of the coverage that applies to the claim.	Required	66.0
`paymentDetailId`	String	ID of the claim coverage payment detail record.	Required	66.0

Request Body for POST

JSON Example

1{
2  "options": {
3    "shouldCheckFinancialAuthority": true,
4    "shouldVerifyReserveLimit": true
5  },
6  "reason": "Customer goodwill gesture despite exceeded limits."
7}

Properties

Name	Type	Description	Required or Optional	Available Version
`options`	Pay Claim Coverage Payment Detail Options Input	Option to control the pre-payment checks.	Optional	68.0
`reason`	String	Reason for the ex gratia payment. Maximum character length is 255.	Optional	66.0

Response Body for POST

Pay Ex Gratia Claim Coverage Payment Detail