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
{
"inputs": [
{
"payClaimCvrPymtDtlInputRep": {
"claimId": "0Zkxx000000001dEAA",
"coverageId": "0kPxx000000002fEAA",
"paymentDetailId": "5pdS70000004oVfIAI",
"shouldCheckFinancialAuthority": true,
"shouldVerifyReserveLimit": true
}
}
]
}
Sample Response
[
{
"actionName": "payClaimCvrPaymentDetail",
"errors": null,
"invocationId": null,
"isSuccess": true,
"outcome": null,
"outputValues": {
"payClaimCvrPymtDtlOutputRep": {
"isSuccess": true,
"hasFinancialAuthority": true,
"isFinancialAuthorityConfigured": true,
"remainingReserves": [
{
"remainingReserveAmount": 2500.00,
"reserveLimitRecordId": null,
"scope": "ClaimCoverage"
}
],
"warnings": []
}
},
"sortOrder": -1,
"version": 1
}
]