Update | Candid | API Reference

curl -X PATCH https://api.joincandidhealth.com/api/insurance-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "insurance_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "payer": {
    "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "payer_id": "payer_id",
    "payer_name": "payer_name",
    "availity_payer_name": "availity_payer_name",
    "availity_claims_payer_id": "availity_claims_payer_id",
    "availity_eligibility_id": "availity_eligibility_id",
    "availity_remittance_payer_id": "availity_remittance_payer_id",
    "street_address": {
      "address1": "address1",
      "city": "city",
      "state": "AA",
      "zip_code": "zip_code",
      "zip_plus_four_code": "zip_plus_four_code",
      "address2": "address2"
    }
  },
  "amount_cents": 1,
  "allocations": [
    {
      "amount_cents": 1,
      "target": {
        "type": "service_line",
        "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
      },
      "earmark": {
        "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "target": {
          "type": "date_of_service",
          "value": "target"
        },
        "amount_earmarked_cents": 1,
        "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
      },
      "allocated_on": "2024-01-15T09:30:00Z"
    },
    {
      "amount_cents": 1,
      "target": {
        "type": "service_line",
        "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
      },
      "earmark": {
        "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "target": {
          "type": "date_of_service",
          "value": "target"
        },
        "amount_earmarked_cents": 1,
        "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
      },
      "allocated_on": "2024-01-15T09:30:00Z"
    }
  ],
  "refund_timestamp": "2024-01-15T09:30:00Z",
  "refund_note": "refund_note",
  "refund_reason": "OVERCHARGED"
}

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.

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

refund_notestring

refund_reasonenum

Allowed values:

Errors

403

Unauthorized Error

404

Entity Not Found Error

422

Unprocessable Entity Error