Update | Candid | API Reference

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

{
  "patient_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "payment_source": "MANUAL_ENTRY",
  "amount_cents": 1,
  "patient_external_id": "patient_external_id",
  "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"
    }
  ],
  "source_internal_id": "source_internal_id",
  "payment_timestamp": "2024-01-15T09:30:00Z",
  "payment_note": "payment_note",
  "invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "payment_method_detail": {
    "payment_method": {
      "type": "cash"
    },
    "collected_at_address": {
      "address1": "address1",
      "city": "city",
      "state": "AA",
      "zip_code": "zip_code",
      "address2": "address2",
      "zip_plus_four_code": "zip_plus_four_code"
    }
  }
}

Updates the patient payment record matching the provided patient_payment_id.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

patient_payment_idUUIDRequired

Request

This endpoint expects an object.

payment_timestampdatetimeOptional

payment_noteobjectOptional

invoiceobjectOptional

Response

This endpoint returns an object.

patient_payment_idUUID

organization_idUUID

payment_sourceenum

amount_centsinteger

patient_external_idstring

allocationslist of objects

source_internal_idstring

payment_timestampdatetime

payment_notestring

invoiceUUID

payment_method_detailobject

Errors

403

Unauthorized Error

404

Entity Not Found Error

422

Unprocessable Entity Error