Cancel Claim Coverage Payment Detail Action

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/vXX.X/actions/standard/cancelClaimCvrPaymentDetail

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
cancelClaimCvrPymtDtlInputRep	Apex-defined	Required. An Apex `ConnectApi.CancelClaimCvrPymtDtlInputRep` record that contains the details to cancel the payment for the claim coverage payment detail record.

Outputs

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

Example

Sample Request

{
  "inputs": [
    {
      "cancelClaimCvrPymtDtlInputRep": {
        "claimId": "0clS70000004p9XIAQ",
        "coverageId": "0kPxx000000002fEAA",
        "paymentDetailId": "0l2xx000000003gEAA"
      }
    }
  ]
}

Sample Response

{
  "actionName": "cancelClaimCvrPaymentDetail",
  "errors": null,
  "invocationId": null,
  "isSuccess": true,
  "outcome": null,
  "outputValues": {
    "paymentDetailId": "5pdS70000004oVfIAI"
  },
  "sortOrder": -1,
  "version": 1
}