Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
Contact Sales
LogoLogo
API ReferenceInsurance RefundsV1

Update

Beta
PATCH
/api/insurance-refunds/v1/:insurance_refund_id
PATCH
/api/insurance-refunds/v1/:insurance_refund_id
1curl -X PATCH https://api.joincandidhealth.com/api/insurance-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
Try it
1{
2  "insurance_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3  "payer": {
4    "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5    "payer_id": "payer_id",
6    "payer_name": "payer_name",
7    "availity_payer_name": "availity_payer_name",
8    "availity_claims_payer_id": "availity_claims_payer_id",
9    "availity_eligibility_id": "availity_eligibility_id",
10    "availity_remittance_payer_id": "availity_remittance_payer_id",
11    "street_address": {
12      "address1": "address1",
13      "city": "city",
14      "state": "AA",
15      "zip_code": "zip_code",
16      "zip_plus_four_code": "zip_plus_four_code",
17      "address2": "address2"
18    }
19  },
20  "amount_cents": 1,
21  "allocations": [
22    {
23      "amount_cents": 1,
24      "target": {
25        "type": "service_line",
26        "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
27        "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
28        "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
29      }
30    },
31    {
32      "amount_cents": 1,
33      "target": {
34        "type": "service_line",
35        "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
36        "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
37        "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
38      }
39    }
40  ],
41  "refund_timestamp": "2024-01-15T09:30:00Z",
42  "refund_note": "refund_note",
43  "refund_reason": "OVERCHARGED"
44}
Updates the patient refund record matching the provided insurance_refund_id. If updating the refund amount, then the allocations must be appropriately updated as well.
Was this page helpful?
Previous

Delete insurance refund

Next
Built with
Delete insurance refund

Authentication

AuthorizationBearer
OAuth authentication of the form `<token>`.

Path parameters

insurance_refund_idUUIDRequired

Request

This endpoint expects an object.
refund_timestampdatetimeOptional
refund_noteobjectOptional
refund_reasonobjectOptional

Response

This endpoint returns an object.
insurance_refund_idUUID
payerobject
amount_centsinteger
allocationslist of objects
refund_timestampdatetime or null
refund_notestring or null
refund_reasonenum or null
Allowed values:

Errors

OAuth authentication of the form <token>.

Updates the patient refund record matching the provided insurance_refund_id. If updating the refund amount, then the allocations must be appropriately updated as well.