Pay Claim Coverage Payment Detail Action

Initiate the payment for a claim coverage payment detail record, track the policy limit consumption for the payout, and update the status of the claim coverage payment detail record to Paid.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

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

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
`payClaimCvrPymtDtlInputRep`	Apex-defined	Required. An Apex `ConnectApi.PayClaimCvrPymtDtlInputRep` record that contains the details of the claim coverage payment detail to be paid.

Outputs

Output	Type	Description
`payClaimCvrPymtDtlOutputRep`	Apex-defined	An Apex `ConnectApi.PayClaimCvrPymtDtlOutputRep` record that contains the details of the payment status.

Example

Sample Request

1{
2  "inputs": [
3    {
4      "payClaimCvrPymtDtlInputRep": {
5        "claimId": "0Zkxx000000001dEAA",
6        "coverageId": "0kPxx000000002fEAA",
7        "paymentDetailId": "5pdS70000004oVfIAI",
8        "shouldCheckFinancialAuthority": true,
9        "shouldVerifyReserveLimit": true
10      }
11    }
12  ]
13}

Sample Response

1[
2  {
3    "actionName": "payClaimCvrPaymentDetail",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "payClaimCvrPymtDtlOutputRep": {
10        "isSuccess": true,
11        "hasFinancialAuthority": true,
12        "isFinancialAuthorityConfigured": true,
13        "remainingReserves": [
14          {
15            "remainingReserveAmount": 2500.00,
16            "reserveLimitRecordId": null,
17            "scope": "ClaimCoverage"
18          }
19        ],
20        "warnings": []
21      }
22    },
23    "sortOrder": -1,
24    "version": 1
25  }
26]