Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Cancel Claim Coverage Payment Detail Action

Cancel payment for a claim coverage payment detail record.

When the coveragePaymentType is Loss, this action reverses the insurance policy limit tracking data to roll back consumption. This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI
/services/data/v68.0/actions/standard/cancelClaimCvrPaymentDetail
Formats
JSON
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
cancelClaimCvrPymtDtlInputRep
Type
Apex-defined
Description

Required.

An Apex ConnectApi.CancelClaimCvrPymtDtlInputRep record that contains the details to cancel the payment for the claim coverage payment detail record.

Outputs

Output Details
paymentDetailId
Type
string
Description
ID of the payment detail record for which the payment is canceled.

Example

Sample Request

1{
2  "inputs": [
3    {
4      "cancelClaimCvrPymtDtlInputRep": {
5        "claimId": "0clS70000004p9XIAQ",
6        "coverageId": "0kPxx000000002fEAA",
7        "paymentDetailId": "0l2xx000000003gEAA"
8      }
9    }
10  ]
11}

Sample Response

1{
2  "actionName": "cancelClaimCvrPaymentDetail",
3  "errors": null,
4  "invocationId": null,
5  "isSuccess": true,
6  "outcome": null,
7  "outputValues": {
8    "paymentDetailId": "5pdS70000004oVfIAI"
9  },
10  "sortOrder": -1,
11  "version": 1
12}