Edit Claim Payment

PATCH

api

patient-payments

claims

{claimControlNumber}

cURL

curl --request PATCH \
  --url https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber} \
  --header 'Content-Type: application/json' \
  --data '
{
  "paymentAmount": 60,
  "paymentMethod": "Check",
  "paymentTraceId": "chk-999"
}
'

import requests

url = "https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}"

payload = {
    "paymentAmount": 60,
    "paymentMethod": "Check",
    "paymentTraceId": "chk-999"
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({paymentAmount: 60, paymentMethod: 'Check', paymentTraceId: 'chk-999'})
};

fetch('https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'paymentAmount' => 60,
    'paymentMethod' => 'Check',
    'paymentTraceId' => 'chk-999'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}"

	payload := strings.NewReader("{\n  \"paymentAmount\": 60,\n  \"paymentMethod\": \"Check\",\n  \"paymentTraceId\": \"chk-999\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}")
  .header("Content-Type", "application/json")
  .body("{\n  \"paymentAmount\": 60,\n  \"paymentMethod\": \"Check\",\n  \"paymentTraceId\": \"chk-999\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"paymentAmount\": 60,\n  \"paymentMethod\": \"Check\",\n  \"paymentTraceId\": \"chk-999\"\n}"

response = http.request(request)
puts response.read_body

Overview

Absolutely sets patient paid on a claim. Cap is ledger paid + remaining PATIENT_AR; anything above that remaining room becomes an unallocated PATIENT_CASH credit. Decreasing paid is a refund (notes required). 404 only if the claim is not found. Path key is your claim control number (FHIR claim-id / PCN), not a Cair lifecycle id. paymentTraceId is required. Retries with the same org + paymentTraceId return 200 with the prior result (idempotentReplay: true) and do not post again. This is an edit path, not an additive post. To add a partial payment or refund, use Patient Payment V2. For Elation billId absolute-set posts, use Patient Payment.

Authentication

JWT Bearer token from /api/token.

Path Parameters

string

required

Your claim control number (system https://fhir.cairhealth.com/fhir/identifier/claim-id).

Request Body

number

required

Absolute paid amount to set (>= 0).

string

ISO 8601 payment date.

string

Payment method.

string

required

Processor transaction id. Required. Same org + trace returns the prior result without applying a second edit.

string

Required when decreasing paid (refund).

Example

curl -X PATCH \
  "https://forecaster.cairhealth.com/api/patient-payments/claims/BILL-12345" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "paymentAmount": 60.00,
    "paymentMethod": "Check",
    "paymentTraceId": "chk-999"
  }'

Response

{
  "success": true,
  "message": "Patient payment updated successfully",
  "data": {
    "claimId": "claim-uuid",
    "claimLifecycleId": "lifecycle-12345",
    "claimControlNumber": "BILL-12345",
    "previousPaid": 50.0,
    "amountSetOnClaim": 60.0,
    "paymentTraceId": "chk-999",
    "ledgerPosted": true
  }
}

Retries include "idempotentReplay": true.

Path Parameters

claimControlNumber

string

required

Claim control number (https://fhir.cairhealth.com/fhir/identifier/claim-id)

Body

application/json

paymentAmount

number

required

Absolute paid amount to set

Required range: x >= 0

paymentTraceId

string

required

Required processor transaction id for idempotent retries

Minimum string length: 1

paymentDate

string<date>

paymentMethod

string

notes

string

Required when decreasing paid (refund)

Response

Payment updated (or idempotent replay)

cURL

curl --request PATCH \
  --url https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber} \
  --header 'Content-Type: application/json' \
  --data '
{
  "paymentAmount": 60,
  "paymentMethod": "Check",
  "paymentTraceId": "chk-999"
}
'

import requests

url = "https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}"

payload = {
    "paymentAmount": 60,
    "paymentMethod": "Check",
    "paymentTraceId": "chk-999"
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({paymentAmount: 60, paymentMethod: 'Check', paymentTraceId: 'chk-999'})
};

fetch('https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'paymentAmount' => 60,
    'paymentMethod' => 'Check',
    'paymentTraceId' => 'chk-999'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}"

	payload := strings.NewReader("{\n  \"paymentAmount\": 60,\n  \"paymentMethod\": \"Check\",\n  \"paymentTraceId\": \"chk-999\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}")
  .header("Content-Type", "application/json")
  .body("{\n  \"paymentAmount\": 60,\n  \"paymentMethod\": \"Check\",\n  \"paymentTraceId\": \"chk-999\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://forecaster.cairhealth.com/api/patient-payments/claims/{claimControlNumber}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"paymentAmount\": 60,\n  \"paymentMethod\": \"Check\",\n  \"paymentTraceId\": \"chk-999\"\n}"

response = http.request(request)
puts response.read_body

Overview

API Authentication

Eligibility

Enrollments/Providers

Claims

Claim AI Actions

Patient Chart Analysis

Patient Payments

Webhooks

AI Phone Calls

Overview

Authentication

Path Parameters

Request Body

Example

Response

Path Parameters

Body

Response

​Overview

​Authentication

​Path Parameters

​Request Body

​Example

​Response

Path Parameters

Body

Response

Overview

Authentication

Path Parameters

Request Body

Example

Response