Pay Ex Gratia Claim Coverage Payment Detail Action

Process ex gratia payments for the claim coverage payment detail record when the adjusted amount is greater than the policy limit amount or count or both.

This action is available in API version 66.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/payExGratiaClaimCvrPymtDetail

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
`payExGratiaClaimCvrPymtDtlInputRep`	Apex-defined	Required. An Apex `ConnectApi.PayExGratiaClaimCvrPymtDtlInputRep` record that contains the details to process the ex gratia payment.

Outputs

Output	Type	Description
`payExGratiaClaimCvrPymtDtlRep`	Apex-defined	An Apex `ConnectApi.PayExGratiaClaimCvrPymtDtlRep` record that contains the ex gratia payment details.

Example

POST

This sample request is for the Pay Ex Gratia Claim Coverage Payment Detail action.

1{
2  "inputs": [
3    {
4      "payExGratiaClaimCvrPymtDtlInputRep": {
5        "claimId": "0Zkxx0000000001CAA",
6        "coverageId": "0kPxx0000000001CAA",
7        "paymentDetailId": "0k5xx0000000001AAA",
8        "reason": "Ex gratia payment approved for customer satisfaction.",
9        "shouldCheckFinancialAuthority": true,
10        "shouldVerifyReserveLimit": true
11      }
12    }
13  ]
14}

This sample response is for the Pay Ex Gratia Claim Coverage Payment Detail action.

1[
2  {
3    "actionName": "payExGratiaClaimCvrPymtDetail",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "payExGratiaClaimCvrPymtDtlRep": {
10        "claimPaymentSummaryId": "0sDxx0000000001CAA",
11        "consumedLimitCount": 5,
12        "exceededAmount": 1500,
13        "exceededCount": 2,
14        "hasFinancialAuthority": true,
15        "insPolicyLimitTrackingIds": [
16          "0qOxx0000004CvQEAU",
17          "0qOxx0000004CvREAU"
18        ],
19        "isFinancialAuthorityConfigured": true,
20        "isSuccess": true,
21        "paidAmount": 5000,
22        "remainingReserves": [
23          {
24            "remainingReserveAmount": 2500.00,
25            "reserveLimitRecordId": null,
26            "scope": "ClaimCoverage"
27          }
28        ],
29        "warnings": []
30      }
31    },
32    "sortOrder": -1,
33    "version": 1
34  }
35]