Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
Insurance Claims Business APIs
Resources
Calculate or Recalculate Adjustments (POST, PATCH)
Cancel Claim Coverage Payment Detail (POST)
Claim (POST)
Claim (GET, PATCH)
Claim Coverage (POST)
Claim Coverage (PATCH)
Claim Coverage Payment Detail (POST)
Claim Coverage Payment Detail Edit (PATCH)
Delete Claim Coverage Payment Detail (POST)
Field Set Fields (GET)
Policy Limits (POST)
Insurance Policy Limit Current Standings (POST)
Pay Claim Coverage Payment Detail (POST)
Pay Ex Gratia Claim Coverage Payment Detail (POST)
Process Policy Limits (POST)
Verify Policy Coverage (POST)
Requests
Responses
Insurance Claims Standard Invocable Actions
Insurance Claims Apex Reference
Insurance Claims Metadata API Types
Insurance Claims Tooling API Objects
Insurance Claims Developer Journey
Insurance Group Benefits
Insurance Policy Administration
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
PDF

Cancel Claim Coverage Payment Detail (POST)

Cancel payment for a claim coverage payment detail record.
Resource
1/connect/insurance/claims/claimId/coverages/coverageId/payment-details/paymentDetailId/cancel
Resource example
1https://yourInstance.salesforce.com/services/data/v67.0/connect/insurance/claims/0Zkxx000000001dEAA/coverages/0kPxx000000002fEAA/payment-details/0l2xx000000003gEAA/cancel
Available version
65.0
HTTP methods
POST
Path parameter for POST
Parameter Name Type Description Required or Optional Available Version
claimId String ID of the claim whose coverage payment detail must be canceled. Required 65.0
coverageId String ID of the coverage that applies to the claim. Required 65.0
paymentDetailId String ID of the claim coverage payment detail record. Required 65.0
Response body for POST
Cancel Claim Coverage Payment Detail